Collections

Collections provide the framework to catalog various content a user has access to using tags, public and private collections, and favorites.

Download OpenAPI spec

Endpoints

GET

/api/v1/collections
POST

/api/v1/collections
GET

/api/v1/collections/{collectionId}
PATCH

/api/v1/collections/{collectionId}
PUT

/api/v1/collections/{collectionId}
DELETE

/api/v1/collections/{collectionId}
GET

/api/v1/collections/{collectionId}/items
POST

/api/v1/collections/{collectionId}/items
GET

/api/v1/collections/{collectionId}/items/{itemId}
DELETE

/api/v1/collections/{collectionId}/items/{itemId}
GET

/api/v1/collections/favorites

Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with /v1/collections/favorites.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

creatorId string

The case-sensitive string used to search for a resource by creatorId.
id string

The collection's unique identifier.
includeItems string

Includes the list of items belonging to the collections. Supported parameters are 'limit', 'sort' and 'resourceType'. Supported formats are json formatted string or deep object style using square brackets.
limit integer

The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

minimum = 1, maximum = 100, default = 10, default = 10
name string

The case-sensitive string used to search for a collection by name.
next string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.
prev string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.
query string

The case-insensitive string used to search for a resource by name or description.
sort string

The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

Can be one of: "+createdAt""-createdAt""+name""-name""+updatedAt""-updatedAt"
type string

The case-sensitive string used to filter for a collection by type. Retrieve private collections with private, public collections with publicgoverned, and tags with public.

Can be one of: "private""public""publicgoverned"
types array of strings

A comma-separated case-sensitive string used to filter by multiple types.

Values may be any of: "private""public""publicgoverned"

Responses

200

OK response.

application/json object

ListCollectionsResponseBody result type
Show application/json properties
- data array of objects
  
  Required
  
  A collection.
  
  Show data properties
  
  id string
  
  Required
  
  The collection's unique identifier.
  
  full boolean
  
  States if a collection has reached its items limit or not
  
  meta object
  
  Collection metadata and computed fields.
  
  Show meta properties
  
  items object
  
  Multiple items.
  
  Show items properties
  
  data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true
  
  links object
  
  Required
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  collection object
  
  Show collection properties
  
  href string
  
  format = "uri"
  
  name string
  
  Required
  
  minLength = 1
  
  type string
  
  Required
  
  Can be one of: "private""public""favorite""publicgoverned"
  
  links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  items object
  
  Show items properties
  
  href string
  
  format = "uri"
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the collection. This property is populated by using JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the collection was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
  
  itemCount integer
  
  Required
  
  The number of items that have been added to the collection that the user has access to.
  
  format = int64
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the collection was last updated.
  
  format = "date-time"
  
  updaterId string
  
  The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
  
  description string
- links object
  
  Required
  
  Show links properties
  
  item object
  
  Show item properties
  
  href string
  
  format = "uri"
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

GET /api/v1/collections

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.getCollections({})

qlik collection ls

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

Example Response

