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.
Endpoints
Skip to sectionGET | /v1/items |
POST | /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 |
Retrieves items that the user has access to.
Finds and returns items that the user has access to.
Query Parameters GET /v1/items
collectionId optional string | The collection's unique identifier. |
createdByUserId optional string | User's unique identifier. |
id optional string | The item's unique identifier. |
limit optional, minimum=1, maximum=100 integer | The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). |
name optional string | The case-insensitive string used to search for a resource by name. |
next optional string | The cursor to the next page of resources. Provide either the next or prev cursor, but not both. |
notCreatedByUserId optional string | User's unique identifier. |
notOwnerId optional string | Owner identifier. |
ownerId optional string | Owner identifier. |
prev optional string | The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. |
query optional string | The case-insensitive string used to search for a resource by name or description. |
resourceId optional 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. |
resourceIds optional string | 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' |
resourceLink optional string<uri> | 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. |
resourceSubType optional string | the case-sensitive string used to filter items by resourceSubType(s). For example '?resourceSubType=chart-monitoring,qix-df,qvd' |
resourceType optional | The case-sensitive string used to filter items by resourceType(s). For example '?resourceType=app,qvapp' |
shared boolean | Whether or not to return items in a shared space. |
sort optional 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. Enum: +createdAt -createdAt +name -name +updatedAt -updatedAt |
spaceId optional string | The space's unique identifier (supports 'personal' as spaceId). |
noActions optional | 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). |
Responses GET /v1/items
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
GET/v1/items
curl "https://your-tenant.us.qlikcloud.com/api/v1/items" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/items
{
"data": [
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.393Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.393Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.393Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.393Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.393Z",
"resourceCustomAttributes": {}
}
],
"links": {
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"collection": {
"href": "http://example.com"
}
}
}
Creates and returns a new item.
Creates and returns a new item. An item references an internal or external resource. A resource cannot be both internal and external.
resourceType
must be provided for both internal and external items.
resourceId
must be provided for internal items.
resourceLink
must be provided for external items.
For a given tenant, an item's resourceId or resourceLink is unique.
Request Body POST /v1/items
application/json | No description |
Responses POST /v1/items
201 application/json | Created response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
403 application/json | Forbidden response. |
404 application/json | Not Found response. |
409 application/json | Conflict response. |
500 application/json | Internal Server Error response. |
POST/v1/items
curl "https://your-tenant.us.qlikcloud.com/api/v1/items" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"name":"string","spaceId":"string","resourceId":"string","description":"string","thumbnailId":"string","resourceLink":"http://example.com","resourceType":"app","resourceSubType":"string","resourceCreatedAt":"2022-08-15T13:39:45.393Z","resourceUpdatedAt":"2022-08-15T13:39:45.393Z","resourceAttributes":{},"resourceCustomAttributes":{}}'
Request POST /v1/items
{
"name": "string",
"spaceId": "string",
"resourceId": "string",
"description": "string",
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceType": "app",
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.393Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceCustomAttributes": {}
}
Response POST /v1/items
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.393Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.393Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.393Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.393Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.393Z",
"resourceCustomAttributes": {}
}
Returns an item.
Finds and returns an item.
Path Parameters GET /v1/items/{itemId}
itemId string | The item's unique identifier |
Responses GET /v1/items/{itemId}
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
GET/v1/items/{itemId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/items/{itemId}
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.393Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.393Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.393Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.393Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.393Z",
"resourceCustomAttributes": {}
}
Updates an item.
Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
Path Parameters PUT /v1/items/{itemId}
itemId string | The item's unique identifier. |
Request Body PUT /v1/items/{itemId}
application/json | No description |
Responses PUT /v1/items/{itemId}
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
403 application/json | Forbidden response. |
404 application/json | Not Found response. |
409 application/json | Conflict response. |
500 application/json | Internal Server Error response. |
PUT/v1/items/{itemId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"name":"string","spaceId":"string","resourceId":"string","description":"string","thumbnailId":"string","resourceLink":"http://example.com","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2022-08-15T13:39:45.393Z","resourceAttributes":{},"resourceCustomAttributes":{}}'
Request PUT /v1/items/{itemId}
{
"name": "string",
"spaceId": "string",
"resourceId": "string",
"description": "string",
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceType": "app",
"resourceSubType": "string",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceCustomAttributes": {}
}
Response PUT /v1/items/{itemId}
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.393Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.393Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.393Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.393Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.393Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.393Z",
"resourceCustomAttributes": {}
}
Deletes an item.
Deletes an item and removes the item from all collections.
Path Parameters DELETE /v1/items/{itemId}
itemId string | The item's unique identifier. |
Responses DELETE /v1/items/{itemId}
204 object | No Content response. |
401 application/json | Unauthorized response. |
403 application/json | Forbidden response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
DELETE/v1/items/{itemId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Returns the collections of an item.
Finds and returns the collections of an item. This endpoint does not return the user's favorites collection.
Path Parameters GET /v1/items/{itemId}/collections
itemId string | The item's unique identifier. |
Query Parameters GET /v1/items/{itemId}/collections
limit optional, minimum=1, maximum=100 integer | The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). |
name optional string | The case-sensitive string used to search for a collection by name. |
next optional string | The cursor to the next page of resources. Provide either the next or prev cursor, but not both. |
prev optional string | The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. |
query optional string | The case-insensitive string used to search for a resource by name or description. |
sort optional 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. Enum: +createdAt -createdAt +name -name +updatedAt -updatedAt |
type optional string | The case-sensitive string used to search for a collection by type. Enum: public private |
Responses GET /v1/items/{itemId}/collections
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
404 application/json | Not found response |
500 application/json | Internal Server Error response. |
GET/v1/items/{itemId}/collections
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}/collections" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/items/{itemId}/collections
{
"data": [
{
"id": "string",
"meta": {
"items": {
"data": [
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.394Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.394Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.394Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.394Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.394Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.394Z",
"resourceCustomAttributes": {}
}
],
"links": {
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"collection": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"type": "public",
"links": {
"self": {
"href": "http://example.com"
},
"items": {
"href": "http://example.com"
}
},
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.394Z",
"creatorId": "string",
"itemCount": 0,
"updatedAt": "2022-08-15T13:39:45.394Z",
"updaterId": "string",
"description": "string"
}
],
"links": {
"item": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
Returns published items for a given item.
Finds and returns the published items for a given item.
Path Parameters GET /v1/items/{itemId}/publisheditems
itemId string | The item's unique identifier |
Query Parameters GET /v1/items/{itemId}/publisheditems
limit optional, minimum=1, maximum=100 integer | The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive). |
next optional string | The cursor to the next page of resources. Provide either the next or prev cursor, but not both. |
prev optional string | The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. |
resourceType optional | The case-sensitive string used to search for an item by resourceType. |
sort optional 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. Enum: +createdAt -createdAt +name -name +updatedAt -updatedAt |
Responses GET /v1/items/{itemId}/publisheditems
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
GET/v1/items/{itemId}/publisheditems
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/{itemId}/publisheditems" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/items/{itemId}/publisheditems
{
"data": [
{
"id": "string",
"meta": {
"items": {
"data": [
{
"id": "string",
"meta": {
"tags": [
{
"id": "string",
"name": "string"
}
],
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true
},
"name": "string",
"links": {
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
},
"collections": {
"href": "http://example.com"
}
},
"actions": [],
"ownerId": "string",
"spaceId": "string",
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.394Z",
"creatorId": "string",
"itemViews": {
"week": [
{
"start": "2022-08-15T13:39:45.394Z",
"total": 0,
"unique": 0
}
],
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0
},
"updatedAt": "2022-08-15T13:39:45.394Z",
"updaterId": "string",
"resourceId": "string",
"description": "string",
"isFavorited": true,
"thumbnailId": "string",
"resourceLink": "http://example.com",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceType": "app",
"collectionIds": [],
"resourceSubType": "string",
"resourceCreatedAt": "2022-08-15T13:39:45.394Z",
"resourceUpdatedAt": "2022-08-15T13:39:45.394Z",
"resourceAttributes": {},
"resourceReloadStatus": "string",
"resourceReloadEndTime": "2022-08-15T13:39:45.394Z",
"resourceCustomAttributes": {}
}
],
"links": {
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"collection": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"type": "public",
"links": {
"self": {
"href": "http://example.com"
},
"items": {
"href": "http://example.com"
}
},
"tenantId": "string",
"createdAt": "2022-08-15T13:39:45.394Z",
"creatorId": "string",
"itemCount": 0,
"updatedAt": "2022-08-15T13:39:45.394Z",
"updaterId": "string",
"description": "string"
}
],
"links": {
"item": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
Returns tenant specific settings.
Finds and returns the settings for the current tenant.
Responses GET /v1/items/settings
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
500 application/json | Internal Server Error response. |
GET/v1/items/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/settings" \
-H "Authorization: Bearer <API-key>"
Response GET /v1/items/settings
{
"usageMetricsEnabled": true
}
Patches tenant specific settings.
Updates the settings provided in the patch body.
Request Body PATCH /v1/items/settings
application/json | No description |
Responses PATCH /v1/items/settings
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
403 application/json | Forbidden response. |
500 application/json | Internal Server Error response. |
PATCH/v1/items/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/items/settings" \
-X PATCH \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"op":"replace","path":"/usageMetricsEnabled","value":true}'
Request PATCH /v1/items/settings
{
"op": "replace",
"path": "/usageMetricsEnabled",
"value": true
}
Response PATCH /v1/items/settings
{
"usageMetricsEnabled": true
}
X-B3-Traceid
stringThe TraceId for the trace associated with the call stack. Every span in a trace shares this ID.
noActionParam
booleanIf 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).
collectionLinksResponseBody
objectProperties
self optional | No description |
items optional | No description |
collectionMetaResponseBody
objectCollection metadata and computed fields.
Properties
items optional | Multiple items. |
collectionResultResponseBody
objectA collection.
Properties
id string | The collection's unique identifier. |
meta optional | Collection metadata and computed fields. |
name string | No description |
type string | The collection's type. Enum: public private favorite |
links optional | No description |
tenantId string | The ID of the tenant that owns the collection. This property is populated by using JWT. |
createdAt string<date-time> | The RFC3339 datetime when the collection was created. |
creatorId optional string | The ID of the user who created the collection. This property is only populated if the JWT contains a userId. |
itemCount integer<int64> | The number of items that have been added to the collection. |
updatedAt string<date-time> | The RFC3339 datetime when the collection was last updated. |
updaterId optional string | The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId. |
description optional string | No description |
collectionsLinksResponseBody
objectProperties
item optional | No description |
next optional | No description |
prev optional | No description |
self optional | No description |
ErrorResponseBody
objectProperties
errors | No description |
itemLinksResponseBody
objectProperties
open optional | No description |
self optional | No description |
thumbnail optional | No description |
collections optional | No description |
itemMetaResponseBody
objectItem metadata and computed fields.
Properties
tags | An array of tags that the item is part of. |
actions Array<string> | The actions that the user can perform on the item. |
collections | An array of collections that the item is part of. |
isFavorited boolean | The flag that indicates if item is in the user's favorites collection. |
itemResourceTypeEnum
stringThe case-sensitive string defining the item's type.
Enum:
app
collection
qlikview
insight
qvapp
genericlink
sharingservicetask
note
dataasset
dataset
automation
itemResultResponseBody
objectAn item.
Properties
id string | The item's unique identifier. |
meta optional | Item metadata and computed fields. |
name string | No description |
links optional | No description |
actions Array<string> | The actions that the user can perform on the item. |
ownerId optional string | The ID of the user who owns the item. |
spaceId optional string | The space's unique identifier. |
tenantId string | The ID of the tenant that owns the item. This is populated using the JWT. |
createdAt string<date-time> | The RFC3339 datetime when the item was created. |
creatorId optional string | The ID of the user who created the item. This is only populated if the JWT contains a userId. |
itemViews optional | No description |
updatedAt string<date-time> | The RFC3339 datetime when the item was last updated. |
updaterId optional string | ID of the user who last updated the item. This is only populated if the JWT contains a userId. |
resourceId optional 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 optional string | No description |
isFavorited boolean | The flag that indicates if item is in the user's favorites collection. |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
resourceLink optional string<uri> | 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. |
resourceSize optional | No description |
resourceType | The case-sensitive string defining the item's type. Enum: app collection qlikview insight qvapp genericlink sharingservicetask note dataasset dataset automation |
collectionIds Array<string> | The ID of the collections that the item has been added to. |
resourceSubType optional string | Optional field defining the item's subtype, if any. |
resourceCreatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was created. |
resourceUpdatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was last updated. |
resourceAttributes object | No description |
resourceReloadStatus optional string | If the resource last reload was successful or not. |
resourceReloadEndTime optional string<date-time> | The RFC3339 datetime when the resource last reload ended. |
resourceCustomAttributes object | No description |
ItemsCreateItemRequestBody
objectProperties
name string | No description |
spaceId optional string | The space's unique identifier. |
resourceId optional 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 optional string | No description |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
resourceLink optional string<uri> | 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. |
resourceType | The case-sensitive string defining the item's type. Enum: app collection qlikview insight qvapp genericlink sharingservicetask note dataasset dataset automation |
resourceSubType optional string | Optional field defining the item's subtype, if any. |
resourceCreatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was created. |
resourceUpdatedAt optional string<date-time> | The RFC3339 datetime when the resource that the item references was last updated. |
resourceAttributes optional object | No description |
resourceCustomAttributes optional object | No description |
itemsLinksResponseBody
objectProperties
next optional | No description |
prev optional | No description |
self optional | No description |
collection optional | No description |
ItemsListItemCollectionsResponseBody
objectListItemCollectionsResponseBody result type
Properties
data | No description |
links optional | No description |
ItemsListItemsResponseBody
objectListItemsResponseBody result type
Properties
data | No description |
links optional | No description |
itemsResourceSizeResponseBody
objectProperties
appFile number | Size of the app on disk in bytes. |
appMemory number | Size of the app in memory in bytes. |
itemsResultResponseBody
objectMultiple items.
Properties
data | No description |
links optional | No description |
ItemsSettingsPatch
Array<object>Properties
op string | The operation to be performed. Only "replace" is supported. Enum: replace |
path string | Field of Settings to be patched (updated). Enum: /usageMetricsEnabled |
value boolean | The value to be used within the operations. |
ItemsSettingsResponseBody
objectProperties
usageMetricsEnabled default=true boolean | Decides if the usage metrics will be shown in the hub UI. |
ItemsUpdateItemRequestBody
objectProperties
name optional string | No description |
spaceId optional string | The space's unique identifier. |
resourceId optional 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 optional string | No description |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
resourceLink optional string<uri> | 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. |
resourceType | The case-sensitive string defining the item's type. Enum: app collection qlikview insight qvapp genericlink sharingservicetask note dataasset dataset automation |
resourceSubType optional string | Optional field defining the item's subtype, if any. |
resourceUpdatedAt optional string<date-time> | The RFC3339 datetime when the resource that the item references was last updated. |
resourceAttributes optional object | No description |
resourceCustomAttributes optional object | No description |
itemTagResponseBody
objectHolds basic information about a tag or collection.
Properties
id string | The ID of the tag/collection. |
name string | The name of the tag/collection. |
itemViewsResponseBody
objectProperties
week | No description |
total integer | Total number of views the resource got during the last 28 days. |
trend minimum=-1, maximum=1 number | Trend in views over the last 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). |
itemViewsWeeksResponseBody
objectProperties
start string<date-time> | The RFC3339 datetime representing the start of the referenced week. |
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. |
Link
objectProperties
href string<uri> | No description |
meta
objectProperties
fault boolean | Is the error a server-side fault? |
timeout boolean | Is the error a timeout? |
temporary boolean | Is the error temporary? |
ServiceError
objectProperties
code string | Code is a unique identifier for this error class. |
meta optional | No description |
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. |