Endpoints

Skip to section
POST/v1/temp-contents
GET/v1/temp-contents/{id}
GET/v1/temp-contents/{id}/details
POST/v1/temp-contents/files
PATCH/v1/temp-contents/files/{id}

Uploads a temporary content file

manage

This endpoint is used to upload a file as a temporary content resource. It returns a 201 Created with a location header that contains the location of the created resource. If filename or TTL is not properly set, a 400 Bad request is returned. For internal issues, a 500 Internal Server Error is returned.

Facts POST /v1/temp-contents

Rate limit
Tier 2 (100 requests per minute)

Query Parameters POST /v1/temp-contents

filename
optional
string

The name of the file to upload.

ttl
optional, minimum=1, maximum=259200
integer

The TTL parameter is used to define the time-to-live for the content resource in seconds. It defaults to one hour (3600) if no input is provided. Max TTL is 259200 (3 days).'

Request Body POST /v1/temp-contents

optional, application/octet-stream
string<binary>

The file content (binary) to upload.

Responses POST /v1/temp-contents

201
optional
object

Created

400
optional, application/json

Bad Request.

POST/v1/temp-contents

curl "https://your-tenant.us.qlikcloud.com/api/v1/temp-contents" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/octet-stream" \
 --data-binary "@/path/to/file"

Download a temporary content file

manage

This endpoint is used to retrieve a temporary content file. It returns a valid (200 OK) in case the file exists and the user is authorized to view the contents. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met.

Facts GET /v1/temp-contents/{id}

Rate limit
Tier 1 (1000 requests per minute)

Header Parameters GET /v1/temp-contents/{id}

Range
optional
string

Set to unit=start-end (for example, bytes=0-100) where unit = bytes (only supported unit), and start/end is a positive integer, where start <= end. Will also handle "start-" and "-end as described in https://tools.ietf.org/html/rfc7233".

Path Parameters GET /v1/temp-contents/{id}

id
string

The temporary contents ID.

Query Parameters GET /v1/temp-contents/{id}

inline
optional
string

Set to "1" to download the file in inline mode. Useful for displaying a preview of the file in a browser.

Responses GET /v1/temp-contents/{id}

200
optional, */*
object

Success

204
optional
object

No Content, resource is incomplete.

206
optional, */*
object

Success

400
optional, application/json

Bad Request

404
optional, application/json

Not Found

410
optional, application/json

Gone

416
optional, application/json

Range Not Satisfiable.

GET/v1/temp-contents/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/temp-contents/{id}" \
 -H "Authorization: Bearer <API-key>"

Retrieve temporary content details

manage

This endpoint is used to retrieve a summary of the metadata associated with a temporary content resource. It returns a 200 OK with a model if the temporary resource is valid. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met.

Facts GET /v1/temp-contents/{id}/details

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/temp-contents/{id}/details

id
string

The temporary contents ID.

Responses GET /v1/temp-contents/{id}/details

200
optional, application/json

Success

204
optional
object

No Content, resource is incomplete.

400
optional, application/json

Bad Request

404
optional, application/json

Not Found

410
optional, application/json

Gone

GET/v1/temp-contents/{id}/details

curl "https://your-tenant.us.qlikcloud.com/api/v1/temp-contents/{id}/details" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/temp-contents/{id}/details

{
  "ID": "string",
  "Name": "string",
  "Size": "string",
  "Expires": "string",
  "CreatedAt": "string",
  "CreatorID": "string",
  "UpdatedAt": "string",
  "TTLSeconds": 0
}

Creates a new upload resource (tus protocol `creation` extension POST request)

manage

Request used to create a new upload resource. See tus.io for details.

Facts POST /v1/temp-contents/files

Rate limit
Tier 2 (100 requests per minute)

Header Parameters POST /v1/temp-contents/files

Tus-Resumable
string

The version of the tus protocol used.

Upload-Length
integer<int64>

The size of the entire upload in bytes.

Upload-Metadata
optional
string

One or more comma-separated key-value pairs. The key and value must be separated by a space. The key should be ASCII encoded, and the value must be Base64 encoded. All keys must be unique. See tus.io for details.

