Jump to

• Request
• Response

Download Files

post

/export/downloadFiles

Download Files

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Downloads one or more files.

Root Schema : DownloadFiles

Type: object

Title: DownloadFiles

DownloadFiles Entity

Show Source

• EndDate: string (date-time)
  The end date of the file download.
• JobName: array JobName
  Specifies the job name.
• JobType: string
  Specifies the job type.
• StartDate: string (date-time)
  The start date of the file download.

{
    "title":"DownloadFiles",
    "type":"object",
    "properties":{
        "JobType":{
            "type":"string",
            "description":"Specifies the job type."
        },
        "JobName":{
            "type":"array",
            "description":"Specifies the job name.",
            "items":{
                "type":"string",
                "description":"Specifies the job name."
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the file download.",
            "format":"date-time"
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the file download.",
            "format":"date-time"
        }
    },
    "description":"DownloadFiles Entity"
}

Nested Schema : JobName

Type: array

Specifies the job name.

Show Source

• Array of: string
  Specifies the job name.

{
    "type":"array",
    "description":"Specifies the job name.",
    "items":{
        "type":"string",
        "description":"Specifies the job name."
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK.

Body ()

Root Schema : DownloadFilesResponse

Type: object

Title: DownloadFilesResponse

DownloadFilesResponse Entity

Show Source

• NumberOfFiles: integer (int32)

{
    "title":"DownloadFilesResponse",
    "type":"object",
    "properties":{
        "NumberOfFiles":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"DownloadFilesResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top