# \SystemApi
All URIs are relative to *https://orthanc.uclouvain.be/demo*
[**plugins_explorer_js_get**](SystemApi.md#plugins_explorer_js_get) | **GET** /plugins/explorer.js | JavaScript extensions to Orthanc Explorer
[**plugins_get**](SystemApi.md#plugins_get) | **GET** /plugins | List plugins
[**plugins_id_get**](SystemApi.md#plugins_id_get) | **GET** /plugins/{id} | Get plugin
[**statistics_get**](SystemApi.md#statistics_get) | **GET** /statistics | Get database statistics
[**system_get**](SystemApi.md#system_get) | **GET** /system | Get system information
[**tools_accepted_sop_classes_get**](SystemApi.md#tools_accepted_sop_classes_get) | **GET** /tools/accepted-sop-classes | Get accepted SOPClassUID
[**tools_accepted_transfer_syntaxes_get**](SystemApi.md#tools_accepted_transfer_syntaxes_get) | **GET** /tools/accepted-transfer-syntaxes | Get accepted transfer syntaxes
[**tools_accepted_transfer_syntaxes_put**](SystemApi.md#tools_accepted_transfer_syntaxes_put) | **PUT** /tools/accepted-transfer-syntaxes | Set accepted transfer syntaxes
[**tools_bulk_anonymize_post**](SystemApi.md#tools_bulk_anonymize_post) | **POST** /tools/bulk-anonymize | Anonymize a set of resources
[**tools_bulk_content_post**](SystemApi.md#tools_bulk_content_post) | **POST** /tools/bulk-content | Describe a set of resources
[**tools_bulk_delete_post**](SystemApi.md#tools_bulk_delete_post) | **POST** /tools/bulk-delete | Delete a set of resources
[**tools_bulk_modify_post**](SystemApi.md#tools_bulk_modify_post) | **POST** /tools/bulk-modify | Modify a set of resources
[**tools_count_resources_post**](SystemApi.md#tools_count_resources_post) | **POST** /tools/count-resources | Count local resources
[**tools_create_archive_get**](SystemApi.md#tools_create_archive_get) | **GET** /tools/create-archive | Create ZIP archive
[**tools_create_archive_post**](SystemApi.md#tools_create_archive_post) | **POST** /tools/create-archive | Create ZIP archive
[**tools_create_dicom_post**](SystemApi.md#tools_create_dicom_post) | **POST** /tools/create-dicom | Create one DICOM instance
[**tools_create_media_extended_get**](SystemApi.md#tools_create_media_extended_get) | **GET** /tools/create-media-extended | Create DICOMDIR media
[**tools_create_media_extended_post**](SystemApi.md#tools_create_media_extended_post) | **POST** /tools/create-media-extended | Create DICOMDIR media
[**tools_create_media_get**](SystemApi.md#tools_create_media_get) | **GET** /tools/create-media | Create DICOMDIR media
[**tools_create_media_post**](SystemApi.md#tools_create_media_post) | **POST** /tools/create-media | Create DICOMDIR media
[**tools_default_encoding_get**](SystemApi.md#tools_default_encoding_get) | **GET** /tools/default-encoding | Get default encoding
[**tools_default_encoding_put**](SystemApi.md#tools_default_encoding_put) | **PUT** /tools/default-encoding | Set default encoding
[**tools_dicom_conformance_get**](SystemApi.md#tools_dicom_conformance_get) | **GET** /tools/dicom-conformance | Get DICOM conformance
[**tools_dicom_echo_post**](SystemApi.md#tools_dicom_echo_post) | **POST** /tools/dicom-echo | Trigger C-ECHO SCU
[**tools_execute_script_post**](SystemApi.md#tools_execute_script_post) | **POST** /tools/execute-script | Execute Lua script
[**tools_find_post**](SystemApi.md#tools_find_post) | **POST** /tools/find | Look for local resources
[**tools_generate_uid_get**](SystemApi.md#tools_generate_uid_get) | **GET** /tools/generate-uid | Generate an identifier
[**tools_invalidate_tags_post**](SystemApi.md#tools_invalidate_tags_post) | **POST** /tools/invalidate-tags | Invalidate DICOM-as-JSON summaries
[**tools_labels_get**](SystemApi.md#tools_labels_get) | **GET** /tools/labels | Get all the used labels
[**tools_lookup_post**](SystemApi.md#tools_lookup_post) | **POST** /tools/lookup | Look for DICOM identifiers
[**tools_metrics_get**](SystemApi.md#tools_metrics_get) | **GET** /tools/metrics | Are metrics collected?
[**tools_metrics_prometheus_get**](SystemApi.md#tools_metrics_prometheus_get) | **GET** /tools/metrics-prometheus | Get usage metrics
[**tools_metrics_put**](SystemApi.md#tools_metrics_put) | **PUT** /tools/metrics | Enable collection of metrics
[**tools_now_get**](SystemApi.md#tools_now_get) | **GET** /tools/now | Get UTC time
[**tools_now_local_get**](SystemApi.md#tools_now_local_get) | **GET** /tools/now-local | Get local time
[**tools_reconstruct_post**](SystemApi.md#tools_reconstruct_post) | **POST** /tools/reconstruct | Reconstruct all the index
[**tools_reset_post**](SystemApi.md#tools_reset_post) | **POST** /tools/reset | Restart Orthanc
[**tools_shutdown_post**](SystemApi.md#tools_shutdown_post) | **POST** /tools/shutdown | Shutdown Orthanc
[**tools_unknown_sop_class_accepted_get**](SystemApi.md#tools_unknown_sop_class_accepted_get) | **GET** /tools/unknown-sop-class-accepted | Is unknown SOP class accepted?
[**tools_unknown_sop_class_accepted_put**](SystemApi.md#tools_unknown_sop_class_accepted_put) | **PUT** /tools/unknown-sop-class-accepted | Set unknown SOP class accepted
## plugins_explorer_js_get
> serde_json::Value plugins_explorer_js_get()
JavaScript extensions to Orthanc Explorer
Get the JavaScript extensions that are installed by all the plugins using the `OrthancPluginExtendOrthancExplorer()` function of the plugin SDK. This route is for internal use of Orthanc Explorer.
### 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/javascript
[[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)
## plugins_get
> serde_json::Value plugins_get()
List plugins
List all the installed plugins
### 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)
## plugins_id_get
> serde_json::Value plugins_id_get(id)
Get plugin
Get system information about the plugin whose identifier is provided in the URL
### Parameters
**id** | **String** | Identifier of the job 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)
## statistics_get
> models::StatisticsGet200Response statistics_get()
Get database statistics
Get statistics related to the database of Orthanc
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::StatisticsGet200Response**](_statistics_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)
## system_get
> models::SystemGet200Response system_get()
Get system information
Get system information about Orthanc
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::SystemGet200Response**](_system_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)
## tools_accepted_sop_classes_get
> serde_json::Value tools_accepted_sop_classes_get()
Get accepted SOPClassUID
Get the list of SOP Class UIDs that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options `AcceptedSopClasses` and `RejectedSopClasses`.
### 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)
## tools_accepted_transfer_syntaxes_get
> serde_json::Value tools_accepted_transfer_syntaxes_get()
Get accepted transfer syntaxes
Get the list of UIDs of the DICOM transfer syntaxes that are accepted by Orthanc C-STORE SCP. This corresponds to the configuration options `AcceptedTransferSyntaxes` and `XXXTransferSyntaxAccepted`.
### 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)
## tools_accepted_transfer_syntaxes_put
> serde_json::Value tools_accepted_transfer_syntaxes_put(body)
Set accepted transfer syntaxes
Set the DICOM transfer syntaxes that accepted by Orthanc C-STORE SCP
### Parameters
**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, 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)
## tools_bulk_anonymize_post
> models::ToolsBulkAnonymizePost200Response tools_bulk_anonymize_post(tools_bulk_anonymize_post_request)
Anonymize a set of resources
Start a job that will anonymize all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
### Parameters
**tools_bulk_anonymize_post_request** | Option<[**ToolsBulkAnonymizePostRequest**](ToolsBulkAnonymizePostRequest.md)> | | |
### Return type
[**models::ToolsBulkAnonymizePost200Response**](_tools_bulk_anonymize_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)
## tools_bulk_content_post
> tools_bulk_content_post(tools_bulk_content_post_request)
Describe a set of resources
Get the content all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field, in one single call.
### Parameters
**tools_bulk_content_post_request** | Option<[**ToolsBulkContentPostRequest**](ToolsBulkContentPostRequest.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)
## tools_bulk_delete_post
> tools_bulk_delete_post(tools_bulk_delete_post_request)
Delete a set of resources
Delete all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
### Parameters
**tools_bulk_delete_post_request** | Option<[**ToolsBulkDeletePostRequest**](ToolsBulkDeletePostRequest.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)
## tools_bulk_modify_post
> models::ToolsBulkModifyPost200Response tools_bulk_modify_post(tools_bulk_modify_post_request)
Modify a set of resources
Start a job that will modify all the DICOM patients, studies, series or instances whose identifiers are provided in the `Resources` field.
### Parameters
**tools_bulk_modify_post_request** | Option<[**ToolsBulkModifyPostRequest**](ToolsBulkModifyPostRequest.md)> | | |
### Return type
[**models::ToolsBulkModifyPost200Response**](_tools_bulk_modify_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)
## tools_count_resources_post
> serde_json::Value tools_count_resources_post(tools_count_resources_post_request)
Count local resources
This URI can be used to count the resources that are matching criteria on the content of the local Orthanc server, in a way that is similar to tools/find
### Parameters
**tools_count_resources_post_request** | Option<[**ToolsCountResourcesPostRequest**](ToolsCountResourcesPostRequest.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)
## tools_create_archive_get
> tools_create_archive_get(resources, filename, lossy_quality, transcode)
Create ZIP archive
Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
### Parameters
**resources** | **String** | A comma separated list of Orthanc resource identifiers to include in the ZIP archive. | [required] |
**filename** | Option<**String**> | Filename to set in the \"Content-Disposition\" HTTP header (including file extension) | |
**lossy_quality** | Option<**f64**> | If transcoding to a lossy transfer syntax, this entry defines the quality as an integer between 1 and 100. If not provided, the value is defined by the \"DicomLossyTranscodingQuality\" configuration. (new in v1.12.7) | |
**transcode** | Option<**String**> | If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html | |
### 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)
## tools_create_archive_post
> models::PatientsIdArchivePost200Response tools_create_archive_post(tools_create_archive_post_request)
Create ZIP archive
Create a ZIP archive containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
### Parameters
**tools_create_archive_post_request** | Option<[**ToolsCreateArchivePostRequest**](ToolsCreateArchivePostRequest.md)> | | |
### Return type
[**models::PatientsIdArchivePost200Response**](_patients__id__archive_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/zip
[[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)
## tools_create_dicom_post
> models::ToolsCreateDicomPost200Response tools_create_dicom_post(tools_create_dicom_post_request)
Create one DICOM instance
Create one DICOM instance, and store it into Orthanc
### Parameters
**tools_create_dicom_post_request** | Option<[**ToolsCreateDicomPostRequest**](ToolsCreateDicomPostRequest.md)> | | |
### Return type
[**models::ToolsCreateDicomPost200Response**](_tools_create_dicom_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)
## tools_create_media_extended_get
> tools_create_media_extended_get(resources, filename, lossy_quality, transcode)
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
### Parameters
**resources** | **String** | A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media. | [required] |
**filename** | Option<**String**> | Filename to set in the \"Content-Disposition\" HTTP header (including file extension) | |
**lossy_quality** | Option<**f64**> | If transcoding to a lossy transfer syntax, this entry defines the quality as an integer between 1 and 100. If not provided, the value is defined by the \"DicomLossyTranscodingQuality\" configuration. (new in v1.12.7) | |
**transcode** | Option<**String**> | If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html | |
### 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)
## tools_create_media_extended_post
> models::PatientsIdArchivePost200Response tools_create_media_extended_post(tools_create_media_extended_post_request)
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
### Parameters
**tools_create_media_extended_post_request** | Option<[**ToolsCreateMediaExtendedPostRequest**](ToolsCreateMediaExtendedPostRequest.md)> | | |
### Return type
[**models::PatientsIdArchivePost200Response**](_patients__id__archive_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/zip
[[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)
## tools_create_media_get
> tools_create_media_get(resources, filename, lossy_quality, transcode)
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the 'resources' argument
### Parameters
**resources** | **String** | A comma separated list of Orthanc resource identifiers to include in the DICOMDIR media. | [required] |
**filename** | Option<**String**> | Filename to set in the \"Content-Disposition\" HTTP header (including file extension) | |
**lossy_quality** | Option<**f64**> | If transcoding to a lossy transfer syntax, this entry defines the quality as an integer between 1 and 100. If not provided, the value is defined by the \"DicomLossyTranscodingQuality\" configuration. (new in v1.12.7) | |
**transcode** | Option<**String**> | If present, the DICOM files will be transcoded to the provided transfer syntax: https://orthanc.uclouvain.be/book/faq/transcoding.html | |
### 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)
## tools_create_media_post
> models::PatientsIdArchivePost200Response tools_create_media_post(tools_create_media_post_request)
Create DICOMDIR media
Create a DICOMDIR media containing the DICOM resources (patients, studies, series, or instances) whose Orthanc identifiers are provided in the body
### Parameters
**tools_create_media_post_request** | Option<[**ToolsCreateMediaPostRequest**](ToolsCreateMediaPostRequest.md)> | | |
### Return type
[**models::PatientsIdArchivePost200Response**](_patients__id__archive_post_200_response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/zip
[[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)
## tools_default_encoding_get
> serde_json::Value tools_default_encoding_get()
Get default encoding
Get the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
### 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**: 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)
## tools_default_encoding_put
> tools_default_encoding_put(body)
Set default encoding
Change the default encoding that is used by Orthanc if parsing a DICOM instance without the `SpecificCharacterEncoding` tag, or during C-FIND. This corresponds to the configuration option `DefaultEncoding`.
### Parameters
**body** | Option<**serde_json::Value**> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: text/plain
- **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)
## tools_dicom_conformance_get
> serde_json::Value tools_dicom_conformance_get()
Get DICOM conformance
Get the DICOM conformance statement of Orthanc
### 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**: 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)
## tools_dicom_echo_post
> tools_dicom_echo_post(tools_dicom_echo_post_request)
Trigger C-ECHO SCU
Trigger C-ECHO SCU command against a DICOM modality described in the POST body, without having to register the modality in some `/modalities/{id}` (new in Orthanc 1.8.1)
### Parameters
**tools_dicom_echo_post_request** | Option<[**ToolsDicomEchoPostRequest**](ToolsDicomEchoPostRequest.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)
## tools_execute_script_post
> serde_json::Value tools_execute_script_post(body)
Execute Lua script
Execute the provided Lua script by the Orthanc server. This is very insecure for Orthanc servers that are remotely accessible. Since Orthanc 1.5.8, this route is disabled by default and can be enabled thanks to the `ExecuteLuaEnabled` configuration.
### Parameters
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: text/plain
- **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)
## tools_find_post
> serde_json::Value tools_find_post(tools_find_post_request)
Look for local resources
This URI can be used to perform a search on the content of the local Orthanc server, in a way that is similar to querying remote DICOM modalities using C-FIND SCU: https://orthanc.uclouvain.be/book/users/rest.html#performing-finds-within-orthanc
### Parameters
**tools_find_post_request** | Option<[**ToolsFindPostRequest**](ToolsFindPostRequest.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)
## tools_generate_uid_get
> serde_json::Value tools_generate_uid_get(level)
Generate an identifier
Generate a random DICOM identifier
### Parameters
**level** | **String** | Type of DICOM resource among: `patient`, `study`, `series` or `instance` | [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)
## tools_invalidate_tags_post
> tools_invalidate_tags_post()
Invalidate DICOM-as-JSON summaries
Remove all the attachments of the type \"DICOM-as-JSON\" that are associated will all the DICOM instances stored in Orthanc. These summaries will be automatically re-created on the next access. This is notably useful after changes to the `Dictionary` configuration option. https://orthanc.uclouvain.be/book/faq/orthanc-storage.html#storage-area
### Parameters
This endpoint does not need any parameter.
### 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)
## tools_labels_get
> serde_json::Value tools_labels_get()
Get all the used labels
List all the labels that are associated with any resource of the Orthanc database
### 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)
## tools_lookup_post
> serde_json::Value tools_lookup_post(body)
Look for DICOM identifiers
This URI can be used to convert one DICOM identifier to a list of matching Orthanc resources
### Parameters
**body** | Option<**serde_json::Value**> | | |
### Return type
[**serde_json::Value**](serde_json::Value.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: 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)
## tools_metrics_get
> serde_json::Value tools_metrics_get()
Are metrics collected?
Returns a Boolean specifying whether Prometheus metrics are collected and exposed at `/tools/metrics-prometheus`
### 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**: 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)
## tools_metrics_prometheus_get
> tools_metrics_prometheus_get()
Get usage metrics
Get usage metrics of Orthanc in the Prometheus file format (OpenMetrics): https://orthanc.uclouvain.be/book/users/advanced-rest.html#instrumentation-with-prometheus
### Parameters
This endpoint does not need any parameter.
### Return type
(empty response body)
### 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)
## tools_metrics_put
> tools_metrics_put(body)
Enable collection of metrics
Enable or disable the collection and publication of metrics at `/tools/metrics-prometheus`
### Parameters
**body** | Option<**serde_json::Value**> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: text/plain
- **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)
## tools_now_get
> serde_json::Value tools_now_get()
Get UTC time
Get UTC time
### 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**: 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)
## tools_now_local_get
> serde_json::Value tools_now_local_get()
Get local time
Get local time
### 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**: 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)
## tools_reconstruct_post
> tools_reconstruct_post(tools_reconstruct_post_request)
Reconstruct all the index
Reconstruct the index of all the tags of all the DICOM instances that are stored in Orthanc. This is notably useful after the deletion of resources whose children resources have inconsistent values with their sibling resources. Beware that this is a highly time-consuming operation, as all the DICOM instances will be parsed again, and as all the Orthanc index will be regenerated. If you have a large database to process, it is advised to use the Housekeeper plugin to perform this action resource by resource
### Parameters
**tools_reconstruct_post_request** | Option<[**ToolsReconstructPostRequest**](ToolsReconstructPostRequest.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)
## tools_reset_post
> tools_reset_post()
Restart Orthanc
Restart Orthanc
### Parameters
This endpoint does not need any parameter.
### 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)
## tools_shutdown_post
> tools_shutdown_post()
Shutdown Orthanc
Shutdown Orthanc
### Parameters
This endpoint does not need any parameter.
### 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)
## tools_unknown_sop_class_accepted_get
> serde_json::Value tools_unknown_sop_class_accepted_get()
Is unknown SOP class accepted?
Shall Orthanc C-STORE SCP accept DICOM instances with an unknown SOP class UID?
### 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**: 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)
## tools_unknown_sop_class_accepted_put
> tools_unknown_sop_class_accepted_put(body)
Set unknown SOP class accepted
Set whether Orthanc C-STORE SCP should accept DICOM instances with an unknown SOP class UID
### Parameters
**body** | Option<**serde_json::Value**> | | |
### Return type
(empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: text/plain
- **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)