Skip to content

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 section
GET/v1/collections
POST/v1/collections
GET/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 collections that the user has access to.

manage

Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.

Facts GET /v1/collections

Rate limit
required
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/collections

creatorId
string

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

id
string

The collection's unique identifier.

includeItems
string

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

limit
default=10, 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
string

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

next
string

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

prev
string

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

query
string

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

sort
string

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

Enum:

+createdAt

-createdAt

+name

-name

+updatedAt

-updatedAt

type

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

types

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

Responses GET /v1/collections

200

OK response.

400
application/json

Bad Request response.

401
application/json

Unauthorized response.

500
application/json

Internal Server Error response.

GET/v1/collections

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

Response GET /v1/collections

{
  "data": [
    {
      "id": "string",
      "full": true,
      "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": "2023-11-29T00:09:25.895Z",
              "creatorId": "string",
              "itemViews": {
                "week": [
                  {
                    "start": "2023-11-29T00:09:25.895Z",
                    "total": 0,
                    "unique": 0
                  }
                ],
                "total": 0,
                "trend": -4.2,
                "unique": 0,
                "usedBy": 0
              },
              "updatedAt": "2023-11-29T00:09:25.895Z",
              "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": "2023-11-29T00:09:25.895Z",
              "resourceUpdatedAt": "2023-11-29T00:09:25.895Z",
              "resourceAttributes": {},
              "resourceReloadStatus": "string",
              "resourceReloadEndTime": "2023-11-29T00:09:25.895Z",
              "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": "private",
      "links": {
        "self": {
          "href": "http://example.com"
        },
        "items": {
          "href": "http://example.com"
        }
      },
      "tenantId": "string",
      "createdAt": "2023-11-29T00:09:25.895Z",
      "creatorId": "string",
      "itemCount": 0,
      "updatedAt": "2023-11-29T00:09:25.895Z",
      "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"
    }
  }
}

Creates a new collection.

manage

Creates and returns a new collection. Collections can have the same name.

Facts POST /v1/collections

Rate limit
required
Tier 2 (100 requests per minute)

Request Body POST /v1/collections

No description

Responses POST /v1/collections

201

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/v1/collections

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

Request POST /v1/collections

{
  "name": "string",
  "type": "private",
  "description": "string"
}

Response POST /v1/collections

{
  "id": "string",
  "full": true,
  "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": "2023-11-29T00:09:25.895Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2023-11-29T00:09:25.895Z",
                "total": 0,
                "unique": 0
              }
            ],
            "total": 0,
            "trend": -4.2,
            "unique": 0,
            "usedBy": 0
          },
          "updatedAt": "2023-11-29T00:09:25.895Z",
          "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": "2023-11-29T00:09:25.895Z",
          "resourceUpdatedAt": "2023-11-29T00:09:25.895Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2023-11-29T00:09:25.895Z",
          "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": "private",
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "items": {
      "href": "http://example.com"
    }
  },
  "tenantId": "string",
  "createdAt": "2023-11-29T00:09:25.895Z",
  "creatorId": "string",
  "itemCount": 0,
  "updatedAt": "2023-11-29T00:09:25.895Z",
  "updaterId": "string",
  "description": "string"
}

Returns a collection.

manage

Finds and returns a collection.

Facts GET /v1/collections/{collectionId}

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/collections/{collectionId}

collectionId
required
string

The collection's unique identifier.

Responses GET /v1/collections/{collectionId}

200

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/collections/{collectionId}

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

Response GET /v1/collections/{collectionId}

{
  "id": "string",
  "full": true,
  "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": "2023-11-29T00:09:25.895Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2023-11-29T00:09:25.895Z",
                "total": 0,
                "unique": 0
              }
            ],
            "total": 0,
            "trend": -4.2,
            "unique": 0,
            "usedBy": 0
          },
          "updatedAt": "2023-11-29T00:09:25.895Z",
          "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": "2023-11-29T00:09:25.895Z",
          "resourceUpdatedAt": "2023-11-29T00:09:25.895Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2023-11-29T00:09:25.895Z",
          "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": "private",
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "items": {
      "href": "http://example.com"
    }
  },
  "tenantId": "string",
  "createdAt": "2023-11-29T00:09:25.895Z",
  "creatorId": "string",
  "itemCount": 0,
  "updatedAt": "2023-11-29T00:09:25.895Z",
  "updaterId": "string",
  "description": "string"
}

