Response Code Description Response Format
200 Success
{
  "totalCount": 0,
  "pageNumber": 0,
  "downloads": [
   {
    "downloadFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "usage": 0,
    "subjectHandle": "string",
    "recordHandle": "string",
    "dataRecordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "dataFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "solutionsId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "filename": "string",
    "fileSize": 0,
    "fileHash": "string",
    "fileHashType": "string",
    "createDate": "2023-09-26T09:25:53.201Z",
    "updateDate": "2023-09-26T09:25:53.201Z",
    "status": "string"
   }
  ]
}

Response Parameter Description

Downloads

Field Data Type Description
TotalCount Total downloads count for the query
PageNumber Page Number
Downloads Query data downloads result

Response Parameter Description

Downloads

Field Data Type Description
DownloadFileId String (Guid) Identifies the download. An download counter that is maintained by the producer.
OrderId String (Guid)
Nullable: true
Order id of the Order from the Orders table
Usage Integer (int32) Indicates the type of records. Example Production, IntegrationTest, ParallelTest, ValidateOnly.
SubjectHandle String
Nullable: true
Subject handle could be an account number (or hopefully a less sensitive value that uniquely identifies a customer of our customer).
RecordHandle String
Nullable: true
The customer's unique ID for the individual data record that they send to us could go in the record handle field.
DataRecordId String (Guid)
Nullable: true
Id of the DataRecord which related to the Download.
DataFileId String (Guid)
Nullable: true
Id of the DataFile which related to the Download.
SolutionsId String (Guid) Id of the Solution which related to the Download.
Filename String
Nullable: true
The file name
FileSize Integer (Int64) The file size
FileHash String
Nullable: true
The file hash
FileHashType String
Nullable: true
The file hash type
CreateDate String (date-time) Download created time stamp
UpdateDate String (date-time)
Nullable: true
Download updated time stamp
Status String
Nullable: true
Recent event happened against to data file.