RESTful Services - amsalama/dcm4chee-arc-light GitHub Wiki

Swagger UI

Service Classes

QIDO_RS

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/rs /studies Search for Studies
GET /dcm4chee-arc/aets/{aet}/rs /series Search for Series
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series Search for Series of Study
GET /dcm4chee-arc/aets/{aet}/rs /instances Search for Instances
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances Search for Instances of Study
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances Search for Instances of Series
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /patients Search for Patients from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies Search for Studies from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies/{study}/series Search for Series of Study from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies/{study}/series/{series}/instances Search for Instances of Series of Study from C-FIND SCP

WADO_RS

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study} Retrieve Study
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/metadata Retrieve Study Metadata
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/rendered Retrieve Rendered Study
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/thumbnail Retrieve Study Thumbnail
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series} Retrieve Series
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/metadata Retrieve Series Metadata
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/rendered Retrieve Rendered Series
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/thumbnail Retrieve Series Thumbnail
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance} Retrieve Instance
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/bulkdata/{bulkdata} Retrieve Bulkdata
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/frames/{frames} Retrieve Frames
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/frames/{frames}/thumbnail Retrieve Frames Thumbnail
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/frames/{frames}/rendered Retrieve Rendered Frames
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/thumbnail Retrieve Instance Thumbnail
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/rendered Retrieve Rendered Instance
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/metadata Retrieve Instance Metadata

Response media types by service

WADO_URI

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/wado Retrieve Instance by WADO-URI

STOW_RS

Method Service Path Append URL Service Name
POST /dcm4chee-arc/aets/{aet}/rs /studies Store Instances
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study} Store Instances to a Study

UPS_RS

Method Service Path Append URL Service Name
POST /dcm4chee-arc/aets/{aet}/rs /workitems Creates a new Workitem
GET /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem} Retrieve Workitem
GET /dcm4chee-arc/aets/{aet}/rs /workitems/count Count Workitems
POST /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem} Update existing Workitem
PUT /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem}/state/{requester} Change Workitem State
POST /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem}/cancelrequest/{requester} Request Cancellation of Workitem
POST /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem}/subscribers/{subscriber} Subscribe to Workitem
DELETE /dcm4chee-arc/aets/{aet}/rs /workitems/{workitem}/subscribers/{subscriber} Unsubscribe from Workitem
POST /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber} Subscribe to Worklist
DELETE /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber} Unsubscribe from Worklist
POST /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber} Subscribe to Filtered Worklist
DELETE /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber} Unsubscribe from Filtered Worklist
POST /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber}/suspend Suspend subscription from Worklist
POST /dcm4chee-arc/aets/{aet}/rs /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber}/suspend Suspend subscription from Filtered Worklist

MWL_RS

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/rs /mwlitems Search for Scheduled Procedure Steps
GET /dcm4chee-arc/aets/{aet}/rs /mwlitems/count Count Scheduled Procedure Steps

MOVE

Method Service Path Append URL Service Name
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/export/dicom:{destination} Retrieve Study from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/export/dicom:{destination} Retrieve Series from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/instances/{instance}/export/dicom:{destination} Retrieve Instance from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/mark4retrieve/dicom:{destination} Mark Study for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/mark4retrieve/dicom:{destination} Mark Series for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/instances/{instance}/mark4retrieve/dicom:{destination} Mark Instance for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/csv:{field}/export/dicom:{destination} Retrieve Studies specified in CSV from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/csv:{field}/mark4retrieve/dicom:{destination} Mark Studies specified in CSV from C-MOVE SCP

MOVE_MATCHING

Method Service Path Append URL Service Name
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/export/dicom:{destination} Query and Retrieve matching Studies from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/export/dicom:{destination} Query and Retrieve matching Series from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/instances/export/dicom:{destination} Query and Retrieve matching Instances from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/mark4retrieve/dicom:{destination} Query and Mark matching Studies for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/mark4retrieve/dicom:{destination} Query and Mark matching Series for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp} /studies/{study}/series/{series}/instances/mark4retrieve/dicom:{destination} Query and Mark matching Instances for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/export/dicom:{destination} Query from C-FIND SCP and Retrieve matching Studies from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/{study}/series/export/dicom:{destination} Query from C-FIND SCP and Retrieve matching Series from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/{study}/series/{series}/instances/export/dicom:{destination} Query from C-FIND SCP and Retrieve matching Instances from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/mark4retrieve/dicom:{destination} Query from C-FIND SCP and Mark matching Studies for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/{study}/series/mark4retrieve/dicom:{destination} Query from C-FIND SCP and Mark matching Series for retrieve from C-MOVE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp} /studies/{study}/series/{series}/instances/mark4retrieve/dicom:{destination} Query from C-FIND SCP and Mark matching Instances for retrieve from C-MOVE SCP

