Mercurial > hg > orthanc-book
changeset 138:f3127d33cf5e
rst syntax
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 24 Apr 2018 20:37:09 +0200 |
parents | 68380637c215 |
children | fded2e8d1d49 |
files | Sphinx/source/users/rest.rst |
diffstat | 1 files changed, 22 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/Sphinx/source/users/rest.rst Tue Apr 24 18:29:49 2018 +0000 +++ b/Sphinx/source/users/rest.rst Tue Apr 24 20:37:09 2018 +0200 @@ -415,7 +415,7 @@ Performing Query/Retrieve and Find with REST ------------------------------------ +-------------------------------------------- *Section contributed by Bryan Dearlove* @@ -427,11 +427,11 @@ Configuration section under Sending resources to remote modalities). -.. highlight:: bash - Performing Queries on Modalities ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. highlight:: bash + To initiate a query you perform a POST command against the Modality with the identifiers you are looking for. The the example below we are performing a study level query against the modality sample for any @@ -446,7 +446,8 @@ .. highlight:: json -You will receive back an ID which can be used to retrieve more information with GET commands or C-Move requests with a POST Command:: +You will receive back an ID which can be used to retrieve more +information with GET commands or C-Move requests with a POST Command:: { "ID": "5af318ac-78fb-47ff-b0b0-0df18b0588e0", @@ -468,11 +469,13 @@ If you wanted to search for a name with the words `Jo` anywhere within it you can do:: - "PatientName":"*Jo*". + "PatientName":"*Jo*". - To perform date searches you can specify within StudyDate a starting date and/or - a before date. For example "StudyDate":"20180323-" would search for all study dates after the specified date to now. - Doing "StudyDate":"20180323-20180325" would search for all study dates between the specified date. +To perform date searches you can specify within StudyDate a starting +date and/or a before date. For example ``"StudyDate":"20180323-"`` +would search for all study dates after the specified date to +now. Doing ``"StudyDate":"20180323-20180325"`` would search for all +study dates between the specified date. Reviewing Level @@ -550,23 +553,28 @@ $ curl --request POST --url http://localhost:8042/queries/5af318ac-78fb-47ff-b0b0-0df18b0588e0/answers/0/retrieve --data Orthanc + Performing Finds within Orthanc ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. highlight:: bash -Performing a find within Orthanc is very similar to using Queries against DICOM modalities and the additional options listed above work with find also. -When performing a find, you will receive the Orthanc ID's of all the matched items within your find. For example if you perform a study level find and 5 Studies -match you will receive 5 study level Orthanc ID's in JSON format as a response:: +Performing a find within Orthanc is very similar to using Queries +against DICOM modalities and the additional options listed above work +with find also. When performing a find, you will receive the Orthanc +ID's of all the matched items within your find. For example if you +perform a study level find and 5 Studies match you will receive 5 +study level Orthanc ID's in JSON format as a response:: -$ curl --request POST --url http://localhost:8042/tools/find --data '{"Level":"Instance","Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}}' + $ curl --request POST --url http://localhost:8042/tools/find --data '{"Level":"Instance","Query":{"Modality":"CR","StudyDate":"20180323-","PatientID":"*"}}' + Additional Options ^^^^^^^^^^^^^^^^^^ -.. highlight:: bash +.. highlight:: json You also have the ability to limit the responses by specifying a limit within the body of the POST message. For example:: -"Limit":4 + "Limit":4 Tracking changes