Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetDICOMImportJob

Get the import job properties to learn more about the job or job progress.

Note

The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.

Request Syntax


GET /getDICOMImportJob/datastore/datastoreId/job/jobId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datastoreId

The data store identifier.

Pattern: [0-9a-z]{32}

Required: Yes

jobId

The import job identifier.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [0-9a-z]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobProperties": { 
      "dataAccessRoleArn": "string",
      "datastoreId": "string",
      "endedAt": number,
      "inputS3Uri": "string",
      "jobId": "string",
      "jobName": "string",
      "jobStatus": "string",
      "message": "string",
      "outputS3Uri": "string",
      "submittedAt": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobProperties

The properties of the import job.

Type: DICOMImportJobProperties object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during processing of the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints set by the service.

HTTP Status Code: 400