REJECT

Method Service Path Append URL Service Name
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp} /studies/{study}/reject/{codeValue}^{codeSchemeDesignator} Query and Reject Study from C-STORE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp} /studies/{study}/series/{series}/reject/{codeValue}^{codeSchemeDesignator} Query and Reject Series from C-STORE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp} /studies/{study}/series/{series}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} Query and Reject Instance from C-STORE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp}/query:{findscp} /studies/{study}/reject/{codeValue}^{codeSchemeDesignator} Query from C-FIND SCP and Reject Study from C-STORE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp}/query:{findscp} /studies/{study}/series/{series}/reject/{codeValue}^{codeSchemeDesignator} Query from C-FIND SCP and Reject Series from C-STORE SCP
POST /dcm4chee-arc/aets/{aet}/dimse/{storescp}/query:{findscp} /studies/{study}/series/{series}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} Query from C-FIND SCP and Reject Instance from C-STORE SCP

PAM

Method Service Path Append URL Service Name
POST /dcm4chee-arc/hl7apps/{sending}/hl7/{receiving} /patients Create Patient external
PUT /dcm4chee-arc/hl7apps/{sending}/hl7/{receiving} /patients/{patientID} Update, Merge or Change Patient ID external

DCM4CHEE_ARC_AET

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/rs /patients Search for Patients
POST /dcm4chee-arc/aets/{aet}/rs /patients Create Patient
PUT /dcm4chee-arc/aets/{aet}/rs /patients/{priorPatientID} Update, Merge or Change Patient ID
DELETE /dcm4chee-arc/aets/{aet}/rs /patients/{patientID} Delete Patient Permanently
POST /dcm4chee-arc/aets/{aet}/rs /patients/{patientID}/pdq/{PDQServiceID} Update Patient Demographics
POST /dcm4chee-arc/aets/{aet}/rs /patients/{patientID}/merge Merge Patients
GET /dcm4chee-arc/aets/{aet}/rs /studies/size Size of Studies
POST /dcm4chee-arc/aets/{aet}/rs /studies Update Study
GET /dcm4chee-arc/aets/{aet}/rs /mwlitems Search for Scheduled Procedure Steps
POST /dcm4chee-arc/aets/{aet}/rs /mwlitems Create/Update Scheduled Procedure Step
DELETE /dcm4chee-arc/aets/{aet}/rs /mwlitems/{study}/{spsID} Delete Scheduled Procedure Step
GET /dcm4chee-arc/aets/{aet}/rs /workitems Search for Workitems
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/export/{exporterID} Export Study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/export/{exporterID} Export Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/export/{exporterID} Export Instance
POST /dcm4chee-arc/aets/{aet}/rs /studies/csv:{field}/export/{exporterID} Export Studies specified in CSV
POST /dcm4chee-arc/aets/{aet}/rs /studies/export/{exporterID} Export matching Studies
POST /dcm4chee-arc/aets/{aet}/rs /series/export/{exporterID} Export matching Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/export/{exporterID} Export matching Series of Study
POST /dcm4chee-arc/aets/{aet}/rs /instances/export/{exporterID} Export matching Instances
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/export/{exporterID} Export matching Instances of Study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/export/{exporterID} Export matching Instances of Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/reject/{codeValue}^{codeSchemeDesignator} Reject Study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/reject/{codeValue}^{codeSchemeDesignator} Reject Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} Reject Instance
POST /dcm4chee-arc/aets/{aet}/rs /studies/reject/{codeValue}^{codeSchemeDesignator} Reject matching Studies
POST /dcm4chee-arc/aets/{aet}/rs /series/reject/{codeValue}^{codeSchemeDesignator} Reject matching Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/reject/{codeValue}^{codeSchemeDesignator} Reject matching Series of Study
POST /dcm4chee-arc/aets/{aet}/rs /instances/reject/{codeValue}^{codeSchemeDesignator} Reject matching Instances
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/reject/{codeValue}^{codeSchemeDesignator} Reject matching Instances of Study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/reject/{codeValue}^{codeSchemeDesignator} Reject matching Instances of Series
POST /dcm4chee-arc/aets/{aet}/rs /studies/csv:{field}/reject/{codeValue}^{codeSchemeDesignator} Reject Studies specified in CSV
PUT /dcm4chee-arc/aets/{aet}/rs /studies/{study}/expire/{expirationDate} Update Study Expiration Date
PUT /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/expire/{expirationDate} Update Series Expiration Date
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/copy Copy Instances to Study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/move/{CodeValue}^{CodingSchemeDesignator} Move Instances to Study
POST /dcm4chee-arc/aets/{aet}/rs /mwlitems/{study}/{spsID}/move/{CodeValue}^{CodingSchemeDesignator} Link Instances with MWL Entry
DELETE /dcm4chee-arc/aets/{aet}/rs /studies/{study} Delete Study Permanently
POST /dcm4chee-arc/aets/{aet}/rs /expire/series Apply Retention Policy
POST /dcm4chee-arc/aets/{aet}/rs /studies/access/{accessControlID} Update Study Access Control ID of matching Studies
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/access/{accessControlID} Update Study Access Control ID
POST /dcm4chee-arc/aets/{aet}/rs /studies/ian/{ianscp} Schedule IAN of matching studies to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /series/ian/{ianscp} Schedule IAN of matching series to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/ian/{ianscp} Schedule IAN of matching series of study to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /instances/ian/{ianscp} Schedule IAN of matching instances to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/ian/{ianscp} Schedule IAN of matching instances of study to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/ian/{ianscp} Schedule IAN of matching instances of series to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/ian/dicom:{ianscp} Send IAN of study to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/ian/dicom:{ianscp} Send IAN of series to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/ian/dicom:{ianscp} Send IAN of instance to IANSCP
POST /dcm4chee-arc/aets/{aet}/rs /instances/storage/{storageID} Import Instances
POST /dcm4chee-arc/aets/{aet}/rs /studies/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching studies from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /series/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching series from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching series of study from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /instances/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching instances from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching instances of study from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/stgcmt/{stgCmtSCP} Schedule Storage Commitment of matching instances of series from Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/stgcmt/dicom:{stgCmtSCP} Request Storage Commitment of Study from external Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/stgcmt/dicom:{stgCmtSCP} Request Storage Commitment of Series from external Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/stgcmt/dicom:{stgCmtSCP} Request Storage Commitment of Instance from external Storage Commitment SCP
POST /dcm4chee-arc/aets/{aet}/rs /studies/stgver Schedule Storage Verification of matching studies
POST /dcm4chee-arc/aets/{aet}/rs /series/stgver Schedule Storage Verification of matching series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/stgver Schedule Storage Verification of matching series of study
POST /dcm4chee-arc/aets/{aet}/rs /instances/stgver Schedule Storage Verification of matching instances
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/stgver Schedule Storage Verification of matching instances of study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/stgver Schedule Storage Verification of matching instances of series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/stgver Verify Storage of study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/stgver Verify Storage of series of study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/stgver Verify Storage of series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/stgver Verify Storage of instances of study
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/stgver Verify Storage of instances of series
POST /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/{instance}/stgver Verify Storage of instance

