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 section
GET/items
POST/items
GET/items/{itemId}
PUT/items/{itemId}
DELETE/items/{itemId}
GET/items/{itemId}/collections
GET/items/{itemId}/publisheditems

Finds and returns items that the user has access to.

Header ParametersRetrieves items that the user has access to.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Query ParametersRetrieves items that the user has access to.

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

The case-sensitive string used to search for an item by resourceType(s). For example "?resourceType=app,qvapp"

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.

spaceId
optional
string

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

shared
boolean

Whether or not to return items in a shared space.

collectionId
optional
string

The collection's unique identifier.

createdByUserId
optional
string

User's unique identifier.

notCreatedByUserId
optional
string

User's unique identifier.

ownerId
optional
string

Owner identifier.

notOwnerId
optional
string

Owner identifier.

id
optional
string

The item's unique identifier.

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.

ResponsesRetrieves items that the user has access to.

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

/items

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

ResponseRetrieves items that the user has access to.

{
  "data": [
    {
      "actions": [],
      "collectionIds": [],
      "createdAt": "2021-05-07T08:32:54.764Z",
      "creatorId": "string",
      "description": "string",
      "id": "string",
      "isFavorited": true,
      "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": "2021-05-07T08:32:54.764Z",
      "resourceCustomAttributes": {},
      "resourceId": "string",
      "resourceLink": "http://example.com",
      "resourceReloadEndTime": "2021-05-07T08:32:54.764Z",
      "resourceReloadStatus": "string",
      "resourceSize": {
        "appFile": 0,
        "appMemory": 0
      },
      "resourceSubType": "string",
      "resourceType": "app",
      "resourceUpdatedAt": "2021-05-07T08:32:54.764Z",
      "spaceId": "string",
      "tenantId": "string",
      "thumbnailId": "string",
      "updatedAt": "2021-05-07T08:32:54.764Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "collection": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}
experimental

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.

Header ParametersCreates and returns a new item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Request BodyCreates and returns a new item.

No description

ResponsesCreates and returns a new item.

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

/items

curl "https://your-tenant.us.qlikcloud.com/api/v1/items" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"description":"string","name":"string","resourceAttributes":{},"resourceCreatedAt":"2021-05-07T08:32:54.764Z","resourceCustomAttributes":{},"resourceId":"string","resourceLink":"http://example.com","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2021-05-07T08:32:54.764Z","spaceId":"string","thumbnailId":"string"}'

RequestCreates and returns a new item.

{
  "description": "string",
  "name": "string",
  "resourceAttributes": {},
  "resourceCreatedAt": "2021-05-07T08:32:54.764Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceType": "app",
  "resourceSubType": "string",
  "resourceUpdatedAt": "2021-05-07T08:32:54.764Z",
  "spaceId": "string",
  "thumbnailId": "string"
}

ResponseCreates and returns a new item.

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-05-07T08:32:54.764Z",
  "creatorId": "string",
  "description": "string",
  "id": "string",
  "isFavorited": true,
  "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": "2021-05-07T08:32:54.764Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-05-07T08:32:54.764Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-05-07T08:32:54.764Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-05-07T08:32:54.764Z",
  "updaterId": "string"
}

Finds and returns an item.

Header ParametersReturns an item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Path ParametersReturns an item.

itemId
string

The item's unique identifier

ResponsesReturns an item.

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

/items/{itemId}

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

ResponseReturns an item.

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-05-07T08:32:54.764Z",
  "creatorId": "string",
  "description": "string",
  "id": "string",
  "isFavorited": true,
  "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": "2021-05-07T08:32:54.764Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-05-07T08:32:54.764Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-05-07T08:32:54.764Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-05-07T08:32:54.764Z",
  "updaterId": "string"
}
experimental

Updates an item. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.

Header ParametersUpdates an item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Path ParametersUpdates an item.

itemId
string

The item's unique identifier

Request BodyUpdates an item.

No description

ResponsesUpdates an item.

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

/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 '{"description":"string","name":"string","resourceAttributes":{},"resourceCustomAttributes":{},"resourceId":"string","resourceLink":"http://example.com","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2021-05-07T08:32:54.764Z","spaceId":"string","thumbnailId":"string"}'

RequestUpdates an item.

{
  "description": "string",
  "name": "string",
  "resourceAttributes": {},
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceType": "app",
  "resourceSubType": "string",
  "resourceUpdatedAt": "2021-05-07T08:32:54.764Z",
  "spaceId": "string",
  "thumbnailId": "string"
}

ResponseUpdates an item.

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-05-07T08:32:54.765Z",
  "creatorId": "string",
  "description": "string",
  "id": "string",
  "isFavorited": true,
  "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": "2021-05-07T08:32:54.765Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-05-07T08:32:54.765Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-05-07T08:32:54.765Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-05-07T08:32:54.765Z",
  "updaterId": "string"
}
experimental

Deletes an item and removes the item from all collections.

Header ParametersDeletes an item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Path ParametersDeletes an item.

itemId
string

The item's unique identifier

ResponsesDeletes an item.

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

/items/{itemId}

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

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