Updates a collection.

manage

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

Facts PUT /v1/collections/{collectionId}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters PUT /v1/collections/{collectionId}

collectionId
required
string

The collection's unique identifier.

Request Body PUT /v1/collections/{collectionId}

No description

Responses PUT /v1/collections/{collectionId}

200

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/v1/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 '{"name":"string","description":"string"}'

Request PUT /v1/collections/{collectionId}

{
  "name": "string",
  "description": "string"
}

Response PUT /v1/collections/{collectionId}

{
  "id": "string",
  "full": true,
  "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": "2023-11-29T00:09:25.896Z",
          "creatorId": "string",
          "itemViews": {
            "week": [
              {
                "start": "2023-11-29T00:09:25.896Z",
                "total": 0,
                "unique": 0
              }
            ],
            "total": 0,
            "trend": -4.2,
            "unique": 0,
            "usedBy": 0
          },
          "updatedAt": "2023-11-29T00:09:25.896Z",
          "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": "2023-11-29T00:09:25.896Z",
          "resourceUpdatedAt": "2023-11-29T00:09:25.896Z",
          "resourceAttributes": {},
          "resourceReloadStatus": "string",
          "resourceReloadEndTime": "2023-11-29T00:09:25.896Z",
          "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": "private",
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "items": {
      "href": "http://example.com"
    }
  },
  "tenantId": "string",
  "createdAt": "2023-11-29T00:09:25.896Z",
  "creatorId": "string",
  "itemCount": 0,
  "updatedAt": "2023-11-29T00:09:25.896Z",
  "updaterId": "string",
  "description": "string"
}

Deletes a collection.

manage

Deletes a collection and removes all items from the collection.

Facts DELETE /v1/collections/{collectionId}

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/collections/{collectionId}

collectionId
required
string

The collection's unique identifier.

Responses DELETE /v1/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/v1/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.

manage

Finds and returns items from a collection that the user has access to.

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

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/collections/{collectionId}/items

collectionId
required
string

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

Query Parameters GET /v1/collections/{collectionId}/items

limit
default=10, 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
string

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

next
string

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

prev
string

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

query
string

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

resourceId
string

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

resourceLink
string<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 used to search for an item by resourceType.

sort
string

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

Enum:

+createdAt

-createdAt

+name

-name

+updatedAt

-updatedAt

spaceId
string

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

shared
deprecated
boolean

Whether or not to return items in a shared space.

noActions

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/collections/{collectionId}/items

200

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/collections/{collectionId}/items

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

Response GET /v1/collections/{collectionId}/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": "2023-11-29T00:09:25.896Z",
      "creatorId": "string",
      "itemViews": {
        "week": [
          {
            "start": "2023-11-29T00:09:25.896Z",
            "total": 0,
            "unique": 0
          }
        ],
        "total": 0,
        "trend": -4.2,
        "unique": 0,
        "usedBy": 0
      },
      "updatedAt": "2023-11-29T00:09:25.896Z",
      "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": "2023-11-29T00:09:25.896Z",
      "resourceUpdatedAt": "2023-11-29T00:09:25.896Z",
      "resourceAttributes": {},
      "resourceReloadStatus": "string",
      "resourceReloadEndTime": "2023-11-29T00:09:25.896Z",
      "resourceCustomAttributes": {}
    }
  ]
}

Adds an item to a collection.

manage

Adds an item to a collection and returns the item.

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters POST /v1/collections/{collectionId}/items

collectionId
required
string

The collection's unique identifier.

Request Body POST /v1/collections/{collectionId}/items

No description

Responses POST /v1/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/v1/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 /v1/collections/{collectionId}/items

{
  "id": "string"
}

