OpenAPIClient-php

This is the full documentation of the REST API of Orthanc.

This reference is automatically generated from the source code of Orthanc. A shorter cheat sheet is part of the Orthanc Book.

An earlier, manually crafted version from August 2019, is still available, but is not up-to-date anymore (source).

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?phprequire_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?phprequire_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = newOpenAPI\Client\Api\InstancesApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.// This is optional, `GuzzleHttp\Client` will be used as default.newGuzzleHttp\Client()
);
$expand = 'expand_example'; // string | If present, retrieve detailed information about the individual instances$full = True; // bool | If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)$limit = 3.4; // float | Limit the number of results$requested_tags = 'requested_tags_example'; // string | If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return$short = True; // bool | If present, report the DICOM tags in hexadecimal format$since = 3.4; // float | Show only the resources since the provided indextry {
$result = $apiInstance->instancesGet($expand, $full, $limit, $requested_tags, $short, $since);
print_r($result);
} catch (Exception$e) {
echo'Exception when calling InstancesApi->instancesGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://demo.orthanc-server.com

Class	Method	HTTP request	Description
InstancesApi	instancesGet	GET /instances	List the available instances
InstancesApi	instancesIdAnonymizePost	POST /instances/{id}/anonymize	Anonymize instance
InstancesApi	instancesIdAttachmentsGet	GET /instances/{id}/attachments	List attachments
InstancesApi	instancesIdAttachmentsNameCompressPost	POST /instances/{id}/attachments/{name}/compress	Compress attachment
InstancesApi	instancesIdAttachmentsNameCompressedDataGet	GET /instances/{id}/attachments/{name}/compressed-data	Get attachment (no decompression)
InstancesApi	instancesIdAttachmentsNameCompressedMd5Get	GET /instances/{id}/attachments/{name}/compressed-md5	Get MD5 of attachment on disk
InstancesApi	instancesIdAttachmentsNameCompressedSizeGet	GET /instances/{id}/attachments/{name}/compressed-size	Get size of attachment on disk
InstancesApi	instancesIdAttachmentsNameDataGet	GET /instances/{id}/attachments/{name}/data	Get attachment
InstancesApi	instancesIdAttachmentsNameDelete	DELETE /instances/{id}/attachments/{name}	Delete attachment
InstancesApi	instancesIdAttachmentsNameInfoGet	GET /instances/{id}/attachments/{name}/info	Get info about the attachment
InstancesApi	instancesIdAttachmentsNameIsCompressedGet	GET /instances/{id}/attachments/{name}/is-compressed	Is attachment compressed?
InstancesApi	instancesIdAttachmentsNameMd5Get	GET /instances/{id}/attachments/{name}/md5	Get MD5 of attachment
InstancesApi	instancesIdAttachmentsNamePut	PUT /instances/{id}/attachments/{name}	Set attachment
InstancesApi	instancesIdAttachmentsNameSizeGet	GET /instances/{id}/attachments/{name}/size	Get size of attachment
InstancesApi	instancesIdAttachmentsNameUncompressPost	POST /instances/{id}/attachments/{name}/uncompress	Uncompress attachment
InstancesApi	instancesIdAttachmentsNameVerifyMd5Post	POST /instances/{id}/attachments/{name}/verify-md5	Verify attachment
InstancesApi	instancesIdContentGet	GET /instances/{id}/content	Get raw tag
InstancesApi	instancesIdDelete	DELETE /instances/{id}	Delete some instance
InstancesApi	instancesIdExportPost	POST /instances/{id}/export	Write DICOM onto filesystem
InstancesApi	instancesIdFileGet	GET /instances/{id}/file	Download DICOM
InstancesApi	instancesIdFramesFrameImageInt16Get	GET /instances/{id}/frames/{frame}/image-int16	Decode a frame (int16)
InstancesApi	instancesIdFramesFrameImageUint16Get	GET /instances/{id}/frames/{frame}/image-uint16	Decode a frame (uint16)
InstancesApi	instancesIdFramesFrameImageUint8Get	GET /instances/{id}/frames/{frame}/image-uint8	Decode a frame (uint8)
InstancesApi	instancesIdFramesFrameMatlabGet	GET /instances/{id}/frames/{frame}/matlab	Decode frame for Matlab
InstancesApi	instancesIdFramesFrameNumpyGet	GET /instances/{id}/frames/{frame}/numpy	Decode frame for numpy
InstancesApi	instancesIdFramesFramePreviewGet	GET /instances/{id}/frames/{frame}/preview	Decode a frame (preview)
InstancesApi	instancesIdFramesFrameRawGet	GET /instances/{id}/frames/{frame}/raw	Access raw frame
InstancesApi	instancesIdFramesFrameRawGzGet	GET /instances/{id}/frames/{frame}/raw.gz	Access raw frame (compressed)
InstancesApi	instancesIdFramesFrameRenderedGet	GET /instances/{id}/frames/{frame}/rendered	Render a frame
InstancesApi	instancesIdFramesGet	GET /instances/{id}/frames	List available frames
InstancesApi	instancesIdGet	GET /instances/{id}	Get information about some instance
InstancesApi	instancesIdHeaderGet	GET /instances/{id}/header	Get DICOM meta-header
InstancesApi	instancesIdImageInt16Get	GET /instances/{id}/image-int16	Decode an image (int16)
InstancesApi	instancesIdImageUint16Get	GET /instances/{id}/image-uint16	Decode an image (uint16)
InstancesApi	instancesIdImageUint8Get	GET /instances/{id}/image-uint8	Decode an image (uint8)
InstancesApi	instancesIdMatlabGet	GET /instances/{id}/matlab	Decode frame for Matlab
InstancesApi	instancesIdMetadataGet	GET /instances/{id}/metadata	List metadata
InstancesApi	instancesIdMetadataNameDelete	DELETE /instances/{id}/metadata/{name}	Delete metadata
InstancesApi	instancesIdMetadataNameGet	GET /instances/{id}/metadata/{name}	Get metadata
InstancesApi	instancesIdMetadataNamePut	PUT /instances/{id}/metadata/{name}	Set metadata
InstancesApi	instancesIdModifyPost	POST /instances/{id}/modify	Modify instance
InstancesApi	instancesIdModuleGet	GET /instances/{id}/module	Get instance module
InstancesApi	instancesIdNumpyGet	GET /instances/{id}/numpy	Decode instance for numpy
InstancesApi	instancesIdPatientGet	GET /instances/{id}/patient	Get parent patient
InstancesApi	instancesIdPdfGet	GET /instances/{id}/pdf	Get embedded PDF
InstancesApi	instancesIdPreviewGet	GET /instances/{id}/preview	Decode an image (preview)
InstancesApi	instancesIdReconstructPost	POST /instances/{id}/reconstruct	Reconstruct tags & optionally files of instance
InstancesApi	instancesIdRenderedGet	GET /instances/{id}/rendered	Render an image
InstancesApi	instancesIdSeriesGet	GET /instances/{id}/series	Get parent series
InstancesApi	instancesIdSimplifiedTagsGet	GET /instances/{id}/simplified-tags	Get human-readable tags
InstancesApi	instancesIdStatisticsGet	GET /instances/{id}/statistics	Get instance statistics
InstancesApi	instancesIdStudyGet	GET /instances/{id}/study	Get parent study
InstancesApi	instancesIdTagsGet	GET /instances/{id}/tags	Get DICOM tags
InstancesApi	instancesPost	POST /instances	Upload DICOM instances
JobsApi	jobsGet	GET /jobs	List jobs
JobsApi	jobsIdCancelPost	POST /jobs/{id}/cancel	Cancel job
JobsApi	jobsIdGet	GET /jobs/{id}	Get job
JobsApi	jobsIdKeyGet	GET /jobs/{id}/{key}	Get job output
JobsApi	jobsIdPausePost	POST /jobs/{id}/pause	Pause job
JobsApi	jobsIdResubmitPost	POST /jobs/{id}/resubmit	Resubmit job
JobsApi	jobsIdResumePost	POST /jobs/{id}/resume	Resume job
LogsApi	toolsLogLevelDicomGet	GET /tools/log-level-dicom	Get log level for `dicom`
LogsApi	toolsLogLevelDicomPut	PUT /tools/log-level-dicom	Set log level for `dicom`
LogsApi	toolsLogLevelGenericGet	GET /tools/log-level-generic	Get log level for `generic`
LogsApi	toolsLogLevelGenericPut	PUT /tools/log-level-generic	Set log level for `generic`
LogsApi	toolsLogLevelGet	GET /tools/log-level	Get main log level
LogsApi	toolsLogLevelHttpGet	GET /tools/log-level-http	Get log level for `http`
LogsApi	toolsLogLevelHttpPut	PUT /tools/log-level-http	Set log level for `http`
LogsApi	toolsLogLevelJobsGet	GET /tools/log-level-jobs	Get log level for `jobs`
LogsApi	toolsLogLevelJobsPut	PUT /tools/log-level-jobs	Set log level for `jobs`
LogsApi	toolsLogLevelLuaGet	GET /tools/log-level-lua	Get log level for `lua`
LogsApi	toolsLogLevelLuaPut	PUT /tools/log-level-lua	Set log level for `lua`
LogsApi	toolsLogLevelPluginsGet	GET /tools/log-level-plugins	Get log level for `plugins`
LogsApi	toolsLogLevelPluginsPut	PUT /tools/log-level-plugins	Set log level for `plugins`
LogsApi	toolsLogLevelPut	PUT /tools/log-level	Set main log level
LogsApi	toolsLogLevelSqliteGet	GET /tools/log-level-sqlite	Get log level for `sqlite`
LogsApi	toolsLogLevelSqlitePut	PUT /tools/log-level-sqlite	Set log level for `sqlite`
NetworkingApi	modalitiesGet	GET /modalities	List DICOM modalities
NetworkingApi	modalitiesIdConfigurationGet	GET /modalities/{id}/configuration	Get modality configuration
NetworkingApi	modalitiesIdDelete	DELETE /modalities/{id}	Delete DICOM modality
NetworkingApi	modalitiesIdEchoPost	POST /modalities/{id}/echo	Trigger C-ECHO SCU
NetworkingApi	modalitiesIdFindInstancePost	POST /modalities/{id}/find-instance	C-FIND SCU for instances
NetworkingApi	modalitiesIdFindPatientPost	POST /modalities/{id}/find-patient	C-FIND SCU for patients
NetworkingApi	modalitiesIdFindPost	POST /modalities/{id}/find	Hierarchical C-FIND SCU
NetworkingApi	modalitiesIdFindSeriesPost	POST /modalities/{id}/find-series	C-FIND SCU for series
NetworkingApi	modalitiesIdFindStudyPost	POST /modalities/{id}/find-study	C-FIND SCU for studies
NetworkingApi	modalitiesIdFindWorklistPost	POST /modalities/{id}/find-worklist	C-FIND SCU for worklist
NetworkingApi	modalitiesIdGet	GET /modalities/{id}	List operations on modality
NetworkingApi	modalitiesIdMovePost	POST /modalities/{id}/move	Trigger C-MOVE SCU
NetworkingApi	modalitiesIdPut	PUT /modalities/{id}	Update DICOM modality
NetworkingApi	modalitiesIdQueryPost	POST /modalities/{id}/query	Trigger C-FIND SCU
NetworkingApi	modalitiesIdStorageCommitmentPost	POST /modalities/{id}/storage-commitment	Trigger storage commitment request
NetworkingApi	modalitiesIdStorePost	POST /modalities/{id}/store	Trigger C-STORE SCU
NetworkingApi	modalitiesIdStoreStraightPost	POST /modalities/{id}/store-straight	Straight C-STORE SCU
NetworkingApi	peersGet	GET /peers	List Orthanc peers
NetworkingApi	peersIdConfigurationGet	GET /peers/{id}/configuration	Get peer configuration
NetworkingApi	peersIdDelete	DELETE /peers/{id}	Delete Orthanc peer
NetworkingApi	peersIdGet	GET /peers/{id}	List operations on peer
NetworkingApi	peersIdPut	PUT /peers/{id}	Update Orthanc peer
NetworkingApi	peersIdStorePost	POST /peers/{id}/store	Send to Orthanc peer
NetworkingApi	peersIdStoreStraightPost	POST /peers/{id}/store-straight	Straight store to peer
NetworkingApi	peersIdSystemGet	GET /peers/{id}/system	Get peer system information
NetworkingApi	queriesGet	GET /queries	List query/retrieve operations
NetworkingApi	queriesIdAnswersGet	GET /queries/{id}/answers	List answers to a query
NetworkingApi	queriesIdAnswersIndexContentGet	GET /queries/{id}/answers/{index}/content	Get one answer
NetworkingApi	queriesIdAnswersIndexGet	GET /queries/{id}/answers/{index}	List operations on an answer
NetworkingApi	queriesIdAnswersIndexQueryInstancesPost	POST /queries/{id}/answers/{index}/query-instances	Query the child instances of an answer
NetworkingApi	queriesIdAnswersIndexQuerySeriesPost	POST /queries/{id}/answers/{index}/query-series	Query the child series of an answer
NetworkingApi	queriesIdAnswersIndexQueryStudiesPost	POST /queries/{id}/answers/{index}/query-studies	Query the child studies of an answer
NetworkingApi	queriesIdAnswersIndexRetrievePost	POST /queries/{id}/answers/{index}/retrieve	Retrieve one answer
NetworkingApi	queriesIdDelete	DELETE /queries/{id}	Delete a query
NetworkingApi	queriesIdGet	GET /queries/{id}	List operations on a query
NetworkingApi	queriesIdLevelGet	GET /queries/{id}/level	Get level of original query
NetworkingApi	queriesIdModalityGet	GET /queries/{id}/modality	Get modality of original query
NetworkingApi	queriesIdQueryGet	GET /queries/{id}/query	Get original query arguments
NetworkingApi	queriesIdRetrievePost	POST /queries/{id}/retrieve	Retrieve all answers
NetworkingApi	storageCommitmentIdGet	GET /storage-commitment/{id}	Get storage commitment report
NetworkingApi	storageCommitmentIdRemovePost	POST /storage-commitment/{id}/remove	Remove after storage commitment
OtherApi	instancesIdAttachmentsNameGet	GET /instances/{id}/attachments/{name}	List operations on attachments
OtherApi	instancesIdFramesFrameGet	GET /instances/{id}/frames/{frame}	List operations
OtherApi	patientsIdAttachmentsNameGet	GET /patients/{id}/attachments/{name}	List operations on attachments
OtherApi	seriesIdAttachmentsNameGet	GET /series/{id}/attachments/{name}	List operations on attachments
OtherApi	studiesIdAttachmentsNameGet	GET /studies/{id}/attachments/{name}	List operations on attachments
OtherApi	toolsGet	GET /tools	List operations
PatientsApi	patientsGet	GET /patients	List the available patients
PatientsApi	patientsIdAnonymizePost	POST /patients/{id}/anonymize	Anonymize patient
PatientsApi	patientsIdArchiveGet	GET /patients/{id}/archive	Create ZIP archive
PatientsApi	patientsIdArchivePost	POST /patients/{id}/archive	Create ZIP archive
PatientsApi	patientsIdAttachmentsGet	GET /patients/{id}/attachments	List attachments
PatientsApi	patientsIdAttachmentsNameCompressPost	POST /patients/{id}/attachments/{name}/compress	Compress attachment
PatientsApi	patientsIdAttachmentsNameCompressedDataGet	GET /patients/{id}/attachments/{name}/compressed-data	Get attachment (no decompression)
PatientsApi	patientsIdAttachmentsNameCompressedMd5Get	GET /patients/{id}/attachments/{name}/compressed-md5	Get MD5 of attachment on disk
PatientsApi	patientsIdAttachmentsNameCompressedSizeGet	GET /patients/{id}/attachments/{name}/compressed-size	Get size of attachment on disk
PatientsApi	patientsIdAttachmentsNameDataGet	GET /patients/{id}/attachments/{name}/data	Get attachment
PatientsApi	patientsIdAttachmentsNameDelete	DELETE /patients/{id}/attachments/{name}	Delete attachment
PatientsApi	patientsIdAttachmentsNameInfoGet	GET /patients/{id}/attachments/{name}/info	Get info about the attachment
PatientsApi	patientsIdAttachmentsNameIsCompressedGet	GET /patients/{id}/attachments/{name}/is-compressed	Is attachment compressed?
PatientsApi	patientsIdAttachmentsNameMd5Get	GET /patients/{id}/attachments/{name}/md5	Get MD5 of attachment
PatientsApi	patientsIdAttachmentsNamePut	PUT /patients/{id}/attachments/{name}	Set attachment
PatientsApi	patientsIdAttachmentsNameSizeGet	GET /patients/{id}/attachments/{name}/size	Get size of attachment
PatientsApi	patientsIdAttachmentsNameUncompressPost	POST /patients/{id}/attachments/{name}/uncompress	Uncompress attachment
PatientsApi	patientsIdAttachmentsNameVerifyMd5Post	POST /patients/{id}/attachments/{name}/verify-md5	Verify attachment
PatientsApi	patientsIdDelete	DELETE /patients/{id}	Delete some patient
PatientsApi	patientsIdGet	GET /patients/{id}	Get information about some patient
PatientsApi	patientsIdInstancesGet	GET /patients/{id}/instances	Get child instances
PatientsApi	patientsIdInstancesTagsGet	GET /patients/{id}/instances-tags	Get tags of instances
PatientsApi	patientsIdMediaGet	GET /patients/{id}/media	Create DICOMDIR media
PatientsApi	patientsIdMediaPost	POST /patients/{id}/media	Create DICOMDIR media
PatientsApi	patientsIdMetadataGet	GET /patients/{id}/metadata	List metadata
PatientsApi	patientsIdMetadataNameDelete	DELETE /patients/{id}/metadata/{name}	Delete metadata
PatientsApi	patientsIdMetadataNameGet	GET /patients/{id}/metadata/{name}	Get metadata
PatientsApi	patientsIdMetadataNamePut	PUT /patients/{id}/metadata/{name}	Set metadata
PatientsApi	patientsIdModifyPost	POST /patients/{id}/modify	Modify patient
PatientsApi	patientsIdModuleGet	GET /patients/{id}/module	Get patient module
PatientsApi	patientsIdProtectedGet	GET /patients/{id}/protected	Is the patient protected against recycling?
PatientsApi	patientsIdProtectedPut	PUT /patients/{id}/protected	Protect one patient against recycling
PatientsApi	patientsIdReconstructPost	POST /patients/{id}/reconstruct	Reconstruct tags & optionally files of patient
PatientsApi	patientsIdSeriesGet	GET /patients/{id}/series	Get child series
PatientsApi	patientsIdSharedTagsGet	GET /patients/{id}/shared-tags	Get shared tags
PatientsApi	patientsIdStatisticsGet	GET /patients/{id}/statistics	Get patient statistics
PatientsApi	patientsIdStudiesGet	GET /patients/{id}/studies	Get child studies
SeriesApi	seriesGet	GET /series	List the available series
SeriesApi	seriesIdAnonymizePost	POST /series/{id}/anonymize	Anonymize series
SeriesApi	seriesIdArchiveGet	GET /series/{id}/archive	Create ZIP archive
SeriesApi	seriesIdArchivePost	POST /series/{id}/archive	Create ZIP archive
SeriesApi	seriesIdAttachmentsGet	GET /series/{id}/attachments	List attachments
SeriesApi	seriesIdAttachmentsNameCompressPost	POST /series/{id}/attachments/{name}/compress	Compress attachment
SeriesApi	seriesIdAttachmentsNameCompressedDataGet	GET /series/{id}/attachments/{name}/compressed-data	Get attachment (no decompression)
SeriesApi	seriesIdAttachmentsNameCompressedMd5Get	GET /series/{id}/attachments/{name}/compressed-md5	Get MD5 of attachment on disk
SeriesApi	seriesIdAttachmentsNameCompressedSizeGet	GET /series/{id}/attachments/{name}/compressed-size	Get size of attachment on disk
SeriesApi	seriesIdAttachmentsNameDataGet	GET /series/{id}/attachments/{name}/data	Get attachment
SeriesApi	seriesIdAttachmentsNameDelete	DELETE /series/{id}/attachments/{name}	Delete attachment
SeriesApi	seriesIdAttachmentsNameInfoGet	GET /series/{id}/attachments/{name}/info	Get info about the attachment
SeriesApi	seriesIdAttachmentsNameIsCompressedGet	GET /series/{id}/attachments/{name}/is-compressed	Is attachment compressed?
SeriesApi	seriesIdAttachmentsNameMd5Get	GET /series/{id}/attachments/{name}/md5	Get MD5 of attachment
SeriesApi	seriesIdAttachmentsNamePut	PUT /series/{id}/attachments/{name}	Set attachment
SeriesApi	seriesIdAttachmentsNameSizeGet	GET /series/{id}/attachments/{name}/size	Get size of attachment
SeriesApi	seriesIdAttachmentsNameUncompressPost	POST /series/{id}/attachments/{name}/uncompress	Uncompress attachment
SeriesApi	seriesIdAttachmentsNameVerifyMd5Post	POST /series/{id}/attachments/{name}/verify-md5	Verify attachment
SeriesApi	seriesIdDelete	DELETE /series/{id}	Delete some series
SeriesApi	seriesIdGet	GET /series/{id}	Get information about some series
SeriesApi	seriesIdInstancesGet	GET /series/{id}/instances	Get child instances
SeriesApi	seriesIdInstancesTagsGet	GET /series/{id}/instances-tags	Get tags of instances
SeriesApi	seriesIdMediaGet	GET /series/{id}/media	Create DICOMDIR media
SeriesApi	seriesIdMediaPost	POST /series/{id}/media	Create DICOMDIR media
SeriesApi	seriesIdMetadataGet	GET /series/{id}/metadata	List metadata
SeriesApi	seriesIdMetadataNameDelete	DELETE /series/{id}/metadata/{name}	Delete metadata
SeriesApi	seriesIdMetadataNameGet	GET /series/{id}/metadata/{name}	Get metadata
SeriesApi	seriesIdMetadataNamePut	PUT /series/{id}/metadata/{name}	Set metadata
SeriesApi	seriesIdModifyPost	POST /series/{id}/modify	Modify series
SeriesApi	seriesIdModuleGet	GET /series/{id}/module	Get series module
SeriesApi	seriesIdNumpyGet	GET /series/{id}/numpy	Decode series for numpy
SeriesApi	seriesIdOrderedSlicesGet	GET /series/{id}/ordered-slices	Order the slices
SeriesApi	seriesIdPatientGet	GET /series/{id}/patient	Get parent patient
SeriesApi	seriesIdReconstructPost	POST /series/{id}/reconstruct	Reconstruct tags & optionally files of series
SeriesApi	seriesIdSharedTagsGet	GET /series/{id}/shared-tags	Get shared tags
SeriesApi	seriesIdStatisticsGet	GET /series/{id}/statistics	Get series statistics
SeriesApi	seriesIdStudyGet	GET /series/{id}/study	Get parent study
StudiesApi	studiesGet	GET /studies	List the available studies
StudiesApi	studiesIdAnonymizePost	POST /studies/{id}/anonymize	Anonymize study
StudiesApi	studiesIdArchiveGet	GET /studies/{id}/archive	Create ZIP archive
StudiesApi	studiesIdArchivePost	POST /studies/{id}/archive	Create ZIP archive
StudiesApi	studiesIdAttachmentsGet	GET /studies/{id}/attachments	List attachments
StudiesApi	studiesIdAttachmentsNameCompressPost	POST /studies/{id}/attachments/{name}/compress	Compress attachment
StudiesApi	studiesIdAttachmentsNameCompressedDataGet	GET /studies/{id}/attachments/{name}/compressed-data	Get attachment (no decompression)
StudiesApi	studiesIdAttachmentsNameCompressedMd5Get	GET /studies/{id}/attachments/{name}/compressed-md5	Get MD5 of attachment on disk
StudiesApi	studiesIdAttachmentsNameCompressedSizeGet	GET /studies/{id}/attachments/{name}/compressed-size	Get size of attachment on disk
StudiesApi	studiesIdAttachmentsNameDataGet	GET /studies/{id}/attachments/{name}/data	Get attachment
StudiesApi	studiesIdAttachmentsNameDelete	DELETE /studies/{id}/attachments/{name}	Delete attachment
StudiesApi	studiesIdAttachmentsNameInfoGet	GET /studies/{id}/attachments/{name}/info	Get info about the attachment
StudiesApi	studiesIdAttachmentsNameIsCompressedGet	GET /studies/{id}/attachments/{name}/is-compressed	Is attachment compressed?
StudiesApi	studiesIdAttachmentsNameMd5Get	GET /studies/{id}/attachments/{name}/md5	Get MD5 of attachment
StudiesApi	studiesIdAttachmentsNamePut	PUT /studies/{id}/attachments/{name}	Set attachment
StudiesApi	studiesIdAttachmentsNameSizeGet	GET /studies/{id}/attachments/{name}/size	Get size of attachment
StudiesApi	studiesIdAttachmentsNameUncompressPost	POST /studies/{id}/attachments/{name}/uncompress	Uncompress attachment
StudiesApi	studiesIdAttachmentsNameVerifyMd5Post	POST /studies/{id}/attachments/{name}/verify-md5	Verify attachment
StudiesApi	studiesIdDelete	DELETE /studies/{id}	Delete some study
StudiesApi	studiesIdGet	GET /studies/{id}	Get information about some study
StudiesApi	studiesIdInstancesGet	GET /studies/{id}/instances	Get child instances
StudiesApi	studiesIdInstancesTagsGet	GET /studies/{id}/instances-tags	Get tags of instances
StudiesApi	studiesIdMediaGet	GET /studies/{id}/media	Create DICOMDIR media
StudiesApi	studiesIdMediaPost	POST /studies/{id}/media	Create DICOMDIR media
StudiesApi	studiesIdMergePost	POST /studies/{id}/merge	Merge study
StudiesApi	studiesIdMetadataGet	GET /studies/{id}/metadata	List metadata
StudiesApi	studiesIdMetadataNameDelete	DELETE /studies/{id}/metadata/{name}	Delete metadata
StudiesApi	studiesIdMetadataNameGet	GET /studies/{id}/metadata/{name}	Get metadata
StudiesApi	studiesIdMetadataNamePut	PUT /studies/{id}/metadata/{name}	Set metadata
StudiesApi	studiesIdModifyPost	POST /studies/{id}/modify	Modify study
StudiesApi	studiesIdModuleGet	GET /studies/{id}/module	Get study module
StudiesApi	studiesIdModulePatientGet	GET /studies/{id}/module-patient	Get patient module of study
StudiesApi	studiesIdPatientGet	GET /studies/{id}/patient	Get parent patient
StudiesApi	studiesIdReconstructPost	POST /studies/{id}/reconstruct	Reconstruct tags & optionally files of study
StudiesApi	studiesIdSeriesGet	GET /studies/{id}/series	Get child series
StudiesApi	studiesIdSharedTagsGet	GET /studies/{id}/shared-tags	Get shared tags
StudiesApi	studiesIdSplitPost	POST /studies/{id}/split	Split study
StudiesApi	studiesIdStatisticsGet	GET /studies/{id}/statistics	Get study statistics
SystemApi	pluginsExplorerJsGet	GET /plugins/explorer.js	JavaScript extensions to Orthanc Explorer
SystemApi	pluginsGet	GET /plugins	List plugins
SystemApi	pluginsIdGet	GET /plugins/{id}	Get plugin
SystemApi	statisticsGet	GET /statistics	Get database statistics
SystemApi	systemGet	GET /system	Get system information
SystemApi	toolsAcceptedTransferSyntaxesGet	GET /tools/accepted-transfer-syntaxes	Get accepted transfer syntaxes
SystemApi	toolsAcceptedTransferSyntaxesPut	PUT /tools/accepted-transfer-syntaxes	Set accepted transfer syntaxes
SystemApi	toolsBulkAnonymizePost	POST /tools/bulk-anonymize	Anonymize a set of resources
SystemApi	toolsBulkContentPost	POST /tools/bulk-content	Describe a set of resources
SystemApi	toolsBulkDeletePost	POST /tools/bulk-delete	Delete a set of resources
SystemApi	toolsBulkModifyPost	POST /tools/bulk-modify	Modify a set of resources
SystemApi	toolsCreateArchivePost	POST /tools/create-archive	Create ZIP archive
SystemApi	toolsCreateDicomPost	POST /tools/create-dicom	Create one DICOM instance
SystemApi	toolsCreateMediaExtendedPost	POST /tools/create-media-extended	Create DICOMDIR media
SystemApi	toolsCreateMediaPost	POST /tools/create-media	Create DICOMDIR media
SystemApi	toolsDefaultEncodingGet	GET /tools/default-encoding	Get default encoding
SystemApi	toolsDefaultEncodingPut	PUT /tools/default-encoding	Set default encoding
SystemApi	toolsDicomConformanceGet	GET /tools/dicom-conformance	Get DICOM conformance
SystemApi	toolsDicomEchoPost	POST /tools/dicom-echo	Trigger C-ECHO SCU
SystemApi	toolsExecuteScriptPost	POST /tools/execute-script	Execute Lua script
SystemApi	toolsFindPost	POST /tools/find	Look for local resources
SystemApi	toolsGenerateUidGet	GET /tools/generate-uid	Generate an identifier
SystemApi	toolsInvalidateTagsPost	POST /tools/invalidate-tags	Invalidate DICOM-as-JSON summaries
SystemApi	toolsLookupPost	POST /tools/lookup	Look for DICOM identifiers
SystemApi	toolsMetricsGet	GET /tools/metrics	Are metrics collected?
SystemApi	toolsMetricsPrometheusGet	GET /tools/metrics-prometheus	Get usage metrics
SystemApi	toolsMetricsPut	PUT /tools/metrics	Enable collection of metrics
SystemApi	toolsNowGet	GET /tools/now	Get UTC time
SystemApi	toolsNowLocalGet	GET /tools/now-local	Get local time
SystemApi	toolsReconstructPost	POST /tools/reconstruct	Reconstruct all the index
SystemApi	toolsResetPost	POST /tools/reset	Restart Orthanc
SystemApi	toolsShutdownPost	POST /tools/shutdown	Shutdown Orthanc
SystemApi	toolsUnknownSopClassAcceptedGet	GET /tools/unknown-sop-class-accepted	Is unknown SOP class accepted?
SystemApi	toolsUnknownSopClassAcceptedPut	PUT /tools/unknown-sop-class-accepted	Set unknown SOP class accepted
TrackingChangesApi	changesDelete	DELETE /changes	Clear changes
TrackingChangesApi	changesGet	GET /changes	List changes
TrackingChangesApi	exportsDelete	DELETE /exports	Clear exports
TrackingChangesApi	exportsGet	GET /exports	List exports

Models

• ChangesGet200Response
• InstancesIdAnonymizePostRequest
• InstancesIdModifyPostRequest
• InstancesIdReconstructPostRequest
• InstancesIdStatisticsGet200Response
• InstancesPost200Response
• ModalitiesIdEchoPostRequest
• ModalitiesIdFindWorklistPostRequest
• ModalitiesIdMovePost200Response
• ModalitiesIdMovePostRequest
• ModalitiesIdPutRequest
• ModalitiesIdQueryPost200Response
• ModalitiesIdQueryPostRequest
• ModalitiesIdStorageCommitmentPost200Response
• ModalitiesIdStorageCommitmentPostRequest
• ModalitiesIdStorePostRequest
• ModalitiesIdStoreStraightPost200Response
• PatientsIdAnonymizePostRequest
• PatientsIdArchivePost200Response
• PatientsIdArchivePostRequest
• PatientsIdMediaPostRequest
• PatientsIdModifyPostRequest
• PatientsIdStatisticsGet200Response
• PeersIdPutRequest
• PeersIdStorePostRequest
• PeersIdStoreStraightPost200Response
• QueriesIdAnswersIndexQueryInstancesPostRequest
• QueriesIdAnswersIndexRetrievePostRequest
• SeriesIdOrderedSlicesGet200Response
• SeriesIdStatisticsGet200Response
• StatisticsGet200Response
• StorageCommitmentIdGet200Response
• StudiesIdMergePostRequest
• StudiesIdSplitPostRequest
• StudiesIdStatisticsGet200Response
• SystemGet200Response
• ToolsBulkAnonymizePost200Response
• ToolsBulkAnonymizePostRequest
• ToolsBulkContentPostRequest
• ToolsBulkDeletePostRequest
• ToolsBulkModifyPost200Response
• ToolsBulkModifyPostRequest
• ToolsCreateArchivePostRequest
• ToolsCreateDicomPost200Response
• ToolsCreateDicomPostRequest
• ToolsCreateMediaExtendedPostRequest
• ToolsCreateMediaPostRequest
• ToolsDicomEchoPostRequest
• ToolsFindPostRequest

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.11.3
• Build package: org.openapitools.codegen.languages.PhpClientCodegen