Jump to

• Request
• Response

Get a list of exports to IZDL

post

/v0/izdlexport/history

Returns a list of files exported to the CDC IZ Data Lale (IZDL) during a specified date range for a jurisdiction (siteKey). The start date is inclusive and the end date is exclusive.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Request for file upload records from IZDL.

Root Schema : schema

Type: object

Request for file upload records from IZDL.

Show Source

• endDate: string (date)
  The exclusive end of the date range in UTC format.
• siteKey: string
  The unique identifier of a jurisdiction.
• startDate: string (date)
  The inclusive start of the date range in UTC format.

{
    "description":"Request for file upload records from IZDL.",
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The inclusive start of the date range in UTC format."
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The exclusive end of the date range in UTC format."
        },
        "siteKey":{
            "type":"string",
            "description":"The unique identifier of a jurisdiction."
        }
    }
}

Security

• Authorization(required): apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

Default Response

default response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ExportedFile
  Response from IZDL for file upload records.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExportedFile"
    }
}

Nested Schema : ExportedFile

Type: object

Response from IZDL for file upload records.

Show Source

• cvrsRecordCount: integer (int32)
  The number of CVRS records in the export file.
• exportFilename: string
  The name of the export file.
• exportTime: string (date-time)
  The date and time the export request was received in UTC format.
• fileIds: array fileIds
  Unique Items Required: true

  The file ID assigned when uploaded.
• fileNames: array fileNames
  Unique Items Required: true

  The name of the uploaded file.
• siteKey: string
  The unique identifier of a jurisdiction

{
    "description":"Response from IZDL for file upload records.",
    "type":"object",
    "properties":{
        "exportFilename":{
            "description":"The name of the export file.",
            "type":"string"
        },
        "siteKey":{
            "description":"The unique identifier of a jurisdiction",
            "type":"string"
        },
        "exportTime":{
            "description":"The date and time the export request was received in UTC format.",
            "type":"string",
            "format":"date-time"
        },
        "cvrsRecordCount":{
            "description":"The number of CVRS records in the export file.",
            "type":"integer",
            "format":"int32"
        },
        "fileIds":{
            "description":"The file ID assigned when uploaded.",
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "fileNames":{
            "description":"The name of the uploaded file.",
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : fileIds

Type: array

Unique Items Required: true

The file ID assigned when uploaded.

Show Source

• Array of: string

{
    "description":"The file ID assigned when uploaded.",
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : fileNames

Type: array

Unique Items Required: true

The name of the uploaded file.

Show Source

• Array of: string

{
    "description":"The name of the uploaded file.",
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top