The following keys are used; any other keys are ignored.

  • filename - the name of the file.
  • ttl - the time-to-live for the uploaded file in seconds. Note that the time is counted from the start of the upload creation, not when the upload has finished. The server will keep the file available for access for this period of time. The server may then delete it. The time defaults to one hour (3600) if not provided. The maximum value is 259200 (3 days).'

Responses POST /v1/temp-contents/files

201
optional
object

Created

400
optional, application/json

Bad Request

412
optional, application/json

Precondition Failed. tus protocol version not supported by the server.

413
optional, application/json

Request Entity Too Large

POST/v1/temp-contents/files

curl "https://your-tenant.us.qlikcloud.com/api/v1/temp-contents/files" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Apply bytes contained in the message at a given offset (tus protocol PATCH request)

manage

Request used to apply the bytes contained in the message at a given offset. Note that the tus server only accepts that the Content-Type response header is set to "application/offset+octet-stream". See tus.io for details.

Note that the server may return 423 Locked on this request. This happens if the client attempts to perform concurrent access to the resource, for example, if attempting to do a HEAD request during an ongoing PATCH request. It can also occur in situations where the connection is unexpectedly dropped between the client and the server and the client attempts to make a new request when the server is still busy processing the upload. When this happens, the client shall, after some period of time, try to resume the upload again.

Facts PATCH /v1/temp-contents/files/{id}

Rate limit
Tier 2 (100 requests per minute)

Header Parameters PATCH /v1/temp-contents/files/{id}

Content-Type
string

Standard HTTP Content-Type header.

Tus-Resumable
string

The version of the tus protocol used.

Upload-Offset
integer<int64>

The byte offset within the upload.

Content-Length
optional
integer<int64>

Standard HTTP Content-Length header.

Path Parameters PATCH /v1/temp-contents/files/{id}

id
string

The ID used to uniquely identify the upload.

Request Body PATCH /v1/temp-contents/files/{id}

optional, application/offset+octet-stream
string<binary>

The patch content (binary, either a complete or a partial file) to upload.

Responses PATCH /v1/temp-contents/files/{id}

204
optional
object

No Content. Patch successfully applied to upload.

400
optional, application/json

Bad Request

404
optional, application/json

Not Found. Non-existent upload resource.

409
optional, application/json

Conflict. Upload offsets do not match.

410
optional, application/json

Gone. The upload resource no longer exists (could have expired).

412
optional, application/json

Precondition Failed. tus protocol version not supported by the server.

415
optional, application/json

Unsupported Media Type

423
optional, application/json

Locked. Concurrent access is not allowed.

PATCH/v1/temp-contents/files/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/temp-contents/files/{id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/offset+octet-stream"

AcceptRanges

string

Standard HTTP Accept-Ranges header.

ContentDisposition

string

Standard HTTP Content-Disposition header.

ContentLength

integer

Standard HTTP Content-Length header.

ContentRange

string

Standard HTTP Content-Range header.

Location

string

Standard HTTP Location header. When used with tus POST (creation) requests, the server uses this to indicate location at which you can do HEAD and PATCH requests.

TusResumable

string

The version of the tus protocol used.

TusVersion

string

A comma-separated list of tus protocol versions supported by the server.

detailResponse

object

Properties

ID
optional
string

Identifier

Name
optional
string

File name of the file uploaded by the user.

Size
optional
string

Size of resource (in bytes).

Expires
optional
string

Datetime-stamp when the resource expired (in UTC).

CreatedAt
optional
string

Datetime-stamp when the resource was created (in UTC).

CreatorID
optional
string

Identifier for the subject / resource creator.

UpdatedAt
optional
string

Datetime-stamp when the resource was updated (in UTC).

TTLSeconds
optional
integer

Time-to-live in seconds.

Error

object

An Error object.

Properties

code
string

The API error code.

meta
optional

Additional properties and information regarding the issue.

title
string

Title of the type of API Error.

detail
optional
string

A human-readable problem description of the issue.

Errors

An array of Error objects.

Properties

errors
optional

No description

traceId
optional
string

A way to trace the source of the error.

v0.574.0
Was this page helpful?