{
  "data": [
    {
      "id": "string",
      "full": true,
      "meta": {
        "items": {
          "data": [
            {
              "id": "string",
              "meta": {
                "tags": [
                  {
                    "id": "string",
                    "name": "string"
                  }
                ],
                "actions": [
                  "string"
                ],
                "collections": [
                  {
                    "id": "string",
                    "name": "string"
                  }
                ],
                "isFavorited": true
              },
              "name": "string",
              "links": {
                "open": {
                  "href": "string"
                },
                "self": {
                  "href": "string"
                },
                "qvPlugin": {
                  "href": "string"
                },
                "thumbnail": {
                  "href": "string"
                },
                "collections": {
                  "href": "string"
                }
              },
              "actions": [
                "string"
              ],
              "ownerId": "string",
              "spaceId": "string",
              "tenantId": "string",
              "createdAt": "2018-10-30T07:06:22Z",
              "creatorId": "string",
              "itemViews": {
                "week": [
                  {
                    "start": "2018-10-30T07:06:22Z",
                    "total": 42,
                    "unique": 42
                  }
                ],
                "total": 42,
                "trend": -4.2,
                "unique": 42,
                "usedBy": 42
              },
              "updatedAt": "2018-10-30T07:06:22Z",
              "updaterId": "string",
              "resourceId": "string",
              "description": "string",
              "isFavorited": true,
              "thumbnailId": "string",
              "resourceLink": "string",
              "resourceSize": {
                "appFile": 42,
                "appMemory": 42
              },
              "resourceType": "app",
              "collectionIds": [
                "string"
              ],
              "resourceSubType": "string",
              "resourceCreatedAt": "2018-10-30T07:06:22Z",
              "resourceUpdatedAt": "2018-10-30T07:06:22Z",
              "resourceAttributes": {},
              "resourceReloadStatus": "string",
              "resourceReloadEndTime": "2018-10-30T07:06:22Z",
              "resourceCustomAttributes": {}
            }
          ],
          "links": {
            "next": {
              "href": "string"
            },
            "prev": {
              "href": "string"
            },
            "self": {
              "href": "string"
            },
            "collection": {
              "href": "string"
            }
          }
        }
      },
      "name": "string",
      "type": "private",
      "links": {
        "self": {
          "href": "string"
        },
        "items": {
          "href": "string"
        }
      },
      "tenantId": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "creatorId": "string",
      "itemCount": 42,
      "updatedAt": "2018-10-30T07:06:22Z",
      "updaterId": "string",
      "description": "string"
    }
  ],
  "links": {
    "item": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates and returns a new collection. Collections of type public (shown as tags in the user interface) must have unique names. Other collection types can reuse names.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

application/json object
Show application/json properties
- name string
  
  Required
  
  For public collections (tags), if name already exists in the tenant as a public collection, this call will fail with a 409 response.
  
  minLength = 1
- type string
  
  Required
  
  Can be one of: "private""public""publicgoverned"
- description string

Responses

201

Created response.

application/json object

A collection.
Show application/json properties
- id string
  
  Required
  
  The collection's unique identifier.
- full boolean
  
  States if a collection has reached its items limit or not
- meta object
  
  Collection metadata and computed fields.
  
  Show meta properties
  
  items object
  
  Multiple items.
  
  Show items properties
  
  data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true
  
  links object
  
  Required
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  collection object
  
  Show collection properties
  
  href string
  
  format = "uri"
- name string
  
  Required
  
  minLength = 1
- type string
  
  Required
  
  Can be one of: "private""public""favorite""publicgoverned"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  items object
  
  Show items properties
  
  href string
  
  format = "uri"
- tenantId string
  
  Required
  
  The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the collection was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCount integer
  
  Required
  
  The number of items that have been added to the collection that the user has access to.
  
  format = int64
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the collection was last updated.
  
  format = "date-time"
- updaterId string
  
  The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- description string

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

403

Forbidden response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

409

Conflict response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

POST /api/v1/collections

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.createCollection({
  description: 'string',
  name: 'string',
  type: 'private',
})

qlik collection create \
  --name 'string' \
  --type 'private'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","type":"private","description":"string"}'

Example Response

{
  "id": "string",
  "full": true,
  "meta": {
    "items": {
      "data": [
        {
          "id": "string",
          "meta": {
            "tags": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "actions": [
              "string"
            ],
            "collections": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "isFavorited": true
          },
          "name": "string",
          "links": {
            "open": {
              "href": "string"
            },
            "self": {
              "href": "string"
            },
            "qvPlugin": {
              "href": "string"
            },
            "thumbnail": {
              "href": "string"
            },
            "collections": {
              "href": "string"
            }
          },
          "actions": [
            "string"
          ],
          "ownerId": "string",
          "spaceId": "string",
          "tenantId": "string",
          "createdAt": "2018-10-30T07:06:22Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2018-10-30T07:06:22Z",
                "total": 42,
                "unique": 42
              }
            ],
            "total": 42,
            "trend": -4.2,
            "unique": 42,
            "usedBy": 42
          },
          "updatedAt": "2018-10-30T07:06:22Z",
          "updaterId": "string",
          "resourceId": "string",
          "description": "string",
          "isFavorited": true,
          "thumbnailId": "string",
          "resourceLink": "string",
          "resourceSize": {
            "appFile": 42,
            "appMemory": 42
          },
          "resourceType": "app",
          "collectionIds": [
            "string"
          ],
          "resourceSubType": "string",
          "resourceCreatedAt": "2018-10-30T07:06:22Z",
          "resourceUpdatedAt": "2018-10-30T07:06:22Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2018-10-30T07:06:22Z",
          "resourceCustomAttributes": {}
        }
      ],
      "links": {
        "next": {
          "href": "string"
        },
        "prev": {
          "href": "string"
        },
        "self": {
          "href": "string"
        },
        "collection": {
          "href": "string"
        }
      }
    }
  },
  "name": "string",
  "type": "private",
  "links": {
    "self": {
      "href": "string"
    },
    "items": {
      "href": "string"
    }
  },
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemCount": 42,
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "description": "string"
}