Response POST /v1/collections/{collectionId}/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": "2023-11-29T00:09:25.896Z",
  "creatorId": "string",
  "itemViews": {
    "week": [
      {
        "start": "2023-11-29T00:09:25.896Z",
        "total": 0,
        "unique": 0
      }
    ],
    "total": 0,
    "trend": -4.2,
    "unique": 0,
    "usedBy": 0
  },
  "updatedAt": "2023-11-29T00:09:25.896Z",
  "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": "2023-11-29T00:09:25.896Z",
  "resourceUpdatedAt": "2023-11-29T00:09:25.896Z",
  "resourceAttributes": {},
  "resourceReloadStatus": "string",
  "resourceReloadEndTime": "2023-11-29T00:09:25.896Z",
  "resourceCustomAttributes": {}
}

Returns an item in a specific collection.

manage

Finds and returns an item. See GET /items/{id}

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

Rate limit
required
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/collections/{collectionId}/items/{itemId}

collectionId
required
string

The collection's unique identifier.

itemId
required
string

The item's unique identifier.

Responses GET /v1/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/v1/collections/{collectionId}/items/{itemId}

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

Response GET /v1/collections/{collectionId}/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": "2023-11-29T00:09:25.896Z",
  "creatorId": "string",
  "itemViews": {
    "week": [
      {
        "start": "2023-11-29T00:09:25.896Z",
        "total": 0,
        "unique": 0
      }
    ],
    "total": 0,
    "trend": -4.2,
    "unique": 0,
    "usedBy": 0
  },
  "updatedAt": "2023-11-29T00:09:25.896Z",
  "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": "2023-11-29T00:09:25.896Z",
  "resourceUpdatedAt": "2023-11-29T00:09:25.896Z",
  "resourceAttributes": {},
  "resourceReloadStatus": "string",
  "resourceReloadEndTime": "2023-11-29T00:09:25.896Z",
  "resourceCustomAttributes": {}
}

Removes an item from a collection.

manage

Removes an item from a collection.

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

Rate limit
required
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/collections/{collectionId}/items/{itemId}

collectionId
required
string

The collection's unique identifier.

itemId
required
string

The item's unique identifier.

Responses DELETE /v1/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/v1/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.

manage

Finds and returns the user's favorites collection.

Facts GET /v1/collections/favorites

Rate limit
required
Tier 1 (1000 requests per minute)

Responses GET /v1/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/v1/collections/favorites

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

X-B3-Traceid

string

The TraceId for the trace associated with the call stack. Every span in a trace shares this ID.

noActionParam

boolean

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

collectionLinksResponseBody

object

Properties

self

No description

items

No description

collectionMetaResponseBody

object

Collection metadata and computed fields.

Properties

items

Multiple items.

collectionResultResponseBody

object

A collection.

Properties

id
required
string

The collection's unique identifier.

full
boolean

States if a collection has reached its items limit or not

meta

Collection metadata and computed fields.

name
required
string

No description

type
required
string

No description

Enum:

private

public

favorite

publicgoverned

links

No description

tenantId
required
string

The ID of the tenant that owns the collection. This property is populated by using JWT.

createdAt
required
string<date-time>

The RFC3339 datetime when the collection was created.

creatorId
string

The ID of the user who created the collection. This property is only populated if the JWT contains a userId.

itemCount
required
integer<int64>

The number of items that have been added to the collection that the user has access to.

updatedAt
required
string<date-time>

The RFC3339 datetime when the collection was last updated.

updaterId
string

The ID of the user who last updated the collection. This property is only populated if the JWT contains a userId.

description
string

No description

CollectionsAddCollectionItemRequestBody

object

Properties

id
required
string

The item's unique identifier.

CollectionsCreateCollectionRequestBody

object

Properties

name
required
string

No description

type

No description

Enum:

private

public

publicgoverned

description
string

No description

collectionsLinksResponseBody

object

Properties

item

No description

next

No description

prev

No description

self

No description

CollectionsListCollectionItemsResponseBody

object

ListCollectionItemsResponseBody result type

Properties

data
required

No description

CollectionsListCollectionsResponseBody

object

ListCollectionsResponseBody result type

Properties

data

No description

links

No description

