Jump to

• Request
• Response

Asynchronous - Get status for an asynchronous CVRS upload

get

/v0/async/cvrs/jobs/{job-id}

The required in-path job-id parameter is a UUID returned by the "Asynchronous - Create records using CVRS" API. This API provides status information for the asynchronous upload with the specified job-id. The returned status includes information about upload validation, processing, and storage.

Request

Path Parameters

• job-id(required): string(uuid)
  The job ID (UUID) of an asynchronous CVRS upload operation, which is returned in the response of the initial call to ""Asynchronous - Create records using CVRS API (POST /v0/async/cvrs/jobs)".

Header Parameters

• Referer(required):
  Optional. Contains the address of the request for use in logging, analytics, and similar.

There's no request body for this operation.

Security

• Authorization(required): apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

Default Response

The default response is similar to the response of the synchronous upload calls, except that the content is dynamic and contains an additional status property. Statuses include QUEUED (successfully received), DE-QUEUED (moved to processing), VALIDATING (validation processing phase), PROCESSING (data processing; the longest phase), COMPLETED.

Body ()

Root Schema : UploadStatusResponseAsync

Type: object

Show Source

• id: string (uuid)
  The unique identifier (UUID) of the transaction. This is the job-id returned from the call to ""Asynchronous - Create records asynchronously using CVRS (POST /v0/async/cvrs/jobs)".
• status: string
  Allowed Values: [ "QUEUED", "DE-QUEUED", "VALIDATING", "PROCESSING", "COMPLETED" ]

  Contains the status of the asynchronous upload call. Statuses include QUEUED (successfully received), DE-QUEUED (moved to processing), VALIDATING (validation processing phase), PROCESSING (data processing; the longest phase), COMPLETED. As the upload continues, subsequent calls to this API return more data as it becomes available. When the upload is complete, the next call provides the storage results.
• storageResult: object storageResult
  Additional Properties Allowed: UploadStorageResult

  The UploadStorageResult object contains the processing response from the database on the results of the transaction.
• totalRecords: integer (int32)
  The number of immunization records contained in the transaction.
• validationErrors: array validationErrors
  The list of immunization records containing formatting or other errors that make the record invalid.
• validationErrorsCount: integer (int32)
  The number of validation errors in the transaction.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "description":"The unique identifier (UUID) of the transaction. This is the job-id returned from the call to \"\"Asynchronous - Create records asynchronously using CVRS (POST /v0/async/cvrs/jobs)\"."
        },
        "status":{
            "type":"string",
            "description":"Contains the status of the asynchronous upload call. Statuses include QUEUED (successfully received), DE-QUEUED (moved to processing), VALIDATING (validation processing phase), PROCESSING (data processing; the longest phase), COMPLETED. As the upload continues, subsequent calls to this API return more data as it becomes available. When the upload is complete, the next call provides the storage results.",
            "enum":[
                "QUEUED",
                "DE-QUEUED",
                "VALIDATING",
                "PROCESSING",
                "COMPLETED"
            ]
        },
        "totalRecords":{
            "type":"integer",
            "description":"The number of immunization records contained in the transaction.",
            "format":"int32"
        },
        "validationErrors":{
            "type":"array",
            "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
            "items":{
                "type":"string",
                "description":"Contains information identifying the invalid record and the validation error message."
            }
        },
        "validationErrorsCount":{
            "type":"integer",
            "description":"The number of validation errors in the transaction.",
            "format":"int32"
        },
        "storageResult":{
            "description":"The UploadStorageResult object contains the processing response from the database on the results of the transaction.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/UploadStorageResult"
            }
        }
    }
}

Nested Schema : storageResult

Type: object

Additional Properties Allowed

Show Source

• object UploadStorageResult
  The UploadStorageResult object contains the processing response on the results of the transaction.

{
    "description":"The UploadStorageResult object contains the processing response from the database on the results of the transaction.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/UploadStorageResult"
    }
}

The UploadStorageResult object contains the processing response from the database on the results of the transaction.

Nested Schema : validationErrors

Type: array

The list of immunization records containing formatting or other errors that make the record invalid.

Show Source

• Array of: string
  Contains information identifying the invalid record and the validation error message.

{
    "type":"array",
    "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
    "items":{
        "type":"string",
        "description":"Contains information identifying the invalid record and the validation error message."
    }
}

Nested Schema : UploadStorageResult

Type: object

The UploadStorageResult object contains the processing response on the results of the transaction.

Show Source

• message: string
  The text of the database processing error.
• processedCount: integer (int32)
  The number of immunization records the database processed. This number equals the number of records in the transaction minus the count of records with validation errors.
• processingErrors: array processingErrors
  The list of immunization records containing database processing errors.
• processingErrorsCount: integer (int32)
  The number of records with processing errors.
• status: string
  Allowed Values: [ "SUCCESS", "FAILED", "SKIPPED" ]

  Indicates if the database response to the record was successful (SUCCESS) or unsuccessful (FAILED), or if the database did not process the record (SKIPPED).

{
    "type":"object",
    "description":"The UploadStorageResult object contains the processing response on the results of the transaction.",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates if the database response to the record was successful (SUCCESS) or unsuccessful (FAILED), or if the database did not process the record (SKIPPED).",
            "enum":[
                "SUCCESS",
                "FAILED",
                "SKIPPED"
            ]
        },
        "message":{
            "description":"The text of the database processing error.",
            "type":"string"
        },
        "processingErrors":{
            "type":"array",
            "description":"The list of immunization records containing database processing errors.",
            "items":{
                "type":"string"
            }
        },
        "processedCount":{
            "type":"integer",
            "description":"The number of immunization records the database processed. This number equals the number of records in the transaction minus the count of records with validation errors.",
            "format":"int32"
        },
        "processingErrorsCount":{
            "type":"integer",
            "description":"The number of records with processing errors.",
            "format":"int32"
        }
    }
}

Nested Schema : processingErrors

Type: array

The list of immunization records containing database processing errors.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of immunization records containing database processing errors.",
    "items":{
        "type":"string"
    }
}

Back to Top