DCM4CHEE_ARC_AET_DIFF

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/dimse/{findSCP}/diff/{secondaryFindSCP} /studies Compare Studies
GET /dcm4chee-arc/aets/{aet}/dimse/{findSCP}/diff/{secondaryFindSCP} /studies/count Compare Studies Count
POST /dcm4chee-arc/aets/{aet}/dimse/{findSCP}/diff/{secondaryFindSCP} /studies/csv:{field} Compare Studies specified in CSV

QIDO_COUNT

Method Service Path Append URL Service Name
GET /dcm4chee-arc/aets/{aet}/rs /patients/count Count Patients
GET /dcm4chee-arc/aets/{aet}/rs /studies/count Count Studies
GET /dcm4chee-arc/aets/{aet}/rs /series/count Count Series
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/count Count Series of Study
GET /dcm4chee-arc/aets/{aet}/rs /instances/count Count Instances
GET /dcm4chee-arc/aets/{aet}/rs /mwlitems/count Count Scheduled Procedure Steps
GET /dcm4chee-arc/aets/{aet}/rs /workitems/count Count Workitems
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/instances/count Count Instances of Study
GET /dcm4chee-arc/aets/{aet}/rs /studies/{study}/series/{series}/instances/count Count Instances of Series of Study
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /patients/count Count Patients from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies/count Count Studies from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies/{study}/series/count Count Series of Study from C-FIND SCP
GET /dcm4chee-arc/aets/{aet}/dimse/{findscp} /studies/{study}/series/{series}/instances/count Count Instances of Series from C-FIND SCP