Skip to content

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

Retrieves items that the user has access to.

Finds and returns items that the user has access to.

Header Parameters GET /items

Authorization
string

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

Query Parameters GET /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
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 filter items by resourceType(s). For example "?resourceType=app,qvapp"

resourceSubType
optional
string

the case-sensitive string used to filter items by resourceSubType(s). For example "?resourceSubType=chart-monitoring,qix-df,qvd"

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.

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

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

Response GET /items

{
  "data": [
    {
      "actions": [],
      "collectionIds": [],
      "createdAt": "2021-12-06T08:30:27.426Z",
      "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-12-06T08:30:27.426Z",
      "resourceCustomAttributes": {},
      "resourceId": "string",
      "resourceLink": "http://example.com",
      "resourceReloadEndTime": "2021-12-06T08:30:27.426Z",
      "resourceReloadStatus": "string",
      "resourceSize": {
        "appFile": 0,
        "appMemory": 0
      },
      "resourceSubType": "string",
      "resourceType": "app",
      "resourceUpdatedAt": "2021-12-06T08:30:27.426Z",
      "spaceId": "string",
      "tenantId": "string",
      "thumbnailId": "string",
      "updatedAt": "2021-12-06T08:30:27.426Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "collection": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

Creates and returns a new item.

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 Parameters POST /items

Authorization
string

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

Request Body POST /items

No description

Responses POST /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/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-12-06T08:30:27.427Z","resourceCustomAttributes":{},"resourceId":"string","resourceLink":"http://example.com","resourceType":"app","resourceSubType":"string","resourceUpdatedAt":"2021-12-06T08:30:27.427Z","spaceId":"string","thumbnailId":"string"}'

Request POST /items

{
  "description": "string",
  "name": "string",
  "resourceAttributes": {},
  "resourceCreatedAt": "2021-12-06T08:30:27.427Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceType": "app",
  "resourceSubType": "string",
  "resourceUpdatedAt": "2021-12-06T08:30:27.427Z",
  "spaceId": "string",
  "thumbnailId": "string"
}

Response POST /items

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-12-06T08:30:27.427Z",
  "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-12-06T08:30:27.427Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-12-06T08:30:27.427Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-12-06T08:30:27.427Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-12-06T08:30:27.427Z",
  "updaterId": "string"
}

Returns an item.

Finds and returns an item.

Header Parameters GET /items/{itemId}

Authorization
string

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

Path Parameters GET /items/{itemId}

itemId
string

The item's unique identifier

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

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

Response GET /items/{itemId}

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-12-06T08:30:27.427Z",
  "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-12-06T08:30:27.427Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-12-06T08:30:27.427Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-12-06T08:30:27.427Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-12-06T08:30:27.427Z",
  "updaterId": "string"
}

Updates an item.

experimental

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

Header Parameters PUT /items/{itemId}

Authorization
string

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

Path Parameters PUT /items/{itemId}

itemId
string

The item's unique identifier.

Request Body PUT /items/{itemId}

No description

Responses PUT /items/{itemId}

200
application/json

OK response.

400
application/json

Bad Request response.

401
application/json

Unauthorized response.

403
application/json

Forbidden response.

404
application/json

Not Found response.

409
application/json

Conflict response.

500
application/json

Internal Server Error response.

PUT/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-12-06T08:30:27.427Z","spaceId":"string","thumbnailId":"string"}'

Request PUT /items/{itemId}

{
  "description": "string",
  "name": "string",
  "resourceAttributes": {},
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceType": "app",
  "resourceSubType": "string",
  "resourceUpdatedAt": "2021-12-06T08:30:27.427Z",
  "spaceId": "string",
  "thumbnailId": "string"
}

Response PUT /items/{itemId}

{
  "actions": [],
  "collectionIds": [],
  "createdAt": "2021-12-06T08:30:27.427Z",
  "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-12-06T08:30:27.427Z",
  "resourceCustomAttributes": {},
  "resourceId": "string",
  "resourceLink": "http://example.com",
  "resourceReloadEndTime": "2021-12-06T08:30:27.427Z",
  "resourceReloadStatus": "string",
  "resourceSize": {
    "appFile": 0,
    "appMemory": 0
  },
  "resourceSubType": "string",
  "resourceType": "app",
  "resourceUpdatedAt": "2021-12-06T08:30:27.427Z",
  "spaceId": "string",
  "tenantId": "string",
  "thumbnailId": "string",
  "updatedAt": "2021-12-06T08:30:27.427Z",
  "updaterId": "string"
}

Deletes an item.

experimental

Deletes an item and removes the item from all collections.

Header Parameters DELETE /items/{itemId}

Authorization
string

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

Path Parameters DELETE /items/{itemId}

itemId
string

The item's unique identifier.

Responses DELETE /items/{itemId}

204
object

No Content response.

401
application/json

Unauthorized response.

403
application/json

Forbidden response.

404
application/json

Not Found response.

500
application/json

Internal Server Error response.

DELETE/items/{itemId}

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

Returns the collections of an item.

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

Header Parameters GET /items/{itemId}/collections

Authorization
string

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

Path Parameters GET /items/{itemId}/collections

itemId
string

The item's unique identifier.

Query Parameters GET /items/{itemId}/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
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.

Responses GET /items/{itemId}/collections

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

Response GET /items/{itemId}/collections

{
  "data": [
    {
      "createdAt": "2021-12-06T08:30:27.427Z",
      "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-12-06T08:30:27.428Z",
              "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-12-06T08:30:27.428Z",
              "resourceCustomAttributes": {},
              "resourceId": "string",
              "resourceLink": "http://example.com",
              "resourceReloadEndTime": "2021-12-06T08:30:27.428Z",
              "resourceReloadStatus": "string",
              "resourceSize": {
                "appFile": 0,
                "appMemory": 0
              },
              "resourceSubType": "string",
              "resourceType": "app",
              "resourceUpdatedAt": "2021-12-06T08:30:27.428Z",
              "spaceId": "string",
              "tenantId": "string",
              "thumbnailId": "string",
              "updatedAt": "2021-12-06T08:30:27.428Z",
              "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-12-06T08:30:27.428Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "item": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

Returns published items for a given item.

Finds and returns the published items for a given item.

Header Parameters GET /items/{itemId}/publisheditems

Authorization
string

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

Path Parameters GET /items/{itemId}/publisheditems

itemId
string

The item's unique identifier

Query Parameters GET /items/{itemId}/publisheditems

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.

Responses GET /items/{itemId}/publisheditems

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

Response GET /items/{itemId}/publisheditems

{
  "data": [
    {
      "createdAt": "2021-12-06T08:30:27.428Z",
      "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-12-06T08:30:27.428Z",
              "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-12-06T08:30:27.428Z",
              "resourceCustomAttributes": {},
              "resourceId": "string",
              "resourceLink": "http://example.com",
              "resourceReloadEndTime": "2021-12-06T08:30:27.428Z",
              "resourceReloadStatus": "string",
              "resourceSize": {
                "appFile": 0,
                "appMemory": 0
              },
              "resourceSubType": "string",
              "resourceType": "app",
              "resourceUpdatedAt": "2021-12-06T08:30:27.428Z",
              "spaceId": "string",
              "tenantId": "string",
              "thumbnailId": "string",
              "updatedAt": "2021-12-06T08:30:27.428Z",
              "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-12-06T08:30:27.428Z",
      "updaterId": "string"
    }
  ],
  "links": {
    "item": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    },
    "self": {
      "href": "http://example.com"
    }
  }
}

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

CollectionsAddCollectionItemRequestBody

object

Properties

id
string

The item's unique identifier.

CollectionsCreateCollectionRequestBody

object

Properties

description
optional
string

No description

name
string

No description

type
string

The collection's type.

Enum:

public

private

CollectionsListCollectionItemsResponseBody

object

ListCollectionItemsResponseBody result type

Properties

data

No description

CollectionsListCollectionsResponseBody

object

ListCollectionsResponseBody result type

Properties

data

No description

links

No description

CollectionsUpdateCollectionRequestBody

object

Properties

description
string

No description

name
string

No description

ItemsCreateItemRequestBody

object

Properties

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

object

ListItemCollectionsResponseBody result type

Properties

data

No description

links

No description

ItemsListItemsResponseBody

object

ListItemsResponseBody result type

Properties

data

No description

links

No description

meta

object

Properties

fault
boolean

Is the error a server-side fault?

temporary
boolean

Is the error temporary?

timeout
boolean

Is the error a timeout?

ServiceError

object

Properties

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

Properties

errors

No description

ItemsUpdateItemRequestBody

object

Properties

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

object

Properties

items

No description

self

No description

collectionMetaResponseBody

object

Collection metadata and computed fields.

Properties

items

Multiple items.

collectionResultResponseBody

object

A 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

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

object

Properties

item

No description

next

No description

prev

No description

self

No description

object

Properties

href
string<uri>

No description

itemLinksResponseBody

object

Properties

collections

No description

open

No description

self

No description

thumbnail

No description

itemMetaResponseBody

object

Item 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

object

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

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

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

object

Holds 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

object

Properties

collection

No description

next

No description

prev

No description

self

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

No description

links

No description

itemResourceTypeEnum

string

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

v1.24.0
Was this page helpful?