Sign in

v1

latestOpenAPI 3.0.02026-07-132990743.4 KB
Networking

Trigger C-STORE SCU

Start a C-STORE SCU command as a job, in order to send DICOM resources stored locally to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#rest-store-scu

post/modalities/{id}/store

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.

CalledAetstring

Called AET that is used for this commands, defaults to AET configuration option. Allows you to overwrite the destination AET for a specific operation.

Hoststring

Host that is used for this commands, defaults to Host configuration option. Allows you to overwrite the destination host for a specific operation.

LocalAetstring

Local AET that is used for this commands, defaults to DicomAet configuration option. Ignored if DicomModalities already sets LocalAet for this modality.

MoveOriginatorAetstring

Move originator AET that is used for this commands, in order to fake a C-MOVE SCU

MoveOriginatorIDnumber

Move originator ID that is used for this commands, in order to fake a C-MOVE SCU

Permissiveboolean

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

Portnumber

Port that is used for this command, defaults to Port configuration option. Allows you to overwrite the destination port for a specific operation.

Prioritynumber

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

Resourcesstring[]

List of the Orthanc identifiers of all the DICOM resources to be sent

StorageCommitmentboolean

Whether to chain C-STORE with DICOM storage commitment to validate the success of the transmission: https://orthanc.uclouvain.be/book/users/storage-commitment.html#chaining-c-store-with-storage-commitment

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.

Timeoutnumber

Timeout for the C-STORE command, in seconds. Orthanc will close the DICOM association if no DICOM messages (e.g., C-STORE 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