RESTful Services - dcm4che/dcm4chee-arc-light GitHub Wiki
Complete technical specification and aspects of all REST services / APIs supported by the archive can be found in its Swagger UI
Majority of REST services of archive are categorized under several Web Service Classes. These service classes are used in configuration of several Web Applications used by the archive's user interface
- QIDO_RS
- WADO_RS
- WADO_URI
- STOW_RS
- UPS_RS
- UPS_MATCHING
- MWL_RS
- MPPS_RS
- QIDO_COUNT
- MOVE
- MOVE_MATCHING
- REJECT
- PAM
-
DCM4CHEE_ARC_AET
- Patient Management Services
- Study Management Services
- Modality Worklist specific services for Local / External archive
- Create Unified Procedure Steps for matching entities in external archive
- Export entities from Local Archive
- Storage Verification of entities in Local Archive
- Reject entities from Local / External Archive
- Other Imaging Object Change Management (IOCM) Services
- Schedule Instance Availability Notification (IAN) of entities to external IANSCP
- Schedule Storage Commitment of entities to external Storage Commitment SCP
- DCM4CHEE_ARC_AET_DIFF
Refer each of the specified services in Swagger, to get an in-depth overview of various query parameters, request payloads and responses sent back from archive server.
QIDO_RS Web Service Class is used by archive UI for DICOM Web Services - Search Transaction in local archive. Alternatively, it is also used to invoke search queries in external archive using C-FIND.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /patients | Search for Patients |
GET | /studies | Search for Studies |
GET | /series | Search for Series |
GET | /studies/{studyUID}/series | Search for Series of Study |
GET | /instances | Search for Instances |
GET | /studies/{studyUID}/instances | Search for Instances of Study |
GET | /studies/{studyUID}/series/{seriesUID}/instances | Search for Instances of Series |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{findscp}
Method | Append URL | Service Name |
---|---|---|
GET | /patients | Search for Patients from external C-FIND SCP |
GET | /studies | Search for Studies from external C-FIND SCP |
GET | /series | Search for Series from external C-FIND SCP |
GET | /studies/{studyUID}/series | Search for Series of Study from external C-FIND SCP |
GET | /instances | Search for Instances from external C-FIND SCP |
GET | /studies/{studyUID}/instances | Search for Instances of Study from external C-FIND SCP |
GET | /studies/{studyUID}/series/{seriesUID}/instances | Search for Instances of Series of Study from external C-FIND SCP |
WADO_RS Web Service Class is used by archive UI for DICOM Web Services - Retrieve Transaction in local archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /studies/{studyUID} | Retrieve Study |
GET | /studies/{studyUID}/bulkdata | Retrieve Study Bulkdata |
GET | /studies/{studyUID}/pixeldata | Retrieve Study Pixel Data |
GET | /studies/{studyUID}/metadata | Retrieve Study Metadata |
GET | /studies/{studyUID}/rendered | Retrieve Rendered Study |
GET | /studies/{studyUID}/thumbnail | Retrieve Study Thumbnail |
GET | /studies/{studyUID}/series/{seriesUID} | Retrieve Series |
GET | /studies/{studyUID}/series/{seriesUID}/bulkdata | Retrieve Series Bulkdata |
GET | /studies/{studyUID}/series/{seriesUID}/pixeldata | Retrieve Series Pixel Data |
GET | /studies/{studyUID}/series/{seriesUID}/metadata | Retrieve Series Metadata |
GET | /studies/{studyUID}/series/{seriesUID}/rendered | Retrieve Rendered Series |
GET | /studies/{studyUID}/series/{seriesUID}/thumbnail | Retrieve Series Thumbnail |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance} | Retrieve Instance |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/bulkdata | Retrieve Instance Bulkdata |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/pixeldata | Retrieve Instance Pixel Data |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/bulkdata/{bulkdata} | Retrieve Bulkdata |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/frames/{frames} | Retrieve Frames |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/frames/{frames}/thumbnail | Retrieve Frames Thumbnail |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/frames/{frames}/rendered | Retrieve Rendered Frames |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/thumbnail | Retrieve Instance Thumbnail |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/rendered | Retrieve Rendered Instance |
GET | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/metadata | Retrieve Instance Metadata |
Refer various WADO-RS Response media types by service, wherein
Code | Meaning |
---|---|
D | Default |
R | Required |
O | Optional |
C | Conditional (e.g. dependent on Transfer Syntax of stored object or if Multiframe) |
WADO_URI Web Service Class is used by archive UI for DICOM Web Services - URI Service in local archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/wado
Method | Append URL | Service Name |
---|---|---|
GET | Retrieve Instance by WADO-URI |
STOW_RS Web Service Class is used by archive UI for DICOM Web Services - Store Transaction in local archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies | Store Instances |
POST | /studies/{studyUID} | Store Instances to a Study |
UPS_RS Web Service Class is used by archive UI for DICOM Web Services - Worklist Service and Resources in local archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /workitems | Search for Workitems |
GET | /workitems/count | Count Workitems |
POST | /workitems | Creates a new Workitem |
GET | /workitems/{workitem} | Retrieve Workitem |
POST | /workitems/{workitem} | Update existing Workitem |
PUT | /workitems/{workitem}/state/{requester} | Change Workitem State |
POST | /workitems/{workitem}/cancelrequest/{requester} | Request Cancellation of Workitem |
POST | /workitems/{workitem}/subscribers/{subscriber} | Subscribe to Workitem |
DELETE | /workitems/{workitem}/subscribers/{subscriber} | Unsubscribe from Workitem |
POST | /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber} | Subscribe to GLobal Worklist |
DELETE | /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber} | Unsubscribe from Global Worklist |
POST | /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber} | Subscribe to Filtered Worklist |
DELETE | /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber} | Unsubscribe from Filtered Worklist |
POST | /workitems/1.2.840.10008.5.1.4.34.5/subscribers/{subscriber}/suspend | Suspend subscription from Global Worklist |
POST | /workitems/1.2.840.10008.5.1.4.34.5.1/subscribers/{subscriber}/suspend | Suspend subscription from Filtered Worklist |
UPS_MATCHING Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Unified Worklist management specific REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /workitems/{workitemUID}/reschedule | Reschedule Workitem |
POST | /studies/workitems | Create Workitems for local matching Studies |
POST | /studies/{studyUID}/series/workitems | Create Workitems for local matching Series of Study |
POST | /studies/{studyUID}/series/{seriesUID}/instances/workitems | Create Workitems for local matching Instances of Series |
POST | /studies/csv:{studyUID}/workitems | Create Workitems for local Studies specified in CSV |
MWL_RS Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Modality Worklist management specific REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /mwlitems | Search for Scheduled Procedure Steps |
GET | /mwlitems/count | Count Scheduled Procedure Steps |
MPPS_RS Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Modality Performed Procedure Step management specific REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /mpps | Search for Performed Procedure Steps |
GET | /mpps/count | Count Performed Procedure Steps |
QIDO_COUNT Web Service Class is used by archive UI for proprietary DCM4CHEE Archive count entities in local archive REST services. Alternatively, it is also used for count entities in external archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /patients/count | Count Patients |
GET | /studies/count | Count Studies |
GET | /series/count | Count Series |
GET | /studies/{studyUID}/series/count | Count Series of Study |
GET | /instances/count | Count Instances |
GET | /studies/{studyUID}/instances/count | Count Instances of Study |
GET | /studies/{studyUID}/series/{seriesUID}/instances/count | Count Instances of Series of Study |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{findscp}
Method | Append URL | Service Name |
---|---|---|
GET | /patients/count | Count Patients from external C-FIND SCP |
GET | /studies/count | Count Studies from external C-FIND SCP |
GET | /series/count | Count Series from external C-FIND SCP |
GET | /studies/{studyUID}/series/count | Count Series of Study from external C-FIND SCP |
GET | /instances/count | Count Instances from external C-FIND SCP |
GET | /studies/{studyUID}/instances/count | Count Instances of Study from external C-FIND SCP |
GET | /studies/{studyUID}/series/{seriesUID}/instances/count | Count Instances of Series of Study from external C-FIND SCP |
MOVE Web Service Class is used by archive UI for proprietary DCM4CHEE Archive retrieve entities from external archive REST services. Alternatively, it is also used to query entities from a C-FIND SCP and then retrieve entities from external archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/{studyUID}/export/dicom:{destination} | Retrieve Study from external C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/export/dicom:{destination} | Retrieve Series from C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/export/dicom:{destination} | Retrieve Instance from C-MOVE SCP |
POST | /studies/csv:{studyUIDField}/export/dicom:{destination} | Retrieve Studies specified in CSV from C-MOVE SCP |
POST | /studies/export/dicom:{destination} | Query & Retrieve matching Studies from external C-MOVE SCP |
POST | /studies/{studyUID}/series/export/dicom:{destination} | Query & Retrieve matching Series of Study from external C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/export/dicom:{destination} | Query & Retrieve matching Instances of Series from external C-MOVE SCP |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/export/dicom:{destination} | Query from C-FIND SCP & Retrieve matching Studies from external C-MOVE SCP |
POST | /studies/{studyUID}/series/export/dicom:{destination} | Query from C-FIND SCP & Retrieve matching Series of Study from external C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/export/dicom:{destination} | Query from C-FIND SCP & Retrieve matching Instances of Series from external C-MOVE SCP |
MOVE_MATCHING Web Service Class is used by archive UI for proprietary DCM4CHEE Archive retrieve matching entities from external archive REST services. Alternatively, it is also used to query matching entities from a C-FIND SCP and then retrieve matching entities from external archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/export/dicom:{destination} | Query and Retrieve matching Studies from external C-MOVE SCP |
POST | /studies/{studyUID}/series/export/dicom:{destination} | Query and Retrieve matching Series from external C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/export/dicom:{destination} | Query and Retrieve matching Instances from external C-MOVE SCP |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/export/dicom:{destination} | Query from C-FIND SCP and Retrieve matching Studies from external C-MOVE SCP |
POST | /studies/{studyUID}/series/export/dicom:{destination} | Query from C-FIND SCP and Retrieve matching Series from external C-MOVE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/export/dicom:{destination} | Query from C-FIND SCP and Retrieve matching Instances from external C-MOVE SCP |
REJECT Web Service Class is used by archive UI for proprietary DCM4CHEE Archive reject matching entities from external archive REST services. Alternatively, it is also used to query matching entities from a C-FIND SCP and then reject matching entities from external archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{storescp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/{studyUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Study from external C-STORE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Series from external C-STORE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} | Reject Instance from external C-STORE SCP |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{storescp}/query:{findscp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/{studyUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Study from external C-STORE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Series from external C-STORE SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} | Reject Instance from external C-STORE SCP |
PAM Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Patient Management in external archive REST services.
Web Service Path : /dcm4chee-arc/hl7apps/{hl7AppNameWithFacility}/hl7/{extHl7AppNameWithFacility}
Method | Append URL | Service Name |
---|---|---|
POST | /patients | Create Patient external |
PUT | /patients/{patientID} | Update, Merge or Change Patient ID in external archive |
PUT | /patients | Update Patient in external archive - Legacy |
POST | /patients/{priorPatientID}/merge | Merge Patients in external archive - Legacy |
POST | /patients/{priorPatientID}/changeid | Change PatientID in external archive - Legacy |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Patient Management in local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /patients | Create Patient |
PUT | /patients/{priorPatientID} | Update, Merge or Change Patient ID |
POST | /patients/{patientID}/merge | Merge Patients |
POST | /patients/{priorPatientID}/merge/{patientID} | Merge Patients |
POST | /patients/{priorPatientID}/changeid/{patientID} | Change Patient ID |
DELETE | /patients/{patientID} | Delete Patient Permanently |
POST | /patients/issuer/{issuer} | Supplement Issuer of Patient ID |
POST | /patients/charset/{charset} | Update Character Set of Patient Attributes |
POST | /patients/{patientID}/unmerge | Unmerge Patient |
POST | /patients/{patientID}/pdq/{PDQServiceID} | Update Patient Demographics |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Study Management in local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
GET | /studies/size | Size of Studies |
PUT | /studies/{studyUID} | Update Study |
PUT | /studies/{studyUID}/series/{seriesUID} | Update Series |
POST | /studies/access/{accessControlID} | Update Study Access Control ID of matching Studies |
PUT | /studies/{studyUID}/access/{accessControlID} | Update Study Access Control ID |
POST | /instances/storage/{storageID} | Import Instances |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for proprietary DCM4CHEE Archive Modality Worklist Management in local archive REST services. Alternatively, it is also used for search / count / import Modality Worklists from / in external archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /mwlitems | Create/Update Scheduled Procedure Step |
DELETE | /mwlitems/{studyUID}/{spsID} | Delete Scheduled Procedure Step |
POST | /mwlitems/{studyUID}/{spsID}/status/{status} | Change Status of Scheduled Procedure Step |
POST | /mwlitems/status/{status} | Change Status of matching Scheduled Procedure Steps |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{mwlscp}
Method | Append URL | Service Name |
---|---|---|
GET | /mwlitems | Search for Scheduled Procedure Steps on external MWL SCP |
GET | /mwlitems/count | Count Scheduled Procedure Steps on external MWL SCP |
POST | /mwlitems/import/{destination} | Import matching Scheduled Procedure Steps from external MWL SCP |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for proprietary DCM4CHEE Archive create Unified Procedure Steps for matching entities in external archive REST services. Alternatively, it is also used to query matching entities from a C-FIND SCP and then create Unified Procedure Steps for matching entities in external archive.
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/workitems | Create Workitems for external matching Studies |
POST | /studies/{studyUID}/series/workitems | Create Workitems for external matching Series of Study |
POST | /studies/{studyUID}/series/{seriesUID}/instances/workitems | Create Workitems for external matching Instances of Series |
POST | /studies/csv:{studyUIDField}/workitems/{upsTemplateUID} | Create Workitems for external Studies specified in CSV |
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{movescp}/query:{findscp}
Method | Append URL | Service Name |
---|---|---|
POST | /studies/workitems | Create Workitems for external matching Studies queries from C-FIND SCP |
POST | /studies/{studyUID}/series/workitems | Create Workitems for external matching Series of Study queries from C-FIND SCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/workitems | Create Workitems for external matching Instances of Series queries from C-FIND SCP |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI to export matching entities from local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies/{studyUID}/export/{exporterID} | Export Study |
POST | /studies/{studyUID}/series/{seriesUID}/export/{exporterID} | Export Series |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/export/{exporterID} | Export Instance |
POST | /studies/csv:{studyUIDField}/export/{exporterID} | Export Studies specified in CSV |
POST | /studies/csv:{studyUIDField}/series/csv:{seriesUIDField}/export/{exporterID} | Export Series specified in CSV |
POST | /studies/export/{exporterID} | Export matching Studies |
POST | /series/export/{exporterID} | Export matching Series |
POST | /instances/export/{exporterID} | Export matching Instances |
POST | /studies/{studyUID}/series/export/{exporterID} | Export matching Series of Study |
POST | /studies/{studyUID}/instances/export/{exporterID} | Export matching Instances of Study |
POST | /studies/{studyUID}/series/{seriesUID}/instances/export/{exporterID} | Export matching Instances of Series |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for storage verification of matching entities in local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies/stgver | Schedule Storage Verification of matching studies |
POST | /series/stgver | Schedule Storage Verification of matching series |
POST | /instances/stgver | Schedule Storage Verification of matching instances |
POST | /studies/{studyUID}/series/stgver | Schedule Storage Verification of matching series of study |
POST | /studies/{studyUID}/instances/stgver | Schedule Storage Verification of matching instances of study |
POST | /studies/{studyUID}/series/{seriesUID}/instances/stgver | Schedule Storage Verification of matching instances of series |
POST | /studies/{studyUID}/stgver | Verify Storage of study |
POST | /studies/{studyUID}/series/{seriesUID}/stgver | Verify Storage of series |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/stgver | Verify Storage of instance |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI to reject matching entities from local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Studies |
POST | /series/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Series |
POST | /instances/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Instances |
POST | /studies/{studyUID}/series/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Series of Study |
POST | /studies/{studyUID}/instances/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Instances of Study |
POST | /studies/{studyUID}/series/{seriesUID}/instances/reject/{codeValue}^{codeSchemeDesignator} | Reject matching Instances of Series |
POST | /studies/csv:{studyUIDField}/reject/{codeValue}^{codeSchemeDesignator} | Reject Studies specified in CSV |
POST | /studies/csv:{studyUIDField}/series/csv:{seriesUIDField}/reject/{codeValue}^{codeSchemeDesignator} | Reject Series specified in CSV |
POST | /studies/{studyUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Study |
POST | /studies/{studyUID}/series/{seriesUID}/reject/{codeValue}^{codeSchemeDesignator} | Reject Series |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/reject/{codeValue}^{codeSchemeDesignator} | Reject Instance |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI for other Imaging Object Change Management (IOCM) in local archive REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies/{studyUID}/copy | Copy Instances to Study |
POST | /studies/{studyUID}/move/{CodeValue}^{CodingSchemeDesignator} | Move Instances to Study |
POST | /mwlitems/{studyUID}/{spsID}/move/{CodeValue}^{CodingSchemeDesignator} | Link Instances with MWL Entry |
DELETE | /studies/{studyUID} | Delete Study Permanently |
POST | /expire/series | Apply Retention Policy |
POST | /studies/{studyUID}/patient | Move Study to Patient |
POST | /studies/{studyUID}/reimport | Re-import Study |
PUT | /studies/{studyUID}/request | Update Request Attributes of all Series of Study |
PUT | /studies/{studyUID}/series/{seriesUID}/request | Update Request Attributes of Series |
PUT | /studies/{studyUID}/expire/{expirationDate} | Update Study Expiration Date |
PUT | /studies/{studyUID}/series/{seriesUID}/expire/{expirationDate} | Update Series Expiration Date |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI to Schedule Instance Availability Notification (IAN) of matching entities to external IANSCP REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
Method | Append URL | Service Name |
---|---|---|
POST | /studies/ian/{ianscp} | Schedule IAN of matching studies to external IANSCP |
POST | /series/ian/{ianscp} | Schedule IAN of matching series to external IANSCP |
POST | /instances/ian/{ianscp} | Schedule IAN of matching instances to external IANSCP |
POST | /studies/{studyUID}/series/ian/{ianscp} | Schedule IAN of matching series of study to external IANSCP |
POST | /studies/{studyUID}/instances/ian/{ianscp} | Schedule IAN of matching instances of study to external IANSCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/ian/{ianscp} | Schedule IAN of matching instances of series to external IANSCP |
POST | /studies/{studyUID}/ian/dicom:{ianscp} | Send IAN of study to external IANSCP |
POST | /studies/{studyUID}/series/{seriesUID}/ian/dicom:{ianscp} | Send IAN of series to external IANSCP |
POST | /studies/{studyUID}/series/{seriesUID}/instances/{instance}/ian/dicom:{ianscp} | Send IAN of instance to external IANSCP |
DCM4CHEE_ARC_AET Web Service Class is used by archive UI to Schedule Storage Commitment of matching entities to external Storage Commitment SCP REST services.
Web Service Path : /dcm4chee-arc/aets/{aet}/rs
DCM4CHEE_ARC_AET_DIFF Web Service Class is used by archive UI for comparing studies between two archives functions.
Web Service Path : /dcm4chee-arc/aets/{aet}/dimse/{findSCP}/diff/{secondaryFindSCP}
Method | Append URL | Service Name |
---|---|---|
GET | /studies | Compare Studies |
GET | /studies/count | Compare Studies Count |
POST | /studies/csv:{studyUIDField} | Compare Studies specified in CSV |