Finds and returns a collection.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.

Responses

200

OK response.

application/json object

A collection.
Show application/json properties
- id string
  
  Required
  
  The collection's unique identifier.
- full boolean
  
  States if a collection has reached its items limit or not
- meta object
  
  Collection metadata and computed fields.
  
  Show meta properties
  
  items object
  
  Multiple items.
  
  Show items properties
  
  data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true
  
  links object
  
  Required
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  collection object
  
  Show collection properties
  
  href string
  
  format = "uri"
- name string
  
  Required
  
  minLength = 1
- type string
  
  Required
  
  Can be one of: "private""public""favorite""publicgoverned"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  items object
  
  Show items properties
  
  href string
  
  format = "uri"
- tenantId string
  
  Required
  
  The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the collection was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCount integer
  
  Required
  
  The number of items that have been added to the collection that the user has access to.
  
  format = int64
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the collection was last updated.
  
  format = "date-time"
- updaterId string
  
  The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- description string

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

GET /api/v1/collections/{collectionId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.getCollection('string')

qlik collection get 'string'

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

Example Response

{
  "id": "string",
  "full": true,
  "meta": {
    "items": {
      "data": [
        {
          "id": "string",
          "meta": {
            "tags": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "actions": [
              "string"
            ],
            "collections": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "isFavorited": true
          },
          "name": "string",
          "links": {
            "open": {
              "href": "string"
            },
            "self": {
              "href": "string"
            },
            "qvPlugin": {
              "href": "string"
            },
            "thumbnail": {
              "href": "string"
            },
            "collections": {
              "href": "string"
            }
          },
          "actions": [
            "string"
          ],
          "ownerId": "string",
          "spaceId": "string",
          "tenantId": "string",
          "createdAt": "2018-10-30T07:06:22Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2018-10-30T07:06:22Z",
                "total": 42,
                "unique": 42
              }
            ],
            "total": 42,
            "trend": -4.2,
            "unique": 42,
            "usedBy": 42
          },
          "updatedAt": "2018-10-30T07:06:22Z",
          "updaterId": "string",
          "resourceId": "string",
          "description": "string",
          "isFavorited": true,
          "thumbnailId": "string",
          "resourceLink": "string",
          "resourceSize": {
            "appFile": 42,
            "appMemory": 42
          },
          "resourceType": "app",
          "collectionIds": [
            "string"
          ],
          "resourceSubType": "string",
          "resourceCreatedAt": "2018-10-30T07:06:22Z",
          "resourceUpdatedAt": "2018-10-30T07:06:22Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2018-10-30T07:06:22Z",
          "resourceCustomAttributes": {}
        }
      ],
      "links": {
        "next": {
          "href": "string"
        },
        "prev": {
          "href": "string"
        },
        "self": {
          "href": "string"
        },
        "collection": {
          "href": "string"
        }
      }
    }
  },
  "name": "string",
  "type": "private",
  "links": {
    "self": {
      "href": "string"
    },
    "items": {
      "href": "string"
    }
  },
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemCount": 42,
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "description": "string"
}

