Items

Items is a discovery API for core resources in the Qlik platform. This API is used to list apps and other resources a user has access to.

Download specification

Endpoints

GET

/v1/items
GET

/v1/items/{itemId}
PUT

/v1/items/{itemId}
DELETE

/v1/items/{itemId}
GET

/v1/items/{itemId}/collections
GET

/v1/items/{itemId}/publisheditems
GET

/v1/items/settings
PATCH

/v1/items/settings

Finds and returns items that the user has access to.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Query Parameters

collectionIdstring

The collection's unique identifier.
createdByUserIdstring

User's unique identifier.
idstring

The item's unique identifier.
limitinteger

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
namestring

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

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

User's unique identifier.
notOwnerIdstring

Owner identifier.
ownerIdstring

Owner identifier.
prevstring

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

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

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

The case-sensitive strings used to search for an item by resourceIds. The maximum number of resourceIds it supports is 100. If resourceIds is provided, then resourceType must be provided. For example '?resourceIds=appId1,appId2'
resourceLinkstring

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"
resourceSubTypestring

the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd'. Will return a 400 error if used in conjuction with the square bracket syntax for resourceSubType filtering in the 'resourceType' query parameter.
resourceTypestring

The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp'. Additionally, a optional resourceSubType filter can be added to each resourceType. For example '?resourceType=app[qvd,chart-monitoring],qvapp'. An trailing comma can be used to include the empty resourceSubType, e.g. '?resourceType=app[qvd,chart-monitoring,]', or, to include only empty resourceSubTypes, '?resourceType=app[]' This syntax replaces the 'resourceSubType' query param, and using both in the same query will result in a 400 error.

Can be one of: "app""collection""qlikview""insight""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment"
sortstring

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"
spaceIdstring

The space's unique identifier (supports 'personal' as spaceId).
spaceTypestring

The case-sensitive string used to filter items on space type(s). For example '?spaceType=shared,personal'.

Can be one of: "shared""managed""personal""data"
sharedboolean

Whether or not to return items in a shared space.
noActionsboolean

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

Responses

200

application/json

OK response.

ListItemsResponseBody result type

application/jsonobject

ListItemsResponseBody result type
Show application/json properties
- dataarray of objects
  Required
- linksobject
  Required
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
  
  collectionobject
  
  Show collection properties
  
  hrefstring
  
  format = "uri"

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not Found response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/items

curl "https://your-tenant.us.qlikcloud.com/api/v1/items" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item ls

Response

{
  "data": [
    {}
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "collection": {
      "href": "string"
    }
  }
}

Finds and returns an item.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Path Parameters

itemIdstring
Required

The item's unique identifier

Responses

200

application/json

OK response.

An item.

application/jsonobject

An item.
Show application/json properties
- idstring
  Required
  
  The item's unique identifier.
- metaobject
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tagsarray of objects
  Required
  
  actionsarray of strings
  Required
  
  The actions that the user can perform on the item.
  
  collectionsarray of objects
  Required
  
  isFavoritedboolean
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- namestring
  Required
  
  minLength = 1
- linksobject
  Required
  
  Show links properties
  
  openobject
  
  Show open properties
  
  hrefstring
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
  
  thumbnailobject
  
  Show thumbnail properties
  
  hrefstring
  
  format = "uri"
  
  collectionsobject
  
  Show collections properties
  
  hrefstring
  
  format = "uri"
- actionsarray of strings
  Required
  
  The actions that the user can perform on the item.
- ownerIdstring
  
  The ID of the user who owns the item.
- spaceIdstring
  
  The space's unique identifier.
- tenantIdstring
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
- createdAtstring
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
- creatorIdstring
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViewsobject
  
  Show itemViews properties
  
  weekarray of objects
  
  totalinteger
  
  Total number of views the resource got during the last 28 days.
  
  trendnumber
  
  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.
  
  uniqueinteger
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedByinteger
  
  Number of apps this dataset is used in (datasets only).
- updatedAtstring
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
- updaterIdstring
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
- resourceIdstring
  
  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.
