# \NetworkingApi
All URIs are relative to *https://orthanc.uclouvain.be/demo*
[**modalities_get**](NetworkingApi.md#modalities_get) | **GET** /modalities | List DICOM modalities
[**modalities_id_configuration_get**](NetworkingApi.md#modalities_id_configuration_get) | **GET** /modalities/{id}/configuration | Get modality configuration
[**modalities_id_delete**](NetworkingApi.md#modalities_id_delete) | **DELETE** /modalities/{id} | Delete DICOM modality
[**modalities_id_echo_post**](NetworkingApi.md#modalities_id_echo_post) | **POST** /modalities/{id}/echo | Trigger C-ECHO SCU
[**modalities_id_find_instance_post**](NetworkingApi.md#modalities_id_find_instance_post) | **POST** /modalities/{id}/find-instance | C-FIND SCU for instances
[**modalities_id_find_patient_post**](NetworkingApi.md#modalities_id_find_patient_post) | **POST** /modalities/{id}/find-patient | C-FIND SCU for patients
[**modalities_id_find_post**](NetworkingApi.md#modalities_id_find_post) | **POST** /modalities/{id}/find | Hierarchical C-FIND SCU
[**modalities_id_find_series_post**](NetworkingApi.md#modalities_id_find_series_post) | **POST** /modalities/{id}/find-series | C-FIND SCU for series
[**modalities_id_find_study_post**](NetworkingApi.md#modalities_id_find_study_post) | **POST** /modalities/{id}/find-study | C-FIND SCU for studies
[**modalities_id_find_worklist_post**](NetworkingApi.md#modalities_id_find_worklist_post) | **POST** /modalities/{id}/find-worklist | C-FIND SCU for worklist
[**modalities_id_get**](NetworkingApi.md#modalities_id_get) | **GET** /modalities/{id} | List operations on modality
[**modalities_id_get_post**](NetworkingApi.md#modalities_id_get_post) | **POST** /modalities/{id}/get | Trigger C-GET SCU
[**modalities_id_move_post**](NetworkingApi.md#modalities_id_move_post) | **POST** /modalities/{id}/move | Trigger C-MOVE SCU
[**modalities_id_put**](NetworkingApi.md#modalities_id_put) | **PUT** /modalities/{id} | Update DICOM modality
[**modalities_id_query_post**](NetworkingApi.md#modalities_id_query_post) | **POST** /modalities/{id}/query | Trigger C-FIND SCU
[**modalities_id_storage_commitment_post**](NetworkingApi.md#modalities_id_storage_commitment_post) | **POST** /modalities/{id}/storage-commitment | Trigger storage commitment request
[**modalities_id_store_post**](NetworkingApi.md#modalities_id_store_post) | **POST** /modalities/{id}/store | Trigger C-STORE SCU
[**modalities_id_store_straight_post**](NetworkingApi.md#modalities_id_store_straight_post) | **POST** /modalities/{id}/store-straight | Straight C-STORE SCU
[**peers_get**](NetworkingApi.md#peers_get) | **GET** /peers | List Orthanc peers
[**peers_id_configuration_get**](NetworkingApi.md#peers_id_configuration_get) | **GET** /peers/{id}/configuration | Get peer configuration
[**peers_id_delete**](NetworkingApi.md#peers_id_delete) | **DELETE** /peers/{id} | Delete Orthanc peer
[**peers_id_get**](NetworkingApi.md#peers_id_get) | **GET** /peers/{id} | List operations on peer
[**peers_id_put**](NetworkingApi.md#peers_id_put) | **PUT** /peers/{id} | Update Orthanc peer
[**peers_id_store_post**](NetworkingApi.md#peers_id_store_post) | **POST** /peers/{id}/store | Send to Orthanc peer
[**peers_id_store_straight_post**](NetworkingApi.md#peers_id_store_straight_post) | **POST** /peers/{id}/store-straight | Straight store to peer
[**peers_id_system_get**](NetworkingApi.md#peers_id_system_get) | **GET** /peers/{id}/system | Get peer system information
[**queries_get**](NetworkingApi.md#queries_get) | **GET** /queries | List query/retrieve operations
[**queries_id_answers_get**](NetworkingApi.md#queries_id_answers_get) | **GET** /queries/{id}/answers | List answers to a query
[**queries_id_answers_index_content_get**](NetworkingApi.md#queries_id_answers_index_content_get) | **GET** /queries/{id}/answers/{index}/content | Get one answer
[**queries_id_answers_index_get**](NetworkingApi.md#queries_id_answers_index_get) | **GET** /queries/{id}/answers/{index} | List operations on an answer
[**queries_id_answers_index_query_instances_post**](NetworkingApi.md#queries_id_answers_index_query_instances_post) | **POST** /queries/{id}/answers/{index}/query-instances | Query the child instances of an answer
[**queries_id_answers_index_query_series_post**](NetworkingApi.md#queries_id_answers_index_query_series_post) | **POST** /queries/{id}/answers/{index}/query-series | Query the child series of an answer
[**queries_id_answers_index_query_studies_post**](NetworkingApi.md#queries_id_answers_index_query_studies_post) | **POST** /queries/{id}/answers/{index}/query-studies | Query the child studies of an answer
[**queries_id_answers_index_retrieve_post**](NetworkingApi.md#queries_id_answers_index_retrieve_post) | **POST** /queries/{id}/answers/{index}/retrieve | Retrieve one answer with a C-MOVE or a C-GET SCU
[**queries_id_delete**](NetworkingApi.md#queries_id_delete) | **DELETE** /queries/{id} | Delete a query
[**queries_id_get**](NetworkingApi.md#queries_id_get) | **GET** /queries/{id} | List operations on a query
[**queries_id_level_get**](NetworkingApi.md#queries_id_level_get) | **GET** /queries/{id}/level | Get level of original query
[**queries_id_modality_get**](NetworkingApi.md#queries_id_modality_get) | **GET** /queries/{id}/modality | Get modality of original query
[**queries_id_query_get**](NetworkingApi.md#queries_id_query_get) | **GET** /queries/{id}/query | Get original query arguments
[**queries_id_retrieve_post**](NetworkingApi.md#queries_id_retrieve_post) | **POST** /queries/{id}/retrieve | Retrieve all answers with C-MOVE SCU
[**storage_commitment_id_get**](NetworkingApi.md#storage_commitment_id_get) | **GET** /storage-commitment/{id} | Get storage commitment report
[**storage_commitment_id_remove_post**](NetworkingApi.md#storage_commitment_id_remove_post) | **POST** /storage-commitment/{id}/remove | Remove after storage commitment
## modalities_get
> serde_json::Value modalities_get(expand)
List DICOM modalities
List all the DICOM modalities that are known to Orthanc. This corresponds either to the content of the `DicomModalities` configuration option, or to the information stored in the database if `DicomModalitiesInDatabase` is `true`.
### Parameters
**expand** | Option<**String**> | If present, retrieve detailed information about the individual DICOM modalities | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_configuration_get
> serde_json::Value modalities_id_configuration_get(id)
Get modality configuration
Get detailed information about the configuration of some DICOM modality
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_delete
> modalities_id_delete(id)
Delete DICOM modality
Delete one DICOM modality. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
### Parameters
**id** | **String** | Identifier of the DICOM modality of interest | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_echo_post
> modalities_id_echo_post(id, modalities_id_echo_post_request)
Trigger C-ECHO SCU
Trigger C-ECHO SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-c-echo
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_echo_post_request** | Option<[**ModalitiesIdEchoPostRequest**](ModalitiesIdEchoPostRequest.md)> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_instance_post
> serde_json::Value modalities_id_find_instance_post(id, body)
C-FIND SCU for instances
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find an instance. Deprecated in favor of `/modalities/{id}/query`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_patient_post
> serde_json::Value modalities_id_find_patient_post(id, body)
C-FIND SCU for patients
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a patient. Deprecated in favor of `/modalities/{id}/query`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_post
> serde_json::Value modalities_id_find_post(id, body)
Hierarchical C-FIND SCU
Trigger a sequence of C-FIND SCU commands against the DICOM modality whose identifier is provided in URL, in order to discover a hierarchy of matching patients/studies/series. Deprecated in favor of `/modalities/{id}/query`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_series_post
> serde_json::Value modalities_id_find_series_post(id, body)
C-FIND SCU for series
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a series. Deprecated in favor of `/modalities/{id}/query`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_study_post
> serde_json::Value modalities_id_find_study_post(id, body)
C-FIND SCU for studies
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL, in order to find a study. Deprecated in favor of `/modalities/{id}/query`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_find_worklist_post
> serde_json::Value modalities_id_find_worklist_post(id, modalities_id_find_worklist_post_request)
C-FIND SCU for worklist
Trigger C-FIND SCU command against the remote worklists of the DICOM modality whose identifier is provided in URL
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_find_worklist_post_request** | Option<[**ModalitiesIdFindWorklistPostRequest**](ModalitiesIdFindWorklistPostRequest.md)> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_get
> serde_json::Value modalities_id_get(id)
List operations on modality
List the operations that are available for a DICOM modality.
### Parameters
**id** | **String** | Identifier of the DICOM modality of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_get_post
> models::ModalitiesIdGetPost200Response modalities_id_get_post(id, modalities_id_get_post_request)
Trigger C-GET SCU
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:
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_get_post_request** | Option<[**ModalitiesIdGetPostRequest**](ModalitiesIdGetPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_move_post
> models::ModalitiesIdGetPost200Response modalities_id_move_post(id, modalities_id_move_post_request)
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
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_move_post_request** | Option<[**ModalitiesIdMovePostRequest**](ModalitiesIdMovePostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_put
> modalities_id_put(id, modalities_id_put_request)
Update DICOM modality
Define a new DICOM modality, or update an existing one. This change is permanent iff. `DicomModalitiesInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
### Parameters
**id** | **String** | Identifier of the new/updated DICOM modality | [required] |
**modalities_id_put_request** | Option<[**ModalitiesIdPutRequest**](ModalitiesIdPutRequest.md)> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_query_post
> models::ModalitiesIdQueryPost200Response modalities_id_query_post(id, modalities_id_query_post_request)
Trigger C-FIND SCU
Trigger C-FIND SCU command against the DICOM modality whose identifier is provided in URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_query_post_request** | Option<[**ModalitiesIdQueryPostRequest**](ModalitiesIdQueryPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdQueryPost200Response**](_modalities__id__query_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_storage_commitment_post
> models::ModalitiesIdStorageCommitmentPost200Response modalities_id_storage_commitment_post(id, modalities_id_storage_commitment_post_request)
Trigger storage commitment request
Trigger a storage commitment request to some remote DICOM modality whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_storage_commitment_post_request** | Option<[**ModalitiesIdStorageCommitmentPostRequest**](ModalitiesIdStorageCommitmentPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdStorageCommitmentPost200Response**](_modalities__id__storage_commitment_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_store_post
> models::ModalitiesIdGetPost200Response modalities_id_store_post(id, modalities_id_store_post_request)
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
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**modalities_id_store_post_request** | Option<[**ModalitiesIdStorePostRequest**](ModalitiesIdStorePostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## modalities_id_store_straight_post
> models::ModalitiesIdStoreStraightPost200Response modalities_id_store_straight_post(id, body)
Straight C-STORE SCU
Synchronously send the DICOM instance in the POST body to the remote DICOM modality whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `storescu` from DCMTK or dcm4che.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**models::ModalitiesIdStoreStraightPost200Response**](_modalities__id__store_straight_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/dicom
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_get
> serde_json::Value peers_get(expand)
List Orthanc peers
List all the Orthanc peers that are known to Orthanc. This corresponds either to the content of the `OrthancPeers` configuration option, or to the information stored in the database if `OrthancPeersInDatabase` is `true`.
### Parameters
**expand** | Option<**String**> | If present, retrieve detailed information about the individual Orthanc peers | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_configuration_get
> serde_json::Value peers_id_configuration_get(id)
Get peer configuration
Get detailed information about the configuration of some Orthanc peer
### Parameters
**id** | **String** | Identifier of the peer of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_delete
> peers_id_delete(id)
Delete Orthanc peer
Delete one Orthanc peer. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
### Parameters
**id** | **String** | Identifier of the Orthanc peer of interest | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_get
> serde_json::Value peers_id_get(id)
List operations on peer
List the operations that are available for an Orthanc peer.
### Parameters
**id** | **String** | Identifier of the peer of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_put
> peers_id_put(id, peers_id_put_request)
Update Orthanc peer
Define a new Orthanc peer, or update an existing one. This change is permanent iff. `OrthancPeersInDatabase` is `true`, otherwise it is lost at the next restart of Orthanc.
### Parameters
**id** | **String** | Identifier of the new/updated Orthanc peer | [required] |
**peers_id_put_request** | Option<[**PeersIdPutRequest**](PeersIdPutRequest.md)> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_store_post
> models::ModalitiesIdGetPost200Response peers_id_store_post(id, peers_id_store_post_request)
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
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**peers_id_store_post_request** | Option<[**PeersIdStorePostRequest**](PeersIdStorePostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_store_straight_post
> models::PeersIdStoreStraightPost200Response peers_id_store_straight_post(id, body)
Straight store to peer
Synchronously send the DICOM instance in the POST body to the Orthanc peer whose identifier is provided in URL, without having to first store it locally within Orthanc. This is an alternative to command-line tools such as `curl`.
### Parameters
**id** | **String** | Identifier of the modality of interest | [required] |
**body** | Option<**serde_json::Value**> | | |
### Return type
[**models::PeersIdStoreStraightPost200Response**](_peers__id__store_straight_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/dicom
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## peers_id_system_get
> serde_json::Value peers_id_system_get(id)
Get peer system information
Get system information about some Orthanc peer. This corresponds to doing a `GET` request against the `/system` URI of the remote peer. This route can be used to test connectivity.
### Parameters
**id** | **String** | Identifier of the peer of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_get
> serde_json::Value queries_get()
List query/retrieve operations
List the identifiers of all the query/retrieve operations on DICOM modalities, as initiated by calls to `/modalities/{id}/query`. The length of this list is bounded by the `QueryRetrieveSize` configuration option of Orthanc. https://orthanc.uclouvain.be/book/users/rest.html#performing-query-retrieve-c-find-and-find-with-rest
### Parameters
This endpoint does not need any parameter.
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_get
> serde_json::Value queries_id_answers_get(id, expand, short, simplify)
List answers to a query
List the indices of all the available answers resulting from a query/retrieve operation on some DICOM modality, whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**expand** | Option<**String**> | If present, retrieve detailed information about the individual answers | |
**short** | Option<**bool**> | If present, report the DICOM tags in hexadecimal format | |
**simplify** | Option<**bool**> | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_content_get
> serde_json::Value queries_id_answers_index_content_get(id, index, short, simplify)
Get one answer
Get the content (DICOM tags) of one answer associated with the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
**short** | Option<**bool**> | If present, report the DICOM tags in hexadecimal format | |
**simplify** | Option<**bool**> | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_get
> serde_json::Value queries_id_answers_index_get(id, index)
List operations on an answer
List the available operations on an answer associated with the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_query_instances_post
> models::ModalitiesIdQueryPost200Response queries_id_answers_index_query_instances_post(id, index, queries_id_answers_index_query_instances_post_request)
Query the child instances of an answer
Issue a second DICOM C-FIND operation, in order to query the child instances associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
**queries_id_answers_index_query_instances_post_request** | Option<[**QueriesIdAnswersIndexQueryInstancesPostRequest**](QueriesIdAnswersIndexQueryInstancesPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdQueryPost200Response**](_modalities__id__query_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_query_series_post
> models::ModalitiesIdQueryPost200Response queries_id_answers_index_query_series_post(id, index, queries_id_answers_index_query_instances_post_request)
Query the child series of an answer
Issue a second DICOM C-FIND operation, in order to query the child series associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
**queries_id_answers_index_query_instances_post_request** | Option<[**QueriesIdAnswersIndexQueryInstancesPostRequest**](QueriesIdAnswersIndexQueryInstancesPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdQueryPost200Response**](_modalities__id__query_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_query_studies_post
> models::ModalitiesIdQueryPost200Response queries_id_answers_index_query_studies_post(id, index, queries_id_answers_index_query_instances_post_request)
Query the child studies of an answer
Issue a second DICOM C-FIND operation, in order to query the child studies associated with one answer to some query/retrieve operation whose identifiers are provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
**queries_id_answers_index_query_instances_post_request** | Option<[**QueriesIdAnswersIndexQueryInstancesPostRequest**](QueriesIdAnswersIndexQueryInstancesPostRequest.md)> | | |
### Return type
[**models::ModalitiesIdQueryPost200Response**](_modalities__id__query_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_answers_index_retrieve_post
> models::ModalitiesIdGetPost200Response queries_id_answers_index_retrieve_post(id, index, queries_id_answers_index_retrieve_post_request)
Retrieve one answer with a C-MOVE or a C-GET SCU
Start a C-MOVE or a C-GET SCU command as a job, in order to retrieve one answer associated with the query/retrieve operation whose identifiers are provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**index** | **String** | Index of the answer | [required] |
**queries_id_answers_index_retrieve_post_request** | Option<[**QueriesIdAnswersIndexRetrievePostRequest**](QueriesIdAnswersIndexRetrievePostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_delete
> queries_id_delete(id)
Delete a query
Delete the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_get
> serde_json::Value queries_id_get(id)
List operations on a query
List the available operations for the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_level_get
> serde_json::Value queries_id_level_get(id)
Get level of original query
Get the query level (value of the `QueryRetrieveLevel` tag) of the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_modality_get
> serde_json::Value queries_id_modality_get(id)
Get modality of original query
Get the identifier of the DICOM modality that was targeted by the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/plain
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_query_get
> serde_json::Value queries_id_query_get(id, short, simplify)
Get original query arguments
Get the original DICOM filter associated with the query/retrieve operation whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**short** | Option<**bool**> | If present, report the DICOM tags in hexadecimal format | |
**simplify** | Option<**bool**> | If present, report the DICOM tags in human-readable format (using the symbolic name of the tags) | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## queries_id_retrieve_post
> models::ModalitiesIdGetPost200Response queries_id_retrieve_post(id, queries_id_answers_index_retrieve_post_request)
Retrieve all answers with C-MOVE SCU
Start a C-MOVE SCU command as a job, in order to retrieve all the answers associated with the query/retrieve operation whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/rest.html#performing-retrieve-c-move
### Parameters
**id** | **String** | Identifier of the query of interest | [required] |
**queries_id_answers_index_retrieve_post_request** | Option<[**QueriesIdAnswersIndexRetrievePostRequest**](QueriesIdAnswersIndexRetrievePostRequest.md)> | | |
### Return type
[**models::ModalitiesIdGetPost200Response**](_modalities__id__get_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json, text/plain
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## storage_commitment_id_get
> models::StorageCommitmentIdGet200Response storage_commitment_id_get(id)
Get storage commitment report
Get the storage commitment report whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/storage-commitment.html#storage-commitment-scu
### Parameters
**id** | **String** | Identifier of the storage commitment report | [required] |
### Return type
[**models::StorageCommitmentIdGet200Response**](_storage_commitment__id__get_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## storage_commitment_id_remove_post
> storage_commitment_id_remove_post(id)
Remove after storage commitment
Remove out of Orthanc, the DICOM instances that have been reported to have been properly received the storage commitment report whose identifier is provided in the URL. This is only possible if the `Status` of the storage commitment report is `Success`. https://orthanc.uclouvain.be/book/users/storage-commitment.html#removing-the-instances
### Parameters
**id** | **String** | Identifier of the storage commitment report | [required] |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)