Updates the name, description, or type fields provided in the patch body. Can be used to publish a private collection as a publicgoverned collection by patching /type with publicgoverned once the collection contains at least 1 item. Can also be used to return a publicgoverned collection to private. Cannot be used to change between public (tag) and private / publicgoverned (collection).

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.

Request Body

Required

application/json array of objects

A JSONPatch document as defined by RFC 6902.
Show application/json properties
- op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- path string
  
  Required
  
  Field of collection to be patched.
  
  Can be one of: "/name""/description""/type"
- value string
  
  Required
  
  The value to be used within the operations.
  
  name: The name of the collection. Must not be "".
  
  description: The description of the collection. Empty string "" is allowed.
  
  type: The type of the collection. Via this path the collection type can be toggled between "private" and "publicgoverned".

Responses

200

OK response.

application/json object

A collection.
Show application/json properties
- id string
  
  Required
  
  The collection's unique identifier.
- full boolean
  
  States if a collection has reached its items limit or not
- meta object
  
  Collection metadata and computed fields.
  
  Show meta properties
  
  items object
  
  Multiple items.
  
  Show items properties
  
  data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true
  
  links object
  
  Required
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  collection object
  
  Show collection properties
  
  href string
  
  format = "uri"
- name string
  
  Required
  
  minLength = 1
- type string
  
  Required
  
  Can be one of: "private""public""favorite""publicgoverned"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  items object
  
  Show items properties
  
  href string
  
  format = "uri"
- tenantId string
  
  Required
  
  The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the collection was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCount integer
  
  Required
  
  The number of items that have been added to the collection that the user has access to.
  
  format = int64
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the collection was last updated.
  
  format = "date-time"
- updaterId string
  
  The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- description string

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

409

Conflict response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

PATCH /api/v1/collections/{collectionId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.patchCollection('string', [
  {
    op: 'replace',
    path: '/name',
    value: 'string',
  },
])

qlik collection patch 'string' \
  --op 'replace' \
  --path '/name' \
  --value 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"string"}]'

Example Response

{
  "id": "string",
  "full": true,
  "meta": {
    "items": {
      "data": [
        {
          "id": "string",
          "meta": {
            "tags": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "actions": [
              "string"
            ],
            "collections": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "isFavorited": true
          },
          "name": "string",
          "links": {
            "open": {
              "href": "string"
            },
            "self": {
              "href": "string"
            },
            "qvPlugin": {
              "href": "string"
            },
            "thumbnail": {
              "href": "string"
            },
            "collections": {
              "href": "string"
            }
          },
          "actions": [
            "string"
          ],
          "ownerId": "string",
          "spaceId": "string",
          "tenantId": "string",
          "createdAt": "2018-10-30T07:06:22Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2018-10-30T07:06:22Z",
                "total": 42,
                "unique": 42
              }
            ],
            "total": 42,
            "trend": -4.2,
            "unique": 42,
            "usedBy": 42
          },
          "updatedAt": "2018-10-30T07:06:22Z",
          "updaterId": "string",
          "resourceId": "string",
          "description": "string",
          "isFavorited": true,
          "thumbnailId": "string",
          "resourceLink": "string",
          "resourceSize": {
            "appFile": 42,
            "appMemory": 42
          },
          "resourceType": "app",
          "collectionIds": [
            "string"
          ],
          "resourceSubType": "string",
          "resourceCreatedAt": "2018-10-30T07:06:22Z",
          "resourceUpdatedAt": "2018-10-30T07:06:22Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2018-10-30T07:06:22Z",
          "resourceCustomAttributes": {}
        }
      ],
      "links": {
        "next": {
          "href": "string"
        },
        "prev": {
          "href": "string"
        },
        "self": {
          "href": "string"
        },
        "collection": {
          "href": "string"
        }
      }
    }
  },
  "name": "string",
  "type": "private",
  "links": {
    "self": {
      "href": "string"
    },
    "items": {
      "href": "string"
    }
  },
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemCount": 42,
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "description": "string"
}

Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.

Request Body

Required

application/json object
Show application/json properties
- name string
  
  minLength = 1
- description string

Responses

200

OK response.

application/json object

A collection.
Show application/json properties
- id string
  
  Required
  
  The collection's unique identifier.
