Networking

Trigger C-MOVE SCU

Start a C-MOVE SCU command as a job, in order to drive the execution of a sequence of C-STORE commands by some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-move

post/modalities/{id}/move

Request

Base URL
https://orthanc.uclouvain.be/demo
Auth
none declared
TypeScript
https://skmtc.dev/uclouvain/apis/orthanc-api/docs/modalities/:id/move/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Identifier of the modality of interest

Request body

Asynchronousboolean

If true, run the job in asynchronous mode, which means that the REST API call will immediately return, reporting the identifier of a job. Prefer this flavor wherever possible.

Levelstring

Level of the query (Patient, Study, Series or Instance)

LocalAetstring

Local AET that is used for this commands, defaults to DicomAet configuration option or LocalAet in the DicomModalities.

Permissiveboolean

If true, ignore errors during the individual steps of the job. Default value is false.

Prioritynumber

In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is 0

Resourcesobject[]

List of queries identifying all the DICOM resources to be sent

Synchronousboolean

If true, run the job in synchronous mode, which means that the HTTP answer will directly contain the result of the job. This is the default, easy behavior, but it is not desirable for long jobs, as it might lead to network timeouts.

TargetAetstring

Target AET that will be used by the remote DICOM modality as a target for its C-STORE SCU commands, defaults to DicomAet configuration option in order to do a simple query/retrieve

Timeoutnumber

DICOM SCU Timeout for this C-MOVE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE sub-operations or responses) are received within this time period.

UserDataobject

User data that will travel along with the job.

Response

IDstring

In asynchronous mode, identifier of the job

Pathstring

In asynchronous mode, path to access the job in the REST API

Changes

No recorded changes to this operation across all 3 revisions of this API.