- descriptionstring
- isFavoritedboolean
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- thumbnailIdstring
  
  The item thumbnail's unique identifier. This is optional for internal resources.
- resourceLinkstring
  
  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"
- resourceSizeobject
  
  Show resourceSize properties
  
  appFilenumber
  
  Size of the app on disk in bytes.
  
  appMemorynumber
  
  Size of the app in memory in bytes.
- resourceTypestring
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""collection""qlikview""insight""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment"
- collectionIdsarray of strings
  Required
  
  The ID of the collections that the item has been added to.
- resourceSubTypestring
  
  Optional field defining the item's subtype, if any.
- resourceCreatedAtstring
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
- resourceUpdatedAtstring
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
- resourceAttributesobject
  Required
  
  additionalProperties = true
- resourceReloadStatusstring
  
  If the resource last reload was successful or not.
- resourceReloadEndTimestring
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
- resourceCustomAttributesobject
  Required
  
  additionalProperties = true

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not Found response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/items/{itemId}

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/{itemId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item get <itemId>

Response

{
  "id": "string",
  "meta": {
    "tags": [
      {}
    ],
    "actions": [
      "string"
    ],
    "collections": [
      {}
    ],
    "isFavorited": true
  },
  "name": "string",
  "links": {
    "open": {
      "href": "string"
    },
    "self": {
      "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": [
      {}
    ],
    "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": {}
}

Updates an item. 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)
Categories	externalmanage

Path Parameters

itemIdstring
Required

The item's unique identifier.

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- namestring
  
  minLength = 1
- spaceIdstring
  
  The space's unique identifier.
- resourceIdstring
  
  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.
- descriptionstring
- thumbnailIdstring
  
  The item thumbnail's unique identifier. This is optional for internal resources.
- resourceLinkstring
  
  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"
- resourceTypestring
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""collection""qlikview""insight""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment"
- resourceSubTypestring
  
  Optional field defining the item's subtype, if any.
- resourceUpdatedAtstring
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
- resourceAttributesobject
  
  additionalProperties = true
- resourceCustomAttributesobject
  
  additionalProperties = true

Responses

200

application/json

OK response.

An item.

application/jsonobject

An item.
Show application/json properties
- idstring
  Required
  
  The item's unique identifier.
- metaobject
  Required
  
  Item metadata and computed fields.
  
  Show meta properties
  
  tagsarray of objects
  Required
  
  actionsarray of strings
  Required
  
  The actions that the user can perform on the item.
  
  collectionsarray of objects
  Required
  
  isFavoritedboolean
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- namestring
  Required
  
  minLength = 1
- linksobject
  Required
  
  Show links properties
  
  openobject
  
  Show open properties
  
  hrefstring
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
  
  thumbnailobject
  
  Show thumbnail properties
  
  hrefstring
  
  format = "uri"
  
  collectionsobject
  
  Show collections properties
  
  hrefstring
  
  format = "uri"
- actionsarray of strings
  Required
  
  The actions that the user can perform on the item.
- ownerIdstring
  
  The ID of the user who owns the item.
- spaceIdstring
  
  The space's unique identifier.
- tenantIdstring
  Required
  
  The ID of the tenant that owns the item. This is populated using the JWT.
- createdAtstring
  Required
  
  The RFC3339 datetime when the item was created.
  
  format = "date-time"
- creatorIdstring
  
  The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViewsobject
  
  Show itemViews properties
  
  weekarray of objects
  
  totalinteger
  
  Total number of views the resource got during the last 28 days.
  
  trendnumber
  
  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.
  
  uniqueinteger
  
  Number of unique users who viewed the resource during the last 28 days.
  
  usedByinteger
  
  Number of apps this dataset is used in (datasets only).
- updatedAtstring
  Required
  
  The RFC3339 datetime when the item was last updated.
  
  format = "date-time"
- updaterIdstring
  
  ID of the user who last updated the item. This is only populated if the JWT contains a userId.
- resourceIdstring
  
  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.
- descriptionstring
- isFavoritedboolean
  Required
  
  The flag that indicates if item is in the user's favorites collection.
- thumbnailIdstring
  
  The item thumbnail's unique identifier. This is optional for internal resources.
- resourceLinkstring
  
  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"
- resourceSizeobject
  
  Show resourceSize properties
  
  appFilenumber
  
  Size of the app on disk in bytes.
  
  appMemorynumber
  
  Size of the app in memory in bytes.
- resourceTypestring
  Required
  
  The case-sensitive string defining the item's type.
  
  Can be one of: "app""collection""qlikview""insight""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment"
- collectionIdsarray of strings
  Required
  
  The ID of the collections that the item has been added to.
- resourceSubTypestring
  
  Optional field defining the item's subtype, if any.
- resourceCreatedAtstring
  Required
  
  The RFC3339 datetime when the resource that the item references was created.
  
  format = "date-time"
- resourceUpdatedAtstring
  Required
  
  The RFC3339 datetime when the resource that the item references was last updated.
  
  format = "date-time"
- resourceAttributesobject
  Required
  
  additionalProperties = true
- resourceReloadStatusstring
  
  If the resource last reload was successful or not.
- resourceReloadEndTimestring
  
  The RFC3339 datetime when the resource last reload ended.
  
  format = "date-time"
- resourceCustomAttributesobject
  Required
  
  additionalProperties = true

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

403

application/json

Forbidden response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not Found response.

application/jsonobject
Show application/json properties
- errorsarray of objects

409

application/json

Conflict response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

PUT /v1/items/{itemId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","spaceId":"string","resourceId":"string","description":"string","thumbnailId":"string","resourceLink":"string","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2018-10-30T07:06:22Z","resourceAttributes":{},"resourceCustomAttributes":{}}'

const https = require('https')
  const data = JSON.stringify({"name":"string","spaceId":"string","resourceId":"string","description":"string","thumbnailId":"string","resourceLink":"string","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2018-10-30T07:06:22Z","resourceAttributes":{},"resourceCustomAttributes":{}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/{itemId}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik item update <itemId> \
--description="string" \
--name="string" \
--resourceId="string" \
--resourceLink="string" \
--resourceSubType="string" \
--resourceType="app" \
--resourceUpdatedAt="2018-10-30T07:06:22Z" \
--spaceId="string" \
--thumbnailId="string"

Request

{
  "name": "string",
  "spaceId": "string",
  "resourceId": "string",
  "description": "string",
  "thumbnailId": "string",
  "resourceLink": "string",
  "resourceType": "app",
  "resourceSubType": "string",
  "resourceUpdatedAt": "2018-10-30T07:06:22Z",
  "resourceAttributes": {},
  "resourceCustomAttributes": {}
}

Response

{
  "id": "string",
  "meta": {
    "tags": [
      {}
    ],
    "actions": [
      "string"
    ],
    "collections": [
      {}
    ],
    "isFavorited": true
  },
  "name": "string",
  "links": {
    "open": {
      "href": "string"
    },
    "self": {
      "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": [
      {}
    ],
    "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": {}
}

Deletes an item and removes the item from all collections.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Path Parameters

itemIdstring
Required

The item's unique identifier.

Responses

204

No Content response.

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

403

application/json

Forbidden response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not Found response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

DELETE /v1/items/{itemId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/{itemId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item rm <itemId>

Finds and returns the collections of an item. This endpoint does not return the user's favorites collection.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Query Parameters

limitinteger

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
namestring

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

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

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

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

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"
typestring

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

Can be one of: "private""public""publicgoverned"

Path Parameters

itemIdstring
Required

The item's unique identifier.

Responses

200

application/json

OK response.

ListItemCollectionsResponseBody result type

application/jsonobject

ListItemCollectionsResponseBody result type
Show application/json properties
- dataarray of objects
  Required
- linksobject
  Required
  
  Show links properties
  
  itemobject
  
  Show item properties
  
  hrefstring
  
  format = "uri"
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not found response

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/items/{itemId}/collections

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/{itemId}/collections',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item collections <itemId>

Response

{
  "data": [
    {}
  ],
  "links": {
    "item": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns the published items for a given item. This endpoint is particularly useful for finding the published copies of an app or a qvapp when you want to replace the content of a published copy with new information from the source item.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Query Parameters

limitinteger

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
nextstring

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

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

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

Can be one of: "app""collection""qlikview""insight""qvapp""genericlink""sharingservicetask""note""dataasset""dataset""automation""automl-experiment""automl-deployment"
sortstring

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"

Path Parameters

itemIdstring
Required

The item's unique identifier

Responses

200

application/json

OK response.

ListItemCollectionsResponseBody result type

application/jsonobject

ListItemCollectionsResponseBody result type
Show application/json properties
- dataarray of objects
  Required
- linksobject
  Required
  
  Show links properties
  
  itemobject
  
  Show item properties
  
  hrefstring
  
  format = "uri"
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  format = "uri"
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

404

application/json

Not Found response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/items/{itemId}/publisheditems

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/{itemId}/publisheditems',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item publisheditems <itemId>

Response

{
  "data": [
    {}
  ],
  "links": {
    "item": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Finds and returns the settings for the current tenant.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	externalmanage

Responses

200

application/json

OK response.

application/jsonobject
Show application/json properties
- usageMetricsEnabledboolean
  Required
  
  Decides if the usage metrics will be shown in the hub UI.
  
  default = true

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

GET /v1/items/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/items/settings" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/settings',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

qlik item settings ls

Response

{
  "usageMetricsEnabled": true
}

Updates the settings provided in the patch body.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	externalmanage

Request Body

Required

application/json

A JSONPatch document as defined by RFC 6902.

application/jsonarray of objects

A JSONPatch document as defined by RFC 6902.
Show application/json properties
- opstring
  Required
  
  The operation to be performed. Only "replace" is supported.
  
  Can be one of: "replace"
- pathstring
  Required
  
  Field of Settings to be patched (updated).
  
  Can be one of: "/usageMetricsEnabled"
- valueboolean
  Required
  
  The value to be used within the operations.

Responses

200

application/json

OK response.

application/jsonobject
Show application/json properties
- usageMetricsEnabledboolean
  Required
  
  Decides if the usage metrics will be shown in the hub UI.
  
  default = true

400

application/json

Bad Request response.

application/jsonobject
Show application/json properties
- errorsarray of objects

401

application/json

Unauthorized response.

application/jsonobject
Show application/json properties
- errorsarray of objects

403

application/json

Forbidden response.

application/jsonobject
Show application/json properties
- errorsarray of objects

500

application/json

Internal Server Error response.

application/jsonobject
Show application/json properties
- errorsarray of objects

PATCH /v1/items/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/items/settings" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/usageMetricsEnabled","value":true}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/usageMetricsEnabled","value":true}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/items/settings',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik item settings patch \
--body='[{"op":"replace","path":"/usageMetricsEnabled","value":true}]'

Request

[
  {
    "op": "replace",
    "path": "/usageMetricsEnabled",
    "value": true
  }
]

Response

{
  "usageMetricsEnabled": true
}

Items

Endpoints

Retrieves items that the user has access to.

Facts

Query Parameters

Responses

200

400

401

404

500

Response

Returns an item.

Facts

Path Parameters

Responses

200

400

401

404

500

Response

Updates an item.

Facts

Path Parameters

Request Body

Responses

200

400

401

403

404

409

500

Request

Response

Deletes an item.

Facts

Path Parameters

Responses

204

401

403

404

500

Returns the collections of an item.

Facts

Query Parameters

Path Parameters

Responses

200

400

401

404

500

Response

Returns published items for a given item.

Facts

Query Parameters

Path Parameters

Responses

200

400

401

404

500

Response

Returns tenant specific settings.

Facts

Responses

200

400

401

500

Response

Patches tenant specific settings.

Facts

Request Body

Responses

200