- full boolean
  
  States if a collection has reached its items limit or not
- meta object
  
  Collection metadata and computed fields.
  
  Show meta properties
  
  items object
  
  Multiple items.
  
  Show items properties
  
  data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true
  
  links object
  
  Required
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  collection object
  
  Show collection properties
  
  href string
  
  format = "uri"
- name string
  
  Required
  
  minLength = 1
- type string
  
  Required
  
  Can be one of: "private""public""favorite""publicgoverned"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  items object
  
  Show items properties
  
  href string
  
  format = "uri"
- tenantId string
  
  Required
  
  The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the collection was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCount integer
  
  Required
  
  The number of items that have been added to the collection that the user has access to.
  
  format = int64
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the collection was last updated.
  
  format = "date-time"
- updaterId string
  
  The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- description string

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

409

Conflict response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

PUT /api/v1/collections/{collectionId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.updateCollection(
  'string',
  { description: 'string', name: 'string' },
)

qlik collection update 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","description":"string"}'

Example Response

{
  "id": "string",
  "full": true,
  "meta": {
    "items": {
      "data": [
        {
          "id": "string",
          "meta": {
            "tags": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "actions": [
              "string"
            ],
            "collections": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "isFavorited": true
          },
          "name": "string",
          "links": {
            "open": {
              "href": "string"
            },
            "self": {
              "href": "string"
            },
            "qvPlugin": {
              "href": "string"
            },
            "thumbnail": {
              "href": "string"
            },
            "collections": {
              "href": "string"
            }
          },
          "actions": [
            "string"
          ],
          "ownerId": "string",
          "spaceId": "string",
          "tenantId": "string",
          "createdAt": "2018-10-30T07:06:22Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2018-10-30T07:06:22Z",
                "total": 42,
                "unique": 42
              }
            ],
            "total": 42,
            "trend": -4.2,
            "unique": 42,
            "usedBy": 42
          },
          "updatedAt": "2018-10-30T07:06:22Z",
          "updaterId": "string",
          "resourceId": "string",
          "description": "string",
          "isFavorited": true,
          "thumbnailId": "string",
          "resourceLink": "string",
          "resourceSize": {
            "appFile": 42,
            "appMemory": 42
          },
          "resourceType": "app",
          "collectionIds": [
            "string"
          ],
          "resourceSubType": "string",
          "resourceCreatedAt": "2018-10-30T07:06:22Z",
          "resourceUpdatedAt": "2018-10-30T07:06:22Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2018-10-30T07:06:22Z",
          "resourceCustomAttributes": {}
        }
      ],
      "links": {
        "next": {
          "href": "string"
        },
        "prev": {
          "href": "string"
        },
        "self": {
          "href": "string"
        },
        "collection": {
          "href": "string"
        }
      }
    }
  },
  "name": "string",
  "type": "private",
  "links": {
    "self": {
      "href": "string"
    },
    "items": {
      "href": "string"
    }
  },
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemCount": 42,
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "description": "string"
}

Deletes a collection and removes all items from the collection.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.

Responses

204

No Content response.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

