Type Alias QriRequestItem

Single QRI generation request for a specific connection.

type QriRequestItem = {
    connection: string;
    connectionType: QriConnectionType;
    dataSourceId?: string;
    itemProperties?: QriRequestItemPropertyArray;
    pathProperties?: QriRequestPathPropertyArray;
    requestId?: string;
    spaceId?: string;
}
Index
connection connectionType dataSourceId? itemProperties? pathProperties? requestId? spaceId?
connection: string

The connection identifier — a UUID, name, or connection string — corresponding to the value of connectionType.

connectionType: QriConnectionType

Type of connection identifier used in QRI generation requests:

  • id — connection UUID
  • name — connection name, optionally space-qualified (for example, MySpace:MyConnection or :MyConnection)
  • properties — connection string in Qlik CONNECT format
dataSourceId?: string

The unique identifier of the datasource for the connection. Must match the datasource type when connectionType is properties.

itemProperties?: QriRequestItemPropertyArray

Optional ordered list of property values used to populate the item segment of the QRI template.

pathProperties?: QriRequestPathPropertyArray

Ordered list of property values used to populate the path segment of the QRI template.

requestId?: string

Optional caller-provided identifier used to correlate this request entry with its response. Should be unique within a batch request.

spaceId?: string

The unique identifier of the space containing the connection. Required for name-based lookups; ignored when connectionType is properties.

Settings
Member Visibility

On This Page
Properties