v1

latestOpenAPI 3.0.02026-07-132990743.4 KB

Networking

Send to Orthanc peer

Send DICOM resources stored locally to some remote Orthanc peer whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#sending-one-resource

post/peers/{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.

Compressboolean

Whether to compress the DICOM instances using gzip before the actual sending

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

Resourcesstring[]

List of the Orthanc identifiers of 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.

Transcodestring

Transcode to the provided DICOM transfer syntax before the actual sending

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