Temporary contents

Services such as app and data-files which may import or export larger files can opt to leverage the temporary contents service to handle these requests. Acts as a temporary file store.

Download OpenAPI spec

Endpoints

POST

/api/v1/temp-contents
GET

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

/api/v1/temp-contents/{id}/details
POST

/api/v1/temp-contents/files
PATCH

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

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

Rate limit

Tier 2 (100 requests per minute)

Query Parameters

filename string

The name of the file to upload.
ttl 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).'

minimum = 1, maximum = 259200

Request Body

Required

The file content (binary) to upload.

application/octet-stream string

format = "binary"

Responses

201

Created

400

Bad Request.

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/temp-contents

import { createQlikApi } from '@qlik/api'
import { readFileSync } from 'node:fs'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tempContents.uploadTempFile(
  {},
  new Uint8Array(readFileSync('<file-path>')),
)

# qlik-cli has not implemented support for POST /api/v1/temp-contents yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/temp-contents" \
-X POST \
-H "Content-type: application/octet-stream" \
-H "Authorization: Bearer <access_token>" \
--data-binary' \
          '"@/path/to/file"

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

Rate limit

Tier 1 (1000 requests per minute)

Header Parameters

Range 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.

Query Parameters

inline string

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

Path Parameters

id string

Required

The temporary contents ID.

Responses

200

Success

*/* object

204

No Content, resource is incomplete.

206

Success

*/* object

400

Bad Request

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

404

Not Found

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

410

Gone

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

416

Range Not Satisfiable.

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tempContents.downloadTempFile(
  'string',
  {},
)

# qlik-cli has not implemented support for GET /api/v1/temp-contents/{id} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/temp-contents/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{}

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

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

id string

Required

The temporary contents ID.

Responses

200

Success

application/json object
Show application/json properties
- ID string
  
  Identifier
- Name string
  
  File name of the file uploaded by the user.
- Size string
  
  Size of resource (in bytes).
- Expires string
  
  Datetime-stamp when the resource expired (in UTC).
- CreatedAt string
  
  Datetime-stamp when the resource was created (in UTC).
- CreatorID string
  
  Identifier for the subject / resource creator.
- UpdatedAt string
  
  Datetime-stamp when the resource was updated (in UTC).
- TTLSeconds integer
  
  Time-to-live in seconds.

204

No Content, resource is incomplete.

400

Bad Request

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

404

Not Found

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

410

Gone

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.tempContents.getTempFileDetails(
  'string',
)

# qlik-cli has not implemented support for GET /api/v1/temp-contents/{id}/details yet.

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

Example Response

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

Create a new upload resource (tus protocol creation extension POST request). See tus.io for details.

Facts

Rate limit

Special (800 requests per minute)

Header Parameters

Tus-Resumable string

Required

The version of the tus protocol used.
Upload-Length integer

Required

The size of the entire upload in bytes.

minimum = 0, format = int64
Upload-Metadata 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

201

Created

400

Bad Request

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

412

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

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

413

Request Entity Too Large

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

POST /api/v1/temp-contents/files

// qlik-api has not implemented support for `POST /api/v1/temp-contents/files` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/temp-contents/files',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

# qlik-cli has not implemented support for POST /api/v1/temp-contents/files yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/temp-contents/files" \
-X POST \
-H "Tus-Resumable: string" \
-H "Upload-Length: 0" \
-H "Authorization: Bearer <access_token>"

Apply bytes contained in the message at a given offset (tus protocol PATCH request). 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

Rate limit

Special (800 requests per minute)

Header Parameters

Content-Type string

Required

Standard HTTP Content-Type header.
Tus-Resumable string

Required

The version of the tus protocol used.
Upload-Offset integer

Required

The byte offset within the upload.

minimum = 0, format = int64
Content-Length integer

Standard HTTP Content-Length header.

minimum = 0, format = int64

Path Parameters

id string

Required

The ID used to uniquely identify the upload.

Request Body

Required

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

application/offset+octet-stream string

format = "binary"

Responses

204

No Content. Patch successfully applied to upload.

400

Bad Request

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

404

Not Found. Non-existent upload resource.

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

409

Conflict. Upload offsets do not match.

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

410

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

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

412

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

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

415

Unsupported Media Type

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

423

Locked. Concurrent access is not allowed.

application/json object

An array of Error objects.
Show application/json properties
- errors array of objects
  
  An Error object.
  
  Show errors properties
  
  code string
  
  Required
  
  The API error code.
  
  meta object
  
  Additional properties and information regarding the issue.
  
  Show meta properties
  
  locale string
  
  Locale
  
  errorType string
  
  The error type.
  
  sourceErrors string
  
  The source errors (stack trace).
  
  title string
  
  Required
  
  Title of the type of API Error.
  
  detail string
  
  A human-readable problem description of the issue.
- traceId string
  
  A way to trace the source of the error.

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

// qlik-api has not implemented support for `PATCH /api/v1/temp-contents/files/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/temp-contents/files/{id}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

# qlik-cli has not implemented support for PATCH /api/v1/temp-contents/files/{id} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/temp-contents/files/{id}" \
-X PATCH \
-H "Content-Type: string" \
-H "Tus-Resumable: string" \
-H "Upload-Offset: 0" \
-H "Content-type: application/offset+octet-stream" \
-H "Authorization: Bearer <access_token>" \
-d '"string"'

Temporary contents

Endpoints

Upload a file

Facts

Query Parameters

Request Body

Responses

201

400

Download a file

Facts

Header Parameters

Query Parameters

Path Parameters

Responses

200

204

206

400

404

410

416

Example Response

Retrieve file details

Facts

Path Parameters

Responses

200

204

400

404

410

Example Response

Create a new upload resource (tus)

Facts

Header Parameters

Responses

201

400

412

413

Apply bytes at a given offset (tus)

Facts

Header Parameters

Path Parameters

Request Body

Responses

204

400

404

409

410

412

415

423