Collections
Collections is a way to catalog various content a user has access to, and group that content based on various properties.
Endpoints
Skip to sectionGET | /collections |
POST | /collections |
GET | /collections/{collectionId} |
PUT | /collections/{collectionId} |
DELETE | /collections/{collectionId} |
GET | /collections/{collectionId}/items |
POST | /collections/{collectionId}/items |
GET | /collections/{collectionId}/items/{itemId} |
DELETE | /collections/{collectionId}/items/{itemId} |
GET | /collections/favorites |
Retrieves collections that the user has access to.
Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.
Query Parameters GET /collections
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. |
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). |
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 |
query optional string | The case-insensitive string used to search for a resource by name or description. |
type optional string | The case-sensitive string used to search for a collection by type. Enum: public private |
name optional string | The case-sensitive string used to search for a collection by name. |
creatorId optional string | The case-sensitive string used to search for a resource by creatorId. |
id optional string | The collection's unique identifier. |
includeItems optional string | JSON-formatted string for querying collection items. |
Responses GET /collections
200 application/json | OK response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
500 application/json | Internal Server Error response. |
GET/collections
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections" \
-H "Authorization: Bearer <API-key>"
Response GET /collections
{
"data": [
{
"createdAt": "2022-05-18T10:58:20.652Z",
"creatorId": "string",
"description": "string",
"id": "string",
"itemCount": 0,
"links": {
"items": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
},
"meta": {
"items": {
"data": [
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.652Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.652Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.652Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.652Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.652Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.652Z",
"updaterId": "string"
}
],
"links": {
"collection": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"tenantId": "string",
"type": "public",
"updatedAt": "2022-05-18T10:58:20.652Z",
"updaterId": "string"
}
],
"links": {
"item": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
Creates a new collection.
Creates and returns a new collection. Collections can have the same name.
Request Body POST /collections
application/json | No description |
Responses POST /collections
201 application/json | Created response. |
400 application/json | Bad Request response. |
401 application/json | Unauthorized response. |
403 application/json | Forbidden response. |
409 application/json | Conflict response. |
500 application/json | Internal Server Error response. |
POST/collections
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"description":"string","name":"string","type":"public"}'
Request POST /collections
{
"description": "string",
"name": "string",
"type": "public"
}
Response POST /collections
{
"createdAt": "2022-05-18T10:58:20.652Z",
"creatorId": "string",
"description": "string",
"id": "string",
"itemCount": 0,
"links": {
"items": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
},
"meta": {
"items": {
"data": [
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
],
"links": {
"collection": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"tenantId": "string",
"type": "public",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
Returns a collection.
Finds and returns a collection.
Path Parameters GET /collections/{collectionId}
collectionId string | The collection's unique identifier. |
Responses GET /collections/{collectionId}
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/collections/{collectionId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-H "Authorization: Bearer <API-key>"
Response GET /collections/{collectionId}
{
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"itemCount": 0,
"links": {
"items": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
},
"meta": {
"items": {
"data": [
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
],
"links": {
"collection": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"tenantId": "string",
"type": "public",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
Updates a collection.
Updates a collection and returns the new collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
Path Parameters PUT /collections/{collectionId}
collectionId string | The collection's unique identifier. |
Request Body PUT /collections/{collectionId}
application/json | No description |
Responses PUT /collections/{collectionId}
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. |
PUT/collections/{collectionId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-X PUT \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"description":"string","name":"string"}'
Request PUT /collections/{collectionId}
{
"description": "string",
"name": "string"
}
Response PUT /collections/{collectionId}
{
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"itemCount": 0,
"links": {
"items": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
},
"meta": {
"items": {
"data": [
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
],
"links": {
"collection": {
"href": "http://example.com"
},
"next": {
"href": "http://example.com"
},
"prev": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
}
}
}
},
"name": "string",
"tenantId": "string",
"type": "public",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
Deletes a collection.
Deletes a collection and removes all items from the collection.
Path Parameters DELETE /collections/{collectionId}
collectionId string | The collection's unique identifier. |
Responses DELETE /collections/{collectionId}
204 object | No Content response. |
401 application/json | Unauthorized response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
DELETE/collections/{collectionId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Retrieves items in a collection.
Finds and returns items from a collection that the user has access to.
Path Parameters GET /collections/{collectionId}/items
collectionId string | The collection's unique identifier. (This query also supports 'favorites' as the collectionID). |
Query Parameters GET /collections/{collectionId}/items
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. |
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). |
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 |
resourceType optional | The case-sensitive string used to search for an item by resourceType. |
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. |
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. |
query optional string | The case-insensitive string used to search for a resource by name or description. |
name optional string | The case-insensitive string used to search for a resource by name. |
spaceId optional string | The space's unique identifier (supports 'personal' as spaceId). |
shared boolean | Whether or not to return items in a shared space. |
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 /collections/{collectionId}/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/collections/{collectionId}/items
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/items" \
-H "Authorization: Bearer <API-key>"
Response GET /collections/{collectionId}/items
{
"data": [
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
]
}
Adds an item to a collection.
Adds an item to a collection and returns the item.
Path Parameters POST /collections/{collectionId}/items
collectionId string | The collection's unique identifier. |
Request Body POST /collections/{collectionId}/items
application/json | No description |
Responses POST /collections/{collectionId}/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/collections/{collectionId}/items
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/items" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-H "Content-type: application/json" \
-d '{"id":"string"}'
Request POST /collections/{collectionId}/items
{
"id": "string"
}
Response POST /collections/{collectionId}/items
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
Returns an item in a specific collection.
Finds and returns an item. See GET /items/{id}
Path Parameters GET /collections/{collectionId}/items/{itemId}
collectionId string | The collection's unique identifier. |
itemId string | The item's unique identifier. |
Responses GET /collections/{collectionId}/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/collections/{collectionId}/items/{itemId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/items/{itemId}" \
-H "Authorization: Bearer <API-key>"
Response GET /collections/{collectionId}/items/{itemId}
{
"actions": [],
"collectionIds": [],
"createdAt": "2022-05-18T10:58:20.653Z",
"creatorId": "string",
"description": "string",
"id": "string",
"isFavorited": true,
"itemViews": {
"total": 0,
"trend": -1,
"unique": 0,
"usedBy": 0,
"week": [
{
"start": "2022-05-18T10:58:20.653Z",
"total": 0,
"unique": 0
}
]
},
"links": {
"collections": {
"href": "http://example.com"
},
"open": {
"href": "http://example.com"
},
"self": {
"href": "http://example.com"
},
"thumbnail": {
"href": "http://example.com"
}
},
"meta": {
"actions": [],
"collections": [
{
"id": "string",
"name": "string"
}
],
"isFavorited": true,
"tags": [
{
"id": "string",
"name": "string"
}
]
},
"ownerId": "string",
"name": "string",
"resourceAttributes": {},
"resourceCreatedAt": "2022-05-18T10:58:20.653Z",
"resourceCustomAttributes": {},
"resourceId": "string",
"resourceLink": "http://example.com",
"resourceReloadEndTime": "2022-05-18T10:58:20.653Z",
"resourceReloadStatus": "string",
"resourceSize": {
"appFile": 0,
"appMemory": 0
},
"resourceSubType": "string",
"resourceType": "app",
"resourceUpdatedAt": "2022-05-18T10:58:20.653Z",
"spaceId": "string",
"tenantId": "string",
"thumbnailId": "string",
"updatedAt": "2022-05-18T10:58:20.653Z",
"updaterId": "string"
}
Removes an item from a collection.
Removes an item from a collection.
Path Parameters DELETE /collections/{collectionId}/items/{itemId}
collectionId string | The collection's unique identifier. |
itemId string | The item's unique identifier. |
Responses DELETE /collections/{collectionId}/items/{itemId}
204 object | No Content 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. |
DELETE/collections/{collectionId}/items/{itemId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/{collectionId}/items/{itemId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
Retrieves the user's favorites collection.
Finds and returns the user's favorites collection.
Responses GET /collections/favorites
302 application/json object | Found response. |
401 application/json | Unauthorized response. |
404 application/json | Not Found response. |
500 application/json | Internal Server Error response. |
GET/collections/favorites
curl "https://your-tenant.us.qlikcloud.com/api/v1/collections/favorites" \
-H "Authorization: Bearer <API-key>"
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).
CollectionsAddCollectionItemRequestBody
objectProperties
id string | The item's unique identifier. |
CollectionsCreateCollectionRequestBody
objectProperties
description optional string | No description |
name string | No description |
type string | The collection's type. Enum: public private |
CollectionsListCollectionItemsResponseBody
objectListCollectionItemsResponseBody result type
Properties
data | No description |
CollectionsListCollectionsResponseBody
objectListCollectionsResponseBody result type
Properties
data | No description |
links | No description |
CollectionsUpdateCollectionRequestBody
objectProperties
description string | No description |
name string | No description |
ItemsCreateItemRequestBody
objectProperties
description optional string | No description |
name string | No description |
resourceAttributes optional object | No description |
resourceCreatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was created. |
resourceCustomAttributes optional object | No 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. |
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. |
spaceId optional string | The space's unique identifier. |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
ItemsListItemCollectionsResponseBody
objectListItemCollectionsResponseBody result type
Properties
data | No description |
links | No description |
ItemsListItemsResponseBody
objectListItemsResponseBody result type
Properties
data | No description |
links | No description |
meta
objectProperties
fault boolean | Is the error a server-side fault? |
temporary boolean | Is the error temporary? |
timeout boolean | Is the error a timeout? |
ServiceError
objectProperties
code string | Code is a unique identifier for this error class. |
detail string | Detail is a human-readable explanation specific to this occurrence of the problem. |
title string | Title is the name of this class of errors. |
meta | No description |
ErrorResponseBody
objectProperties
errors | No description |
ItemsUpdateItemRequestBody
objectProperties
description optional string | No description |
name optional string | No description |
resourceAttributes optional object | No description |
resourceCustomAttributes optional object | No 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. |
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. |
spaceId optional string | The space's unique identifier. |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
collectionLinksResponseBody
objectProperties
items | No description |
self | No description |
collectionMetaResponseBody
objectCollection metadata and computed fields.
Properties
items | Multiple items. |
collectionResultResponseBody
objectA collection.
Properties
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. |
description optional string | No description |
id string | The collection's unique identifier. |
itemCount integer<int64> | The number of items that have been added to the collection. |
links | No description |
meta optional | Collection metadata and computed fields. |
name string | No description |
tenantId string | The ID of the tenant that owns the collection. This property is populated by using JWT. |
type string | The collection's type. Enum: public private favorite |
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. |
collectionsLinksResponseBody
objectProperties
item | No description |
next | No description |
prev | No description |
self | No description |
Link
objectProperties
href string<uri> | No description |
itemLinksResponseBody
objectProperties
collections | No description |
open | No description |
self | No description |
thumbnail | No description |
itemMetaResponseBody
objectItem metadata and computed fields.
Properties
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. |
tags | An array of tags that the item is part of. |
itemResultResponseBody
objectAn item.
Properties
actions Array<string> | The actions that the user can perform on the item. |
collectionIds Array<string> | The ID of the collections that the item has been added to. |
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. |
description optional string | No description |
id string | The item's unique identifier. |
isFavorited boolean | The flag that indicates if item is in the user's favorites collection. |
itemViews optional | No description |
links | No description |
meta | Item metadata and computed fields. |
ownerId optional string | The ID of the user who owns the item. |
name string | No description |
resourceAttributes object | No description |
resourceCreatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was created. |
resourceCustomAttributes object | No 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. |
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. |
resourceReloadEndTime optional string<date-time> | The RFC3339 datetime when the resource last reload ended. |
resourceReloadStatus optional string | If the resource last reload was successful or not. |
resourceSize optional | No description |
resourceSubType optional string | Optional field defining the item's subtype, if any. |
resourceType | The case-sensitive string defining the item's type. Enum: app collection qlikview insight qvapp genericlink sharingservicetask note dataasset dataset automation |
resourceUpdatedAt string<date-time> | The RFC3339 datetime when the resource that the item references was last updated. |
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. |
thumbnailId optional string | The item thumbnail's unique identifier. This is optional for internal resources. |
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. |
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. |
itemsLinksResponseBody
objectProperties
collection | No description |
next | No description |
prev | No description |
self | 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 | No description |
itemResourceTypeEnum
stringThe case-sensitive string defining the item's type.
itemViewsResponseBody
objectProperties
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). |
week | No description |
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. |
ItemsSettingsResponseBody
objectProperties
usageMetricsEnabled default=true boolean | Decides if the usage metrics will be shown in the hub UI. |
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. |
X-B3-Traceid
stringThe TraceId for the trace associated with the call stack. Every span in a trace shares this ID.