Files

List of All Resources for Specific URL Path

Returns list of all resources which are available at the specific url path.

SecurityapiKey
Request
query Parameters
limit
integer <int32> >= 1
Default: 300

Allowed maximum elements.

Example: limit=200
startAfter
string

Continuation token. Encoded s3 path from which listing resources should be started.

Example: startAfter=1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u
url
string

Path of requested directory for which resources should be listed.

Example: url=requestedDirectory/ or requestedDirectory/otherDirectory
Responses
200

OK

get/files/resources
Request samples
Response samples
application/json
{
  • "startAfter": "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u",
  • "limit": "100",
  • "nextStartAfter": "1XUzntG%2FKE%2B5IN08GrJQgKin9OblLzlorehkIs1xlj46yyCktx%2FsZrQeTh2FvBKOLLB%2Fu%2F32Ow%2BRJfLUjMqi6gGGjsAQRPZ4u",
  • "files": [
    ]
}

Request a File Download

Download file from CDQ Cloud.

SecurityapiKey
Request
Request Body schema: application/json
required
downloadLinkAge
integer <int64>
Default: 0

Number of milliseconds the download link is active.

Example: "0"
url
required
string

ID of the file.

Example: "customer-upload/user/file.xlsx"
Responses
200

OK

post/files/download
Request samples
application/json
{
  • "url": "customer-upload/user/file.xlsx",
  • "downloadLinkAge": "0"
}
Response samples
application/json
{}

Request file upload

Create a file in the file storage using the url provided. Maximum allowed file size is 5GB.

SecurityapiKey
Request
Request Body schema: application/json
required
url
required
string

File name which will be uploaded in customer-uploads/ directory.

Example: "dq-chart.png or requestedDirectory/dq-chart.png"
Responses
200

OK

post/files/upload
Request samples
application/json
{
  • "url": "dq-chart.png or requestedDirectory/dq-chart.png"
}
Response samples
application/json
{}

Request files delete

Delete files in the customer-uploads directory using the provided urls.

SecurityapiKey
Request
query Parameters
url
required
Array of strings non-empty

Url of the file to delete.

Example: url=dq-chart.png or requestedDirectory/dq-chart.png
Responses
200

OK

delete/files
Request samples
Response samples
application/json
{
  • "results": [
    ]
}