DELETE /api/v1/collections/{collectionId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.deleteCollection('string')

qlik collection rm 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Retrieves items from a collection that the user has access to.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

limit integer

The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

minimum = 1, maximum = 100, default = 10, default = 10
name string

The case-insensitive string used to search for a resource by name.
next string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.
prev string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.
query string

The case-insensitive string used to search for a resource by name or description.
resourceId string

The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
resourceLink string

The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.

format = "uri"
resourceType string

The case-sensitive string used to search for an item by resourceType.

Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
sort string

The property of a resource to sort on (default sort is +createdAt). The supported properties are createdAt, updatedAt, and name. A property must be prefixed by + or - to indicate ascending or descending sort order respectively.

Can be one of: "+createdAt""-createdAt""+name""-name""+updatedAt""-updatedAt"
spaceId string

The space's unique identifier (supports 'personal' as spaceId).
shared boolean Deprecated

Whether or not to return items in a shared space.
noActions boolean

If set to true, the user's available actions for each item will not be evaluated meaning the actions-array will be omitted from the response (reduces response time).

default = false

Path Parameters

collectionId string

Required

The collection's unique identifier. (This query also supports 'favorites' as the collectionID).

Responses

200

OK response.

application/json object

ListCollectionItemsResponseBody result type
Show application/json properties
- data array of objects
  
  Required
  
  An item.
  
  Show data properties
  
  id string
  
  Required
  
  The item's unique identifier.
  
  meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  name string
  
  Required
  
  minLength = 1
  
  links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  ownerId string
  
  The ID of the user who owns the item.
  
  spaceId string
  
  The space's unique identifier.
  
  tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
  
  createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
  
  creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
  
  itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
  
  updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
  
  updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
  
  resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  description string
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
  
  thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
  
  resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
  
  resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
  
  resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
  
  collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
  
  resourceSubType string
  
  Optional field defining the item's subtype, if any.
  
  resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
  
  resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
  
  resourceAttributes object
  
  Required
  
  additionalProperties = true
  
  resourceReloadStatus string
  
  If the resource last reload was successful or not.
  
  resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
  
  resourceCustomAttributes object
  
  Required
  
  additionalProperties = true

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

GET /api/v1/collections/{collectionId}/items

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.getCollectionItems(
  'string',
  {},
)

qlik collection item ls \
  --collectionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}/items" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "meta": {
        "tags": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "actions": [
          "string"
        ],
        "collections": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "isFavorited": true
      },
      "name": "string",
      "links": {
        "open": {
          "href": "string"
        },
        "self": {
          "href": "string"
        },
        "qvPlugin": {
          "href": "string"
        },
        "thumbnail": {
          "href": "string"
        },
        "collections": {
          "href": "string"
        }
      },
      "actions": [
        "string"
      ],
      "ownerId": "string",
      "spaceId": "string",
      "tenantId": "string",
      "createdAt": "2018-10-30T07:06:22Z",
      "creatorId": "string",
      "itemViews": {
        "week": [
          {
            "start": "2018-10-30T07:06:22Z",
            "total": 42,
            "unique": 42
          }
        ],
        "total": 42,
        "trend": -4.2,
        "unique": 42,
        "usedBy": 42
      },
      "updatedAt": "2018-10-30T07:06:22Z",
      "updaterId": "string",
      "resourceId": "string",
      "description": "string",
      "isFavorited": true,
      "thumbnailId": "string",
      "resourceLink": "string",
      "resourceSize": {
        "appFile": 42,
        "appMemory": 42
      },
      "resourceType": "app",
      "collectionIds": [
        "string"
      ],
      "resourceSubType": "string",
      "resourceCreatedAt": "2018-10-30T07:06:22Z",
      "resourceUpdatedAt": "2018-10-30T07:06:22Z",
      "resourceAttributes": {},
      "resourceReloadStatus": "string",
      "resourceReloadEndTime": "2018-10-30T07:06:22Z",
      "resourceCustomAttributes": {}
    }
  ]
}

Adds an item to a collection and returns the item.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.

Request Body

Required

application/json object
Show application/json properties
- id string
  
  Required
  
  The item's unique identifier.

Responses

201

Created response.

application/json object

An item.
Show application/json properties
- id string
  
  Required
  
  The item's unique identifier.
- meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- name string
  
  Required
  
  minLength = 1
- links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
- actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
- ownerId string
  
  The ID of the user who owns the item.
- spaceId string
  
  The space's unique identifier.
- tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
- updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
- resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
- description string
- isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
- resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
- resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
- resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
- collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
- resourceSubType string
  
  Optional field defining the item's subtype, if any.
- resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
- resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
- resourceAttributes object
  
  Required
  
  additionalProperties = true
- resourceReloadStatus string
  
  If the resource last reload was successful or not.
- resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
- resourceCustomAttributes object
  
  Required
  
  additionalProperties = true

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

403

Forbidden response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

409

Conflict response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

POST /api/v1/collections/{collectionId}/items

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.addCollectionItem(
  'string',
  { id: 'string' },
)

