---
title: "Trigger C-GET SCU"
method: POST
path: "/modalities/{id}/get"
tags: ["Networking"]
---

# Trigger C-GET SCU

`POST /modalities/{id}/get`

Start a C-GET SCU command as a job, in order to retrieve DICOM resources from a remote DICOM modality whose identifier is provided in the URL:

## Path parameters

- `id` string, required

## Request body

- object
  - `Asynchronous` boolean — 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.
  - `Level` string — Level of the query (`Patient`, `Study`, `Series` or `Instance`)
  - `LocalAet` string — Local AET that is used for this commands, defaults to `DicomAet` configuration option or `LocalAet` in the `DicomModalities`.
  - `Permissive` boolean — If `true`, ignore errors during the individual steps of the job. Default value is `false`.
  - `Priority` number — In asynchronous mode, the priority of the job. The higher the value, the higher the priority. Default value is `0`
  - `Resources` object[] — List of queries identifying all the DICOM resources to be sent. Usage of wildcards is prohibited and the query shall only contain DICOM ID tags. Additionally, you may provide SOPClassesInStudy to limit the scope of the DICOM negotiation to certain SOPClassUID or to present uncommon SOPClassUID during the DICOM negotiation. By default, Orhanc will propose the most 120 common SOPClassUIDs.
  - `Synchronous` boolean — 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.
  - `Timeout` number — DICOM SCU Timeout for this C-GET command, in seconds. Orthanc will close the DICOM association if no DICOM messages are received within this time period.
  - `UserData` object — User data that will travel along with the job.

## Response `200`

- object
  - `ID` string — In asynchronous mode, identifier of the job
  - `Path` string — In asynchronous mode, path to access the job in the REST API

---

[API](https://skmtc.net/uclouvain/apis/orthanc-api.md) · [All operations](https://skmtc.net/uclouvain/apis/orthanc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uclouvain/orthanc-api/revisions/dbfb49bf0bc7/schema)
