Cases
This section provides information on the available case APIs. All APIs require authentication using an API key. See Generating an API Key for information on obtaining an API key.
The following are the available case endpoints:
|
Endpoints |
Description |
Request |
|---|---|---|
|
POST |
Add a new case in a domain and workgroup. |
POST /crs/api/v1/cases |
|
GET |
Retrieve case information using the case ID provided in the request. |
GET /crs/api/v1/cases/{caseId} |
|
PUT |
Update any case information using the case ID provided in the request. |
PUT /crs/api/v1/cases/{caseId} |
|
PATCH |
Update the case owners, physician address, status, or recipients using the case ID provided in the request. |
PATCH /crs/api/v1/cases/{caseId} |
|
POST |
Process the case using the case ID provided in the request. |
POST /crs/api/v1/cases/{caseId}/process |
|
POST |
Perform a QC override or modify a case. |
POST /crs/api/v1/cases/{caseId}/qc-actions |
|
GET |
Retrieve the metadata information for a case. |
GET /crs/api/v1/cases/{caseId}/custom-metadata |
|
POST |
Add metadata information to a case. |
POST /crs/api/v1/cases/{caseId}/custom-metadata |
|
PUT |
Update the metadata information associated with a case. |
PUT /crs/api/v1/cases/{caseId}/custom-metadata |
|
DELETE |
Delete the metadata information associated with a case. |
DELETE /crs/api/v1/cases/{caseId}/custom-metadata |
|
POST |
Store tags for a Case. |
POST /crs/api/v1/cases/{caseId}/tags |
|
PUT |
Update the tags for a Case. |
PUT /crs/api/v1/cases/{caseId}/tags |
|
POST |
Store Comments for a Case. |
POST /crs/api/v1/cases/{caseId}/comments |
|
GET |
Retrieve Comments for a Case. |
GET /crs/api/v1/cases/{caseId}/comments |
|
PUT |
Update Comments for a Case. |
PUT /crs/api/v1/cases/{caseId}/comments/{commentId} |
|
DELETE |
Delete Comments for a Case |
DELETE /crs/api/v1/cases/{caseId}/comments/{commentId} |
|
PUT |
Update the turn around time (TAT) for a case. |
PUT /crs/api/v1/cases/{caseId}/turn-around-time |
|
POST |
Update the status of a case when interpretation and reporting are bypassed in the test. State changes allowed: { "status": "In Progress", "subState": "READY_FOR_DELIVERY" } { "status": "In Progress", "subState": "DELIVERY_IN_PROGRESS" } { "status": "Complete", "subState": "DELIVERED" } |
POST /crs/api/v1/cases/{caseId}/status |
|
GET |
Get a File Attached to a case. |
GET /crs/api/v1/cases/{caseId}/files/{fileId} |
|
POST |
Attach a file to a case. |
POST /crs/api/v1/cases/{caseId}/files |
|
GET |
Get a List of file names attached to a case. |
GET /crs/api/v1/cases/{caseId}/files |
|
DELETE |
Delete an attachment to a case. |
DELETE /crs/api/v1/cases/{caseId}/files/{fileId} |
|
POST |
Ingest a case to the CaseLog. |
POST /crs/api/v1/cases/{caseId}/ingest/caselog |
|
DELETE |
Delete a case. |
DELETE /crs/api/v1/cases/{caseId} |
|
GET |
Retrive the status of a case. |
GET /crs/api/v1/cases/{caseId}/status |
