Jump to

• Request
• Response

View the Zip Request Details by Zip Request ID

get

/api/restapi/document/file/zip/status/zipRequest/{zipRequestId}

Send a request to this endpoint to view the current status of the zip request provided by the zipRequestId as a path parameter.

Request

Path Parameters

• zipRequestId(required): integer(int64)
  The system-generated identifier of a zip request created.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityZipRequestDetails

Type: object

Title: ApiEntityZipRequestDetails

Show Source

• errorDetails: errorDetails
  The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.
• expiresAt: string (date-time)
  The date and time the file will be available for downloading. Once this time has passed, the file is no longer available and will need to be downloaded again.
• zipRequestId: integer (int64)
  The system-generated identifier of a zip request created.
• zipRequestStatus: string
  Allowed Values: [ "IN_QUEUE", "ZIP_CREATION_IN_PROGRESS", "ZIP_CREATION_IN_PROGRESS_WITH_WARNING", "READY_FOR_DOWNLOAD", "REQUEST_FAILED", "REQUEST_FAILED_NO_FILES", "REQUEST_EXPIRED" ]

  The status of the file zip request process.

  • IN_QUEUE: The zip requests is waiting to be processed.
  • ZIP_CREATION_IN_PROGRESS: The creation of the zip folder is in progress.
  • ZIP_CREATION_IN_PROGRESS_WITH_WARNING : The creation of the zip folder is in process, but some files could not be included.
  • READY_FOR_DOWNLOAD: The creation of the zip folder has completed and is ready for download.
  • REQUEST_FAILED: An error occured during the zip folder creation and couldn't complete the request
  • REQUEST_FAILED_NO_FILES: The zip folder could not be created. There are no files to add to the .zip folder
  • REQUEST_EXPIRED: The zip folder was created but is deleted after 24 hours.

{
    "title":"ApiEntityZipRequestDetails",
    "type":"object",
    "properties":{
        "zipRequestId":{
            "type":"integer",
            "description":"The system-generated identifier of a zip request created.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "zipRequestStatus":{
            "type":"string",
            "description":"The status of the file zip request process. <ul> <li> <b>IN_QUEUE:</b> The zip requests is waiting to be processed. </li><li><b>ZIP_CREATION_IN_PROGRESS:</b> The creation of the zip folder is in progress. </li><li><b>ZIP_CREATION_IN_PROGRESS_WITH_WARNING :</b> The creation of the zip folder is in process, but some files could not be included. </li><li><b>READY_FOR_DOWNLOAD:</b> The creation of the zip folder has completed and is ready for download. </li><li><b>REQUEST_FAILED:</b> An error occured during the zip folder creation and couldn't complete the request </li><li><b>REQUEST_FAILED_NO_FILES:</b> The zip folder could not be created.  There are no files to add to the .zip folder </li><li><b>REQUEST_EXPIRED:</b> The zip folder was created but is deleted after 24 hours. </li></ul>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IN_QUEUE",
                "ZIP_CREATION_IN_PROGRESS",
                "ZIP_CREATION_IN_PROGRESS_WITH_WARNING",
                "READY_FOR_DOWNLOAD",
                "REQUEST_FAILED",
                "REQUEST_FAILED_NO_FILES",
                "REQUEST_EXPIRED"
            ]
        },
        "expiresAt":{
            "type":"string",
            "description":"The date and time the file will be available for downloading. Once this time has passed, the file is no longer available and will need to be downloaded again.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "errorDetails":{
            "description":"The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityZipRequestErrorDetails"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : errorDetails

The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.

Match All

Show Source

• object ApiEntityZipRequestErrorDetails
  Title: ApiEntityZipRequestErrorDetails

{
    "description":"The field represents the error details in case of zip request in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityZipRequestErrorDetails"
        }
    ]
}

Nested Schema : ApiEntityZipRequestErrorDetails

Type: object

Title: ApiEntityZipRequestErrorDetails

Show Source

• cause: string
  Maximum Length: 4000

  The cause for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.
• message: string
  This field represents the error message when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.
• resolution: string
  The resolution for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityZipRequestErrorDetails",
    "type":"object",
    "properties":{
        "cause":{
            "maxLength":"4000",
            "type":"string",
            "description":"The cause for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"This field represents the error message when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resolution":{
            "type":"string",
            "description":"The resolution for the error when the zip request is in REQUEST_FAILED or REQUEST_FAILED_NO_FILES status. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested zip request detail doesn't exist, or has been deleted, or you do not have access to it.

Back to Top