Qlik ODAG links API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Analytics, Business Intelligence, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes
8 operations
across 5 paths,
organized into 2 resource areas,
and defines 52 schemas.
It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.
The identity and technical contract details declared by the specification.
AppIdV2
string
The system-assigned ID for an Analytics Application.
AppNameParameterV2
string
One of the allowed variables that, when evaluated at ODAG Request execution time, can be used to compute a part of a generated Analytics Application's name.
AppNameV2
string
The name of an Analytics Application.
AppStateCondensedV2
object
Condensed state of an Analytics Application returned in state for Link, LinkUsage, Request, and ODAG Apps GET calls.
2 properties
2 required
BindFormattingV2
object
A property value that describes the formatting of field values in a Binding. This is currently only settable in the template Analytics Application script and n…
2 properties
BindingArrayV2
array
A collection of Bindings. Note that there can be multiple bindings having the same templateAppFieldName in a binding collection to denote different usages of t…
BindingV2
object
An object that defines how values accessible in the selection Analytics Application are to be harvested and injected into the data prep phase of the template A…
7 properties
2 required
CanCreateLinks
object
An object used to inform the caller whether the current user has privilege to create new Links.
1 property
DataLoadStatus
string
The completion status of a completed Request.
ErrorDetailsV2
object
A single error entry within an error response.
4 properties
ErrorV2
object
A standard error response containing a list of one or more errors.
2 properties
FieldSelectionStateV2
object
The set of values used by link bindings to generate an Analytics Application.
4 properties
3 required
FieldValueV2
object
A single field value with its selection status.
3 properties
2 required
LinkAddPayloadV2
object
An object that defines the properties of a Link to be created.
9 properties
2 required
LinkId
string
The system-assigned ID for a link.
LinkNameV2
string
The name of a link.
LinkPropAppOpenMethodV2
object
Sets the default method by which the newly generated Analytics Application is displayed when opened. The default is Tab to open a new tab in the same browser.…
2 properties
2 required
LinkPropAppRetentionTimeV2
object
A string that defines the length of time that a generated Analytics Application should be allowed to exist before it is automatically purged. The format must b…
2 properties
2 required
LinkPropDisableV2
object
Set to true to temporarily disable the use of this Link to generate Analytics Applications.
2 properties
2 required
LinkPropertiesV2
object
The complete set of possible properties for a link and their associated user context/value pairings.
10 properties
1 required
LinkPropGenAppLimitV2
object
The limit to the number of Analytics Applications generated using this specific Link that can exist, and still not deleted, before the policy defined by the li…
2 properties
2 required
LinkPropGenAppNameV2
object
An object that defines how to compute the name to use for the generated Analytics Application.
3 properties
2 required
LinkPropLimitPolicyV2
object
The action to take when the limit to the maximum number of generated Analytics Applications is reached.
2 properties
2 required
LinkPropMenuLabelV2
object
The default label to use for this Link in the context of the selection Analytics Application's ODAG navigation menu.
2 properties
2 required
LinkPropOverrideGenAppLimitV2
object
The limit to the number of Analytics Applications generated can be overridden using this specific Link that can exist, and still not deleted. The default value…
2 properties
1 required
LinkPropRowEstRangeV2
object
A link property that defines a value range that the evaluated value of the row estimate measure must fall within in order to allow submissions of a request for…
3 properties
2 required
LinkPropTargetSheetV2
object
An optional property that a Link creator can specify to cause the client to navigate to a specific sheet in the generated Analytics Application when opening th…
3 properties
2 required
LinkPutPayloadV2
object
An object that defines the properties of a Link to be modified.
10 properties
2 required
LinkRowEstExprV2
string
The measure expression to be evaluated in the context of the selection Analytics Application for the link that estimates the number of records that will be qua…
LinkStateFullV2
object
The full state of a Link.
17 properties
8 required
LinkStateRefV2
object
Used to return a possibly empty link state when querying multiple links by ID where any one of those IDs may be invalid or obsolete. If the link field is missi…
2 properties
1 required
LinkStatusSettingV2
string
The requested status transition to apply to a Link. New links are always created with status active; statusSetting is ignored. When updating a Link, if statusS…
LinkStatusV2
string
The current status of a link.
LinkTypeV2
string
The type of link
LinkUsageContextV2
string
An expression based on the usage environment of a Link typically including predicates that test the current user's membership in a group or possession of a use…
MetaV2
object
Additional metadata associated with an error.
1 property
NumericOnlyV2
boolean
Set to true to indicate that only numeric values from the selection Analytics Application source parameter should be used. The default value for this property,…
RequestArrayV2
array
An array of Request Summary objects.
RequestIdV2
string
The system-assigned ID for an ODAG request.
RequestKindV2
string
For links that do not use any partitioning fields, a single Analytics Application generation request is created. However, for selection Analytics Applications…
RequestLoadInfoV2
object
An object that describes the state of a generated Analytics Application's data load operation. In request objects that include this object as an optional prope…
4 properties
2 required
RequestObjectV2
object
The detailed content of an ODAG request object. If this is a summarization of a request initiated from a navigation point that has a single link, its link prop…
28 properties
8 required
RequestPostPayloadV2
object
Payload to send when creating an ODAG request. selectionApp is the ID of the selection Analytics Application from which the request is made. bindSelectionState…
6 properties
2 required
RequestStateV2
string
The current state of an ODAG request.
SelAppLinkUsagePayload
object
A JSON payload containing an array of LinkIds.
1 property
1 required
SelectAppParamTypeV2
string
The different kinds of selection Analytics Application parameters whose values can be bound to the script of template Analytics Applications when generating ne…
SelectionStateDescrV2
string
A combination of the letters S and/or O to indicate which values from the selection states selected or optional in the hypercube of the selection Analytics App…
SelectionStateV2
array
A collection of FieldSelectionStateV2 objects.
SelectStatusV2
string
The valid set of selection states that a specific field value can be in. One of: S (selected), O (optional), or X (excluded).
UserIdV2
string
The system-assigned ID for a user
UserStateCondensedV2
object
Condensed state of a user returned in state of ownable ODAG entities (for example, a link or request).
4 properties
4 required
ValueCountRangeV2
object
The lower and upper bound for the permitted number of values that must exist in the selection Analytics Application's source parameter in order for this bindin…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Qlik Sense APIs publishes across the network.
