Collections
Collections provide the framework to catalog various content a user has access to using tags, public and private collections, and favorites.
Endpoints
- GET/v1/collections
- POST/v1/collections
- GET/v1/collections/{collectionId}
- PATCH/v1/collections/{collectionId}
- PUT/v1/collections/{collectionId}
- DELETE/v1/collections/{collectionId}
- GET/v1/collections/{collectionId}/items
- POST/v1/collections/{collectionId}/items
- GET/v1/collections/{collectionId}/items/{itemId}
- DELETE/v1/collections/{collectionId}/items/{itemId}
- GET/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) |
Categories | manage |
Query Parameters
- creatorIdstring
The case-sensitive string used to search for a resource by creatorId.
- idstring
The collection's unique identifier.
- includeItemsstring
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.
- limitinteger
The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).
- 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 filter for a collection by type. Retrieve private collections with
private
, public collections withpublicgoverned
, and tags withpublic
.Can be one of: "private""public""publicgoverned"
- typesarray of objects
A commaseparated case-sensitive string used to filter by multiple types.
Responses
200
application/json
OK response.
ListCollectionsResponseBody result type
- application/jsonobject
ListCollectionsResponseBody result type
application/json properties
- dataarray of objectsRequired
A collection.
data properties
- idstringRequired
The collection's unique identifier.
- fullboolean
States if a collection has reached its items limit or not
- metaobject
Collection metadata and computed fields.
meta properties
- itemsobject
Multiple items.
items properties
- dataarray of objectsRequired
An item.
data properties
- idstringRequired
The item's unique identifier.
- metaobjectRequired
Item metadata and computed fields.
meta properties
- tagsarray of objectsRequired
An array of tags that the item is part of.
tags properties
- idstringRequired
The ID of the tag/collection.
- namestringRequired
The name of the tag/collection.
-
- actionsarray of stringsRequired
The actions that the user can perform on the item.
- collectionsarray of objectsRequired
- isFavoritedbooleanRequired
The flag that indicates if item is in the user's favorites collection.
-
- namestringRequired
- linksobjectRequired
links properties
- openobject
open properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
- thumbnailobject
thumbnail properties
- hrefstring
-
- collectionsobject
collections properties
- hrefstring
-
-
- actionsarray of stringsRequired
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.
- tenantIdstringRequired
The ID of the tenant that owns the item. This is populated using the JWT.
- createdAtstringRequired
The RFC3339 datetime when the item was created.
- creatorIdstring
The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViewsobject
itemViews properties
- weekarray of objects
week properties
- startstring
The RFC3339 datetime representing the start of the referenced week.
- totalinteger
Total number of views the resource got during the referenced week.
- uniqueinteger
Number of unique users who viewed the resource during the referenced week.
-
- 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).
-
- updatedAtstringRequired
The RFC3339 datetime when the item was last updated.
- 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
- isFavoritedbooleanRequired
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.
- resourceSizeobject
resourceSize properties
- appFilenumber
Size of the app on disk in bytes.
- appMemorynumber
Size of the app in memory in bytes.
-
- resourceTypestringRequired
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 stringsRequired
The ID of the collections that the item has been added to.
- resourceSubTypestring
Optional field defining the item's subtype, if any.
- resourceCreatedAtstringRequired
The RFC3339 datetime when the resource that the item references was created.
- resourceUpdatedAtstringRequired
The RFC3339 datetime when the resource that the item references was last updated.
- resourceAttributesobjectRequired
- resourceReloadStatusstring
If the resource last reload was successful or not.
- resourceReloadEndTimestring
The RFC3339 datetime when the resource last reload ended.
- resourceCustomAttributesobjectRequired
-
- linksobjectRequired
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
- collectionobject
collection properties
- hrefstring
-
-
-
-
- namestringRequired
- typestringRequired
Can be one of: "private""public""favorite""publicgoverned"
- linksobjectRequired
links properties
- typeany
- itemsobject
-
- tenantIdstringRequired
The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAtstringRequired
The RFC3339 datetime when the collection was created.
- creatorIdstring
The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCountintegerRequired
The number of items that have been added to the collection that the user has access to.
- updatedAtstringRequired
The RFC3339 datetime when the collection was last updated.
- updaterIdstring
The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- descriptionstring
-
- linksobjectRequired
links properties
- itemobject
item properties
- hrefstring
-
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Code is a unique identifier for this error class.
- metaobject
meta properties
- faultboolean
Is the error a server-side fault?
- explainobject
Further explanation of the error
- timeoutboolean
Is the error a timeout?
- temporaryboolean
Is the error temporary?
-
- titlestring
Title is the name of this class of errors.
- detailstring
Detail is a human-readable explanation specific to this occurrence of the problem.
-
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/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/collections',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection ls
Response
{
"data": [
{
"id": "string",
"full": true,
"meta": {
"items": {
"data": [
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"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": [
{
"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": {
"items": {}
},
"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) |
Categories | manage |
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- namestringRequired
For
public
collections (tags), if name already exists in the tenant as apublic
collection, this call will fail with a409
response. - typestringRequired
Can be one of: "private""public""publicgoverned"
- descriptionstring
-
Responses
201
application/json
Created response.
A collection.
- application/jsonobject
A collection.
application/json properties
- idstringRequired
The collection's unique identifier.
- fullboolean
States if a collection has reached its items limit or not
- metaobject
Collection metadata and computed fields.
meta properties
- typeany
- itemsobject
-
- namestringRequired
- typestringRequired
Can be one of: "private""public""favorite""publicgoverned"
- linksobjectRequired
links properties
- typeany
- itemsobject
-
- tenantIdstringRequired
The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAtstringRequired
The RFC3339 datetime when the collection was created.
- creatorIdstring
The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCountintegerRequired
The number of items that have been added to the collection that the user has access to.
- updatedAtstringRequired
The RFC3339 datetime when the collection was last updated.
- updaterIdstring
The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- descriptionstring
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
403
application/json
Forbidden response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Conflict response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","type":"private","description":"string"}'
const https = require('https')
const data = JSON.stringify({"name":"string","type":"private","description":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/collections',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik collection create \
--description="string" \
--name="string" \
--type="private"
Request
{
"name": "string",
"type": "private",
"description": "string"
}
Response
{
"id": "string",
"full": true,
"meta": {
"items": {}
},
"name": "string",
"type": "private",
"links": {
"items": {}
},
"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) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
Responses
200
application/json
OK response.
A collection.
- application/jsonobject
A collection.
application/json properties
- idstringRequired
The collection's unique identifier.
- fullboolean
States if a collection has reached its items limit or not
- metaobject
Collection metadata and computed fields.
meta properties
- typeany
- itemsobject
-
- namestringRequired
- typestringRequired
Can be one of: "private""public""favorite""publicgoverned"
- linksobjectRequired
links properties
- typeany
- itemsobject
-
- tenantIdstringRequired
The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAtstringRequired
The RFC3339 datetime when the collection was created.
- creatorIdstring
The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCountintegerRequired
The number of items that have been added to the collection that the user has access to.
- updatedAtstringRequired
The RFC3339 datetime when the collection was last updated.
- updaterIdstring
The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- descriptionstring
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-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/collections/{collectionId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection get <collectionId>
Response
{
"id": "string",
"full": true,
"meta": {
"items": {}
},
"name": "string",
"type": "private",
"links": {
"items": {}
},
"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) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
Request Body
Requiredapplication/json
A JSONPatch document as defined by RFC 6902.
- application/jsonarray of objects
A JSONPatch document as defined by RFC 6902.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
Field of collection to be patched.
Can be one of: "/name""/description""/type"
- valuestringRequired
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
application/json
OK response.
A collection.
- application/jsonobject
A collection.
application/json properties
- idstringRequired
The collection's unique identifier.
- fullboolean
States if a collection has reached its items limit or not
- metaobject
Collection metadata and computed fields.
meta properties
- typeany
- itemsobject
-
- namestringRequired
- typestringRequired
Can be one of: "private""public""favorite""publicgoverned"
- linksobjectRequired
links properties
- typeany
- itemsobject
-
- tenantIdstringRequired
The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAtstringRequired
The RFC3339 datetime when the collection was created.
- creatorIdstring
The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCountintegerRequired
The number of items that have been added to the collection that the user has access to.
- updatedAtstringRequired
The RFC3339 datetime when the collection was last updated.
- updaterIdstring
The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- descriptionstring
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Conflict response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/name","value":"string"}]'
const https = require('https')
const data = JSON.stringify([{"op":"replace","path":"/name","value":"string"}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/collections/{collectionId}',
'method': 'PATCH',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
This API is not included yet in qlik-cli
Request
[
{
"op": "replace",
"path": "/name",
"value": "string"
}
]
Response
{
"id": "string",
"full": true,
"meta": {
"items": {}
},
"name": "string",
"type": "private",
"links": {
"items": {}
},
"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) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- namestring
- descriptionstring
-
Responses
200
application/json
OK response.
A collection.
- application/jsonobject
A collection.
application/json properties
- idstringRequired
The collection's unique identifier.
- fullboolean
States if a collection has reached its items limit or not
- metaobject
Collection metadata and computed fields.
meta properties
- typeany
- itemsobject
-
- namestringRequired
- typestringRequired
Can be one of: "private""public""favorite""publicgoverned"
- linksobjectRequired
links properties
- typeany
- itemsobject
-
- tenantIdstringRequired
The ID of the tenant that owns the collection. This property is populated by using JWT.
- createdAtstringRequired
The RFC3339 datetime when the collection was created.
- creatorIdstring
The ID of the user who created the collection. This property is only populated if the JWT contains a userId.
- itemCountintegerRequired
The number of items that have been added to the collection that the user has access to.
- updatedAtstringRequired
The RFC3339 datetime when the collection was last updated.
- updaterIdstring
The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.
- descriptionstring
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Conflict response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","description":"string"}'
const https = require('https')
const data = JSON.stringify({"name":"string","description":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/collections/{collectionId}',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik collection update <collectionId> \
--description="string" \
--name="string"
Request
{
"name": "string",
"description": "string"
}
Response
{
"id": "string",
"full": true,
"meta": {
"items": {}
},
"name": "string",
"type": "private",
"links": {
"items": {}
},
"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) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
Responses
204
No Content response.
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-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/collections/{collectionId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection rm <collectionId>
Retrieves items from a collection that the user has access to.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Query Parameters
- limitinteger
The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).
- 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.
- 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.
- 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.
- 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"
- spaceIdstring
The space's unique identifier (supports 'personal' as spaceId).
- sharedbooleanDeprecated
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).
Path Parameters
- collectionIdstringRequired
The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
Responses
200
application/json
OK response.
ListCollectionItemsResponseBody result type
- application/jsonobject
ListCollectionItemsResponseBody result type
application/json properties
- dataarray of objectsRequired
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/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/collections/{collectionId}/items',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection item ls \
--collectionId="string"
Response
{
"data": [
{}
]
}
Adds an item to a collection and returns the item.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
Request Body
Requiredapplication/json
- application/jsonobject
application/json properties
- idstringRequired
The item's unique identifier.
-
Responses
201
application/json
Created response.
An item.
- application/jsonobject
An item.
application/json properties
- idstringRequired
The item's unique identifier.
- metaobjectRequired
Item metadata and computed fields.
meta properties
- tagsarray of objectsRequired
- actionsarray of stringsRequired
The actions that the user can perform on the item.
- collectionsarray of objectsRequired
- isFavoritedbooleanRequired
The flag that indicates if item is in the user's favorites collection.
-
- namestringRequired
- linksobjectRequired
links properties
- openobject
open properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
- thumbnailobject
thumbnail properties
- hrefstring
-
- collectionsobject
collections properties
- hrefstring
-
-
- actionsarray of stringsRequired
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.
- tenantIdstringRequired
The ID of the tenant that owns the item. This is populated using the JWT.
- createdAtstringRequired
The RFC3339 datetime when the item was created.
- creatorIdstring
The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViewsobject
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).
-
- updatedAtstringRequired
The RFC3339 datetime when the item was last updated.
- 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
- isFavoritedbooleanRequired
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.
- resourceSizeobject
resourceSize properties
- appFilenumber
Size of the app on disk in bytes.
- appMemorynumber
Size of the app in memory in bytes.
-
- resourceTypestringRequired
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 stringsRequired
The ID of the collections that the item has been added to.
- resourceSubTypestring
Optional field defining the item's subtype, if any.
- resourceCreatedAtstringRequired
The RFC3339 datetime when the resource that the item references was created.
- resourceUpdatedAtstringRequired
The RFC3339 datetime when the resource that the item references was last updated.
- resourceAttributesobjectRequired
- resourceReloadStatusstring
If the resource last reload was successful or not.
- resourceReloadEndTimestring
The RFC3339 datetime when the resource last reload ended.
- resourceCustomAttributesobjectRequired
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
403
application/json
Forbidden response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
409
application/json
Conflict response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/items" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"id":"string"}'
const https = require('https')
const data = JSON.stringify({"id":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/collections/{collectionId}/items',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik collection item create \
--collectionId="string" \
--id="string"
Request
{
"id": "string"
}
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": {}
}
Finds and returns an item in a specific collection. See GET /items/{id}
.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
- itemIdstringRequired
The item's unique identifier.
Responses
200
application/json
OK response.
An item.
- application/jsonobject
An item.
application/json properties
- idstringRequired
The item's unique identifier.
- metaobjectRequired
Item metadata and computed fields.
meta properties
- tagsarray of objectsRequired
- actionsarray of stringsRequired
The actions that the user can perform on the item.
- collectionsarray of objectsRequired
- isFavoritedbooleanRequired
The flag that indicates if item is in the user's favorites collection.
-
- namestringRequired
- linksobjectRequired
links properties
- openobject
open properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
- thumbnailobject
thumbnail properties
- hrefstring
-
- collectionsobject
collections properties
- hrefstring
-
-
- actionsarray of stringsRequired
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.
- tenantIdstringRequired
The ID of the tenant that owns the item. This is populated using the JWT.
- createdAtstringRequired
The RFC3339 datetime when the item was created.
- creatorIdstring
The ID of the user who created the item. This is only populated if the JWT contains a userId.
- itemViewsobject
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).
-
- updatedAtstringRequired
The RFC3339 datetime when the item was last updated.
- 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
- isFavoritedbooleanRequired
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.
- resourceSizeobject
resourceSize properties
- appFilenumber
Size of the app on disk in bytes.
- appMemorynumber
Size of the app in memory in bytes.
-
- resourceTypestringRequired
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 stringsRequired
The ID of the collections that the item has been added to.
- resourceSubTypestring
Optional field defining the item's subtype, if any.
- resourceCreatedAtstringRequired
The RFC3339 datetime when the resource that the item references was created.
- resourceUpdatedAtstringRequired
The RFC3339 datetime when the resource that the item references was last updated.
- resourceAttributesobjectRequired
- resourceReloadStatusstring
If the resource last reload was successful or not.
- resourceReloadEndTimestring
The RFC3339 datetime when the resource last reload ended.
- resourceCustomAttributesobjectRequired
-
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/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/collections/{collectionId}/items/{itemId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection item get <itemId> \
--collectionId="string"
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": {}
}
Removes an item from a collection.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- collectionIdstringRequired
The collection's unique identifier.
- itemIdstringRequired
The item's unique identifier.
Responses
204
No Content response.
400
application/json
Bad Request response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/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/collections/{collectionId}/items/{itemId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection item rm <itemId> \
--collectionId="string"
Lists the user's favorites collection.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Responses
302
application/json
Found response.
- application/jsonobject
401
application/json
Unauthorized response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
404
application/json
Not Found response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
500
application/json
Internal Server Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/favorites" \
-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/collections/favorites',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik collection favorites