Qlik Cloud v2

Provides integration with the Qlik Cloud Analytics REST API for working with users, spaces, apps, catalog items, and app reloads in a Qlik Cloud tenant. Use it to look up users and items, manage spaces and space assignments, create, copy, publish, and delete apps, and submit, monitor, and cancel app reloads.

Revision History

0.0.0.4 - Initial release.

Connection

This Connection identifies the Qlik Cloud tenant and stores the API key used by every Qlik Cloud method.

Setup Notes

• The Qlik Cloud Node is available on Cloud and compatible local Runtime clusters.
• The user who generates the API key needs the Manage API keys permission, which a Tenant Admin can grant. Generate the key from the user's profile settings in Qlik Cloud. See Qlik's Generate your first API key instructions.
• An API key belongs to the user who created it, so every request runs with that user's roles and space permissions. Use a user that can access the spaces, apps, and users you intend to work with. Available operations can also depend on your tenant's licensing.
• API keys are not renewed automatically. If Qlik rejects the key, generate a new one and replace it in the Connection.
• Test Connection retrieves the API key user's own user record. A successful test confirms the tenant and key, but does not confirm the permissions needed for other operations.

Methods

Each method exposes templates for a fixed set of Qlik Cloud REST API operations. Select a template to populate the stable OperationId and the operation-specific Options and Items fields. Each template is named after its HTTP method and path, for example GET /api/v1/users, and its description shows Qlik's summary of the operation.

Options supplies path and query values for the whole invocation. Write methods use Items for request bodies, with one Qlik request per row.

Retrieve

Reads users, catalog items, spaces, space assignments, apps, and reloads. The Node pages through collection results automatically and emits one row for each record.

Available templates:

• GET /api/v1/users - Lists users. Accepts optional filter, sort, fields, and totalResults values.
• GET /api/v1/users/{userId} - Gets a user by ID. Accepts an optional fields value.
• GET /api/v1/users/me - Gets the user who owns the API key.
• GET /api/v1/users/actions/count - Counts the users in the tenant.
• GET /api/v1/items - Lists catalog items. Accepts optional search values such as name, query, resourceType, spaceId, ownerId, and sort.
• GET /api/v1/items/{itemId} - Gets a catalog item.
• GET /api/v1/spaces - Lists spaces. Accepts optional name, type, ownerId, roles, action, sort, and environment filters.
• GET /api/v1/spaces/{spaceId} - Gets a space.
• GET /api/v1/spaces/types - Lists the space types available in the tenant.
• GET /api/v1/spaces/{spaceId}/assignments - Lists the assignments for a space. Accepts optional assigneeId and type filters.
• GET /api/v1/spaces/{spaceId}/assignments/{assignmentId} - Gets a space assignment.
• GET /api/v1/apps/{appId} - Gets an app.
• GET /api/v1/reloads - Lists the reloads for an app. Requires appId and accepts optional filter, sort, log, and partial values.
• GET /api/v1/reloads/{reloadId} - Gets a reload record, including its status.

Create

Creates spaces, space assignments, and apps, copies and publishes apps, and submits app reloads, one request for each row in Items.

Available templates:

• POST /api/v1/spaces - Creates a space. Rows contain name and type, and can include description.
• POST /api/v1/spaces/{spaceId}/assignments - Assigns a user or group to a space. Rows contain type, assigneeId, and roles.
• POST /api/v1/apps - Creates an app.
• POST /api/v1/apps/{appId}/copy - Copies an app.
• POST /api/v1/apps/{appId}/publish - Publishes an app to a managed space. Rows must contain the target spaceId.
• POST /api/v1/reloads - Submits a reload for an app. Rows contain appId, and can include partial and weight.

Update

Updates spaces, space assignments, and apps, republishes apps, and moves apps between spaces, using each row in Items as one request.

Available templates:

• PUT /api/v1/spaces/{spaceId} - Updates a space's name, ownerId, or description.
• PUT /api/v1/spaces/{spaceId}/assignments/{assignmentId} - Updates the roles for a space assignment.
• PUT /api/v1/apps/{appId} - Updates an app's name or description. Each row must contain at least one field.
• PUT /api/v1/apps/{appId}/publish - Republishes a published app to a managed space. Rows must contain the targetId of the published app to replace.
• PUT /api/v1/apps/{appId}/space - Moves an app to a space. Rows must contain the target spaceId.

Delete

Deletes spaces, space assignments, and apps, or removes an app from its space.

Available templates:

• DELETE /api/v1/spaces/{spaceId} - Deletes a space.
• DELETE /api/v1/spaces/{spaceId}/assignments/{assignmentId} - Deletes a space assignment.
• DELETE /api/v1/apps/{appId} - Deletes an app.
• DELETE /api/v1/apps/{appId}/space - Removes an app from its space.

Action

Cancels a reload. Select the POST /api/v1/reloads/{reloadId}/actions/cancel template.

Usage Notes

• The Node supports the operations listed above only. Reload tasks and schedules, app data extraction, file uploads and downloads, and tenant administration APIs are not available.
• Options accepts only the path and query values shown by the selected template. Unknown fields are rejected. Paging is managed by the Node, so limit, next, and prev are not available.
• Options applies to the whole invocation. For Create and Update, every row in Items targets the resource identified in Options. To work with several different spaces or apps, run the Node once per target, for example inside a For Each.
• Delete and Action run once using Options when Items is not connected. When Items is connected, the Node sends one request per row, and an empty Items input sends nothing.
• The GET /api/v1/items template validates related search values: resourceType is required when you use resourceId, resourceIds, or resourceLink, resourceId and resourceLink cannot be combined, and resourceIds accepts at most 100 IDs.
• Filter and sort values such as status eq "active" or +name are passed to Qlik unchanged. Template samples are not applied unless you enter a value.
• When you set fields on a user template, only the selected fields are returned.
• Enter string and integer list fields, such as assignment roles, as comma-separated values, for example publisher,facilitator. Quote values that contain commas, quotes, or line breaks, and double any embedded quotes. Spaces and case are preserved, and an empty value produces an empty list. Lists of objects remain structured.
• User rows include roles as a comma-separated list. Use assignedRoles for structured role details.
• App create, update, and copy rows contain the app fields, such as name and description, directly. The Node wraps them in Qlik's attributes object.
• When publishing an app with moveApp set to true, the row must also contain originAppId.
• Reload variables are not supported by POST /api/v1/reloads.
• A successful reload submission returns the Flowgear.Message Reload queued, and an accepted cancellation returns Cancellation accepted. Neither confirms that the reload has finished. Use GET /api/v1/reloads/{reloadId} to check its status.
• Create, Update, Delete, and Action responses include Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request. Failed rows also include Qlik's errors and traceId when Qlik returns them.
• When Qlik rejects an individual item, for example because of a validation error, a conflict, or a target that does not exist, the Node returns a failed row and continues with later items. An HTTP 403 on a later item is also returned as a failed row. Authentication failures, server errors, and a 403 on the first item stop the operation.
• If Qlik limits the request rate and supplies a retry window, the Node waits and retries up to two times. Otherwise the operation fails.
• Writes that time out or fail because of a server or connection error are not retried. Check the resource in Qlik before running the write again.
• Retrieve rows return records as Qlik provides them, without Flowgear metadata. An empty collection returns no rows. Some app fields with a free-form structure are returned at runtime but are not shown in the template.

See also

• Handle Partial Batch Failures.
• For Each.
• Qlik Cloud REST API reference.