qlik collection item create \
  --collectionId 'string' \
  --id 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}/items" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"id":"string"}'

Example Response

{
  "id": "string",
  "meta": {
    "tags": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "actions": [
      "string"
    ],
    "collections": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "isFavorited": true
  },
  "name": "string",
  "links": {
    "open": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "qvPlugin": {
      "href": "string"
    },
    "thumbnail": {
      "href": "string"
    },
    "collections": {
      "href": "string"
    }
  },
  "actions": [
    "string"
  ],
  "ownerId": "string",
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemViews": {
    "week": [
      {
        "start": "2018-10-30T07:06:22Z",
        "total": 42,
        "unique": 42
      }
    ],
    "total": 42,
    "trend": -4.2,
    "unique": 42,
    "usedBy": 42
  },
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "resourceId": "string",
  "description": "string",
  "isFavorited": true,
  "thumbnailId": "string",
  "resourceLink": "string",
  "resourceSize": {
    "appFile": 42,
    "appMemory": 42
  },
  "resourceType": "app",
  "collectionIds": [
    "string"
  ],
  "resourceSubType": "string",
  "resourceCreatedAt": "2018-10-30T07:06:22Z",
  "resourceUpdatedAt": "2018-10-30T07:06:22Z",
  "resourceAttributes": {},
  "resourceReloadStatus": "string",
  "resourceReloadEndTime": "2018-10-30T07:06:22Z",
  "resourceCustomAttributes": {}
}

Finds and returns an item in a specific collection. See GET /items/{id}.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.
itemId string

Required

The item's unique identifier.

Responses

200

OK response.

application/json object

An item.
Show application/json properties
- id string
  
  Required
  
  The item's unique identifier.
- meta object
  
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tags array of objects
  
  Required
  
  An array of tags that the item is part of.
  
  Show tags properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
  
  collections array of objects
  
  Required
  
  An array of collections that the item is part of.
  
  Show collections properties
  
  id string
  
  Required
  
  The ID of the tag/collection.
  
  name string
  
  Required
  
  The name of the tag/collection.
  
  isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- name string
  
  Required
  
  minLength = 1
- links object
  
  Required
  
  Show links properties
  
  open object
  
  Show open properties
  
  href string
  
  format = "uri"
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  qvPlugin object
  
  Show qvPlugin properties
  
  href string
  
  format = "uri"
  
  thumbnail object
  
  Show thumbnail properties
  
  href string
  
  format = "uri"
  
  collections object
  
  Show collections properties
  
  href string
  
  format = "uri"
- actions array of strings
  
  Required
  
  The actions that the user can perform on the item.
- ownerId string
  
  The ID of the user who owns the item.
- spaceId string
  
  The space's unique identifier.
- tenantId string
  
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
- createdAt string
  
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
- creatorId string
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViews object
  
  Show itemViews properties
  
  week array of objects
  
  Show week properties
  
  start string
  
  The RFC3339 datetime representing the start of the referenced week.
  
  format = "date-time"
  
  total integer
  
  Total number of views the resource got during the referenced week.
  
  unique integer
  
  Number of unique users who viewed the resource during the referenced week.
  
  total integer
  
  Total number of views the resource got during the last 28 days.
  
  trend number
  
  Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.
  
  unique integer
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedBy integer
  
  Number of apps this dataset is used in (datasets only).
- updatedAt string
  
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
- updaterId string
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
- resourceId string
  
  The case-sensitive string used to search for an item by resourceId. If resourceId is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
- description string
- isFavorited boolean
  
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- thumbnailId string
  
  The item thumbnail's unique identifier. This is optional for internal resources.
- resourceLink string
  
  The case-sensitive string used to search for an item by resourceLink. If resourceLink is provided, then resourceType must be provided. Provide either the resourceId or resourceLink, but not both.
  
  format = "uri"
- resourceSize object
  
  Show resourceSize properties
  
  appFile number
  
  Size of the app on disk in bytes.
  
  appMemory number
  
  Size of the app in memory in bytes.
- resourceType string
  
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""qlikview""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment""assistant""dataproduct""dataqualityrule""glossary""knowledgebase""script""semantictype""page"
- collectionIds array of strings
  
  Required
  
  The ID of the collections that the item has been added to.