CollectionsUpdateCollectionRequestBody

object

Properties

name
string

No description

description
string

No description

CollectionTypes

string

Enum:

private

public

publicgoverned

ErrorResponseBody

object

Properties

errors

No description

itemLinksResponseBody

object

Properties

open

No description

self

No description

thumbnail

No description

collections

No description

itemMetaResponseBody

object

Item metadata and computed fields.

Properties

tags
required

An array of tags that the item is part of.

actions
required
Array<string>

The actions that the user can perform on the item.

collections
required

An array of collections that the item is part of.

isFavorited
required
boolean

The flag that indicates if item is in the user's favorites collection.

itemResourceTypeEnum

string

The case-sensitive string defining the item's type.

Enum:

app

collection

qlikview

insight

qvapp

genericlink

sharingservicetask

note

dataasset

dataset

automation

automl-experiment

automl-deployment

itemResultResponseBody

object

An item.

Properties

id
required
string

The item's unique identifier.

meta

Item metadata and computed fields.

name
required
string

No description

links

No description

actions
required
Array<string>

The actions that the user can perform on the item.

ownerId
string

The ID of the user who owns the item.

spaceId
string

The space's unique identifier.

tenantId
required
string

The ID of the tenant that owns the item. This is populated using the JWT.

createdAt
required
string<date-time>

The RFC3339 datetime when the item was created.

creatorId
string

The ID of the user who created the item. This is only populated if the JWT contains a userId.

itemViews

No description

updatedAt
required
string<date-time>

The RFC3339 datetime when the item was last updated.

updaterId
string

ID of the user who last updated the item. This is only populated if the JWT contains a userId.

resourceId
string

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

description
string

No description

isFavorited
required
boolean

The flag that indicates if item is in the user's favorites collection.

thumbnailId
string

The item thumbnail's unique identifier. This is optional for internal resources.

resourceLink
string<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

No description

resourceType

The case-sensitive string defining the item's type.

Enum:

app

collection

qlikview

insight

qvapp

genericlink

sharingservicetask

note

dataasset

dataset

automation

automl-experiment

automl-deployment

collectionIds
required
Array<string>

The ID of the collections that the item has been added to.

resourceSubType
string

Optional field defining the item's subtype, if any.

resourceCreatedAt
required
string<date-time>

The RFC3339 datetime when the resource that the item references was created.

resourceUpdatedAt
required
string<date-time>

The RFC3339 datetime when the resource that the item references was last updated.

resourceAttributes
required
PII data
object

No description

resourceReloadStatus
string

If the resource last reload was successful or not.

resourceReloadEndTime
string<date-time>

The RFC3339 datetime when the resource last reload ended.

resourceCustomAttributes
required
object

No description

itemsLinksResponseBody

object

Properties

next

No description

prev

No description

self

No description

collection

No description

itemsResourceSizeResponseBody

object

Properties

appFile
number

Size of the app on disk in bytes.

appMemory
number

Size of the app in memory in bytes.

itemsResultResponseBody

object

Multiple items.

Properties

data
required

No description

links

No description

itemTagResponseBody

object

Holds basic information about a tag or collection.

Properties

id
required
string

The ID of the tag/collection.

name
required
string

The name of the tag/collection.

itemViewsResponseBody

object

Properties

week

No description

total
integer

Total number of views the resource got during the last 28 days.

trend
number

Trend in views over the last 4 weeks. The trend value is a float number representing a linear regression slope (the x-coefficient) calculated from the weekly unique users views in the preceding 4 weeks.

unique
integer

Number of unique users who viewed the resource during the last 28 days.

usedBy
integer

Number of apps this dataset is used in (datasets only).

itemViewsWeeksResponseBody

object

Properties

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.

object

Properties

href
string<uri>

No description

meta

object

Properties

fault
boolean

Is the error a server-side fault?

explain
object

Further explanation of the error

timeout
boolean

Is the error a timeout?

temporary
boolean

Is the error temporary?

ServiceError

object

Properties

code
string

Code is a unique identifier for this error class.

meta

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.

v0.879.8
Was this page helpful?