Header ParametersReturns the collections of an item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Path ParametersReturns the collections of an item.

itemId
string

The item's unique identifier

Query ParametersReturns the collections of an item.

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

ResponsesReturns the collections of an item.

200

OK response.

400
application/json

Bad Request response.

401
application/json

Unauthorized response.

500
application/json

Internal Server Error response.

GET

/items/{itemId}/collections

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

ResponseReturns the collections of an item.

{
  "data": [
    {
      "createdAt": "2021-05-07T08:32:54.765Z",
      "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": "2021-05-07T08:32:54.765Z",
              "creatorId": "string",
              "description": "string",
              "id": "string",
              "isFavorited": true,
              "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": "2021-05-07T08:32:54.765Z",
              "resourceCustomAttributes": {},
              "resourceId": "string",
              "resourceLink": "http://example.com",
              "resourceReloadEndTime": "2021-05-07T08:32:54.765Z",
              "resourceReloadStatus": "string",
              "resourceSize": {
                "appFile": 0,
                "appMemory": 0
              },
              "resourceSubType": "string",
              "resourceType": "app",
              "resourceUpdatedAt": "2021-05-07T08:32:54.765Z",
              "spaceId": "string",
              "tenantId": "string",
              "thumbnailId": "string",
              "updatedAt": "2021-05-07T08:32:54.765Z",
              "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": "2021-05-07T08:32:54.765Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "item": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

Finds and returns the published items for a given item.

Header ParametersReturns published items for a given item.

Authorization
string

The JWT used for authentication. Send the JWT in the Authorization header using the Bearer schema.

Path ParametersReturns published items for a given item.

itemId
string

The item's unique identifier

Query ParametersReturns published items for a given item.

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

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

ResponsesReturns published items for a given item.

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

/items/{itemId}/publisheditems

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

ResponseReturns published items for a given item.

{
  "data": [
    {
      "createdAt": "2021-05-07T08:32:54.765Z",
      "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": "2021-05-07T08:32:54.765Z",
              "creatorId": "string",
              "description": "string",
              "id": "string",
              "isFavorited": true,
              "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": "2021-05-07T08:32:54.765Z",
              "resourceCustomAttributes": {},
              "resourceId": "string",
              "resourceLink": "http://example.com",
              "resourceReloadEndTime": "2021-05-07T08:32:54.765Z",
              "resourceReloadStatus": "string",
              "resourceSize": {
                "appFile": 0,
                "appMemory": 0
              },
              "resourceSubType": "string",
              "resourceType": "app",
              "resourceUpdatedAt": "2021-05-07T08:32:54.765Z",
              "spaceId": "string",
              "tenantId": "string",
              "thumbnailId": "string",
              "updatedAt": "2021-05-07T08:32:54.765Z",
              "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": "2021-05-07T08:32:54.765Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "item": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

PropertiesCollectionsAddCollectionItemRequestBody

id
string

The item's unique identifier.

PropertiesCollectionsCreateCollectionRequestBody

description
optional
string

No description

name
string

No description

type
string

The collection's type.

Enum:

public

private

ListCollectionItemsResponseBody result type

PropertiesCollectionsListCollectionItemsResponseBody

data

No description

ListCollectionsResponseBody result type

PropertiesCollectionsListCollectionsResponseBody

data

No description

links

No description

PropertiesCollectionsUpdateCollectionRequestBody

description
string

No description

name
string

No description

PropertiesItemsCreateItemRequestBody

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

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.

ListItemCollectionsResponseBody result type

PropertiesItemsListItemCollectionsResponseBody

data

No description

links

No description

ListItemsResponseBody result type

PropertiesItemsListItemsResponseBody

data

No description

links

No description

meta

object

Propertiesmeta

fault
boolean

Is the error a server-side fault?

temporary
boolean

Is the error temporary?

timeout
boolean

Is the error a timeout?

PropertiesServiceError

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

PropertiesErrorResponseBody

errors

No description

PropertiesItemsUpdateItemRequestBody

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

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.

PropertiescollectionLinksResponseBody

items

No description

self

No description

Collection metadata and computed fields.

PropertiescollectionMetaResponseBody

items

Multiple items.

A collection.

PropertiescollectionResultResponseBody

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

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.

PropertiescollectionsLinksResponseBody

item

No description

next

No description

prev

No description

self

No description

PropertiesitemLinksResponseBody

collections

No description

open

No description

self

No description

thumbnail

No description

Item metadata and computed fields.

PropertiesitemMetaResponseBody

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.

An item.

PropertiesitemResultResponseBody

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.

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

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

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.

Holds basic information about a tag or collection.

PropertiesitemTagResponseBody

id
string

The ID of the tag/collection.

name
string

The name of the tag/collection.

PropertiesitemsLinksResponseBody

collection

No description

next

No description

prev

No description

self

No description

PropertiesitemsResourceSizeResponseBody

appFile
number

Size of the app on disk in bytes

appMemory
number

Size of the app in memory in bytes

Multiple items.

PropertiesitemsResultResponseBody

data

No description

links

No description

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

v1.22.1
Was this page helpful?