- resourceSubType string
  
  Optional field defining the item's subtype, if any.
- resourceCreatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
- resourceUpdatedAt string
  
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
- resourceAttributes object
  
  Required
  
  additionalProperties = true
- resourceReloadStatus string
  
  If the resource last reload was successful or not.
- resourceReloadEndTime string
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
- resourceCustomAttributes object
  
  Required
  
  additionalProperties = true

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

GET /api/v1/collections/{collectionId}/items/{itemId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.getCollectionItem(
  'string',
  'string',
)

qlik collection item get 'string' \
  --collectionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}/items/{itemId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "meta": {
    "tags": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "actions": [
      "string"
    ],
    "collections": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "isFavorited": true
  },
  "name": "string",
  "links": {
    "open": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "qvPlugin": {
      "href": "string"
    },
    "thumbnail": {
      "href": "string"
    },
    "collections": {
      "href": "string"
    }
  },
  "actions": [
    "string"
  ],
  "ownerId": "string",
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2018-10-30T07:06:22Z",
  "creatorId": "string",
  "itemViews": {
    "week": [
      {
        "start": "2018-10-30T07:06:22Z",
        "total": 42,
        "unique": 42
      }
    ],
    "total": 42,
    "trend": -4.2,
    "unique": 42,
    "usedBy": 42
  },
  "updatedAt": "2018-10-30T07:06:22Z",
  "updaterId": "string",
  "resourceId": "string",
  "description": "string",
  "isFavorited": true,
  "thumbnailId": "string",
  "resourceLink": "string",
  "resourceSize": {
    "appFile": 42,
    "appMemory": 42
  },
  "resourceType": "app",
  "collectionIds": [
    "string"
  ],
  "resourceSubType": "string",
  "resourceCreatedAt": "2018-10-30T07:06:22Z",
  "resourceUpdatedAt": "2018-10-30T07:06:22Z",
  "resourceAttributes": {},
  "resourceReloadStatus": "string",
  "resourceReloadEndTime": "2018-10-30T07:06:22Z",
  "resourceCustomAttributes": {}
}

Removes an item from a collection.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

collectionId string

Required

The collection's unique identifier.
itemId string

Required

The item's unique identifier.

Responses

204

No Content response.

400

Bad Request response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

DELETE /api/v1/collections/{collectionId}/items/{itemId}

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.deleteCollectionItem(
  'string',
  'string',
)

qlik collection item rm 'string' \
  --collectionId 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/collections/{collectionId}/items/{itemId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Lists the user's favorites collection.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

302

Found response.

application/json object

401

Unauthorized response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

404

Not Found response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Code is a unique identifier for this error class.
  
  meta object
  
  Show meta properties
  
  fault boolean
  
  Is the error a server-side fault?
  
  explain object
  
  Further explanation of the error
  
  timeout boolean
  
  Is the error a timeout?
  
  temporary boolean
  
  Is the error temporary?
  
  title string
  
  Title is the name of this class of errors.
  
  detail string
  
  Detail is a human-readable explanation specific to this occurrence of the problem.

GET /api/v1/collections/favorites

import { createQlikApi } from '@qlik/api'

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

await qlik.collections.getFavoritesCollection()

qlik collection favorites

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

Collections

Endpoints

List collections

Facts

Query Parameters

Responses

200

400

401

500

Example Response

Create a new collection.

Facts

Request Body

Responses

201

400

401

403

409

500

Example Response

Get a collection

Facts

Path Parameters

Responses

200

400

401

404

500

Example Response

Update collection

Facts

Path Parameters

Request Body

Responses

200

400

401

404

409

500

Example Response

Update a collection's name and description

Facts

Path Parameters

Request Body

Responses

200

400

401

404

409

500

Example Response

Delete a collection

Facts

Path Parameters

Responses

204

401

404

500

List items in a collection

Facts

Query Parameters

Path Parameters

Responses

200

400

401

404

500

Example Response

Add an item to a collection

Facts

Path Parameters

Request Body

Responses