Data products

Download OpenAPI spec

Data products are packages that group related datasets within a single, curated offering. They enable organizations to organize and govern data by business domain, making it easier for business users to discover and consume trusted, well-documented datasets.

These products can represent subject areas, business functions, or data domains, and are created within spaces.

Overview

The Data products API allows you to automate the complete data product lifecycle:

  • Creation: Define and create new data products within spaces.
  • Management: Add datasets, configure product metadata, move products between spaces, and manage ownership.
  • Activation: Publish data products to make them discoverable and consumable by other services and users.
  • Governance: Track changes through changelogs, export documentation, and monitor product activation status.

For a step-by-step guide to using the Data products API, see the Create and activate a data product.

Workflows and key use cases

The API supports three phases of data product management:

Phase 1: Create an empty data product

Initialize a new data product as a container for datasets:

  • Create a data product:
    POST /data-governance/data-products

    This endpoint creates an empty data product in the specified space. The data product serves as a package to group and organize related datasets.

    Note

    An empty data product is created as a starting point. You must add datasets to it in the next phase.
    Product details like name, description, and tags can be specified at creation time.

Phase 2: Manage datasets and data product metadata

Configure the data product and organize its contents:

  • Get a data product:
    GET /data-governance/data-products/{dataProductId}

    Retrieve full data product details, including associated datasets, metadata, and activation status.

  • Update a data product:
    PATCH /data-governance/data-products/{dataProductId}

    Modify data product metadata such as name, description, tags, and key contacts. Use this endpoint to add datasets to your data product.

  • Move a data product:
    POST /data-governance/data-products/{dataProductId}/actions/move

    Reorganize data products by moving them between spaces.

Phase 3: Activate and publish the data product

Make the data product available for consumption:

  • Activate a data product:
    POST /data-governance/data-products/{dataProductId}/actions/activate

    Publish the data product, making it discoverable and consumable by other services and users.

  • Deactivate a data product:
    POST /data-governance/data-products/{dataProductId}/actions/deactivate

    Remove a data product from being consumable, stopping it from appearing in marketplace searches.

Note

Activation is required for data product consumers to discover your data product. Users must have the “Consume data products” permission and at least a “Can view” role in the managed space containing the data product to see it listed. Using the data product requires additional permissions in the associated spaces.
For more details on permissions and roles, see Data products roles and permissions on Qlik Help.

Common patterns and best practices

Organizing by domain: Group related datasets by business domain (Sales, Finance, Operations) to make data discovery intuitive for business users.

Metadata completeness: Include detailed descriptions and documentation for all data products. Use changelogs to track governance updates and maintain data lineage transparency.

Lifecycle management: Test data products in development spaces before activating them in production. Use deactivation to archive outdated products rather than deleting them.

Access control: Assign key contacts to each product to clarify ownership and support responsibilities for business users.

Create a data product

Creates a new data product with specified metadata, datasets, and governance information. Use this endpoint to package related datasets into a governed, discoverable asset. Requires create permissions in the target space.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

Required
  • application/json object

    Request payload for creating a data product.

    Show application/json properties
    • name string
      Required

      Display name of the data product.

      minLength = 1, maxLength = 200, pattern = "^(\S.*\S|\S)*$"

    • tags array of strings

      List of tags for the data product.

    • readMe string

      A readme of the Data Product.

      maxLength = 100000

    • spaceId string

      Unique identifier of the space.

    • datasetIds array of strings

      List of dataset IDs associated with the Data Product. Maximum of 100 items.

      maxItems = 100, uniqueItems = true

    • description string

      A description of the Data Product.

      maxLength = 1024

    • glossaryIds array of strings

      List of glossary IDs linked to the Data Product. Each entry must be a valid UUIDv4 (maximum 36 characters). Maximum of 100 items.

      maxItems = 100

    • keyContacts array of objects

      List of key contacts for the data product.

      maxItems = 100

      Show keyContacts properties
      • role string

        Role of the key contact in the Data Product.

        maxLength = 200

      • userId string
        Required

        Unique identifier of the user.
    • apiConsumableDatasetIds array of strings

      List of dataset IDs for which API consumption is enabled. Must be a subset of datasetIds.

      uniqueItems = true

Responses

201

Data product created successfully.

  • application/json object
    Show application/json properties
    • id string
      Required
    • qri string
      Required

      Qlik Resource Identifier (QRI) uniquely identifying the data product across the platform.

    • name string
      Required
    • tags array of strings
      Required
    • mainId string

      Primary identifier used for main data product reference.

    • readMe string

      Documentation in Markdown format providing detailed information about the data product.

    • ownerId string
      Required

      Identifier of the user who owns the data product and is responsible for governance.

    • quality object
      Show quality properties
      • validity number
        Required

        format = float

      • completeness number
        Required

        format = float

    • spaceId string
    • tenantId string
      Required
    • activated boolean

      Indicates whether the data product is currently activated for consumption.

    • createdAt string
      Required

      Timestamp when the data product was created in ISO 8601 format.

      format = "date-time"

    • createdBy string
      Required

      Identifier of the user who created the data product.

    • updatedAt string
      Required

      Timestamp of the most recent update in ISO 8601 format.

      format = "date-time"

    • updatedBy string
      Required

      Identifier of the user who last updated the data product.

    • datasetIds array of strings
      Required
    • trustScore object
      Show trustScore properties
      • score number
        Required

        format = float

      • dimensions array of objects
        Show dimensions properties
        • id string
          Required
        • score number

          format = float

        • previousScore number

          format = float

        • applicableDatasets number
          Required

          format = int32

      • previousScore number

        format = float

      • applicableDatasets number
        Required

        format = int32

    • activatedAt string

      Timestamp when the data product was most recently activated in ISO 8601 format.

      format = "date-time"

    • activatedOn array of strings
      Required

      List of target environments or platforms where the data product is activated.

    • description string
    • glossaryIds array of strings
      Required
    • keyContacts array of objects
      Required

      Represents a designated contact person for a data product, optionally with their role.

      Show keyContacts properties
      • role string

        Role of the key contact in the Data Product.

        maxLength = 200

      • userId string
        Required

        Unique identifier of the user.
    • pendingChangesCount integer

      Number of pending changes that are not yet activated.

      format = int32

    • apiConsumableDatasetIds array of strings
      Required

      List of dataset IDs for which API consumption is enabled

      uniqueItems = true

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource or one or more linked glossary entries.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

422

The data product limit has been exceeded for this tenant.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.createDataProduct(
  {
    apiConsumableDatasetIds: ['string'],
    datasetIds: ['string'],
    description:
      'This is an example Data Product.',
    glossaryIds: ['string'],
    keyContacts: [
      {
        role: 'Data Steward',
        userId: 'exampleUserId',
      },
    ],
    name: 'ExampleDataProductName',
    readMe:
      'This is an example readme for the Data Product.',
    spaceId: 'ExampleSpaceId',
    tags: ['exampleTag1', 'exampleTag2'],
  },
)
qlik data-governance data-product create \
  --keyContacts-userId '' \
  --name 'ExampleDataProductName'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"ExampleDataProductName","tags":["exampleTag1","exampleTag2"],"readMe":"This is an example readme for the Data Product.","spaceId":"ExampleSpaceId","datasetIds":["string"],"description":"This is an example Data Product.","glossaryIds":["string"],"keyContacts":[{"role":"Data Steward","userId":"exampleUserId"}],"apiConsumableDatasetIds":["string"]}'

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "mainId": "string",
  "readMe": "string",
  "ownerId": "string",
  "quality": {
    "validity": 42,
    "completeness": 42
  },
  "spaceId": "string",
  "tenantId": "string",
  "activated": true,
  "createdAt": "2018-03-20T09:12:28Z",
  "createdBy": "string",
  "updatedAt": "2018-03-20T09:12:28Z",
  "updatedBy": "string",
  "datasetIds": [
    "string"
  ],
  "trustScore": {
    "score": 42,
    "dimensions": [
      {
        "id": "string",
        "score": 42,
        "previousScore": 42,
        "applicableDatasets": 42
      }
    ],
    "previousScore": 42,
    "applicableDatasets": 42
  },
  "activatedAt": "2018-03-20T09:12:28Z",
  "activatedOn": [
    "string"
  ],
  "description": "string",
  "glossaryIds": [
    "string"
  ],
  "keyContacts": [
    {
      "role": "Data Steward",
      "userId": "exampleUserId"
    }
  ],
  "pendingChangesCount": 42,
  "apiConsumableDatasetIds": [
    "string"
  ]
}

Get a data product

Retrieves the details of the specified data product, including name, description, associated datasets, key contacts, and activation status. Requires read access to the Data Product.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

200

Data product details retrieved successfully.

  • application/json object
    Show application/json properties
    • id string
      Required
    • qri string
      Required

      Qlik Resource Identifier (QRI) uniquely identifying the data product across the platform.

    • name string
      Required
    • tags array of strings
      Required
    • mainId string

      Primary identifier used for main data product reference.

    • readMe string

      Documentation in Markdown format providing detailed information about the data product.

    • ownerId string
      Required

      Identifier of the user who owns the data product and is responsible for governance.

    • quality object
      Show quality properties
      • validity number
        Required

        format = float

      • completeness number
        Required

        format = float

    • spaceId string
    • tenantId string
      Required
    • activated boolean

      Indicates whether the data product is currently activated for consumption.

    • createdAt string
      Required

      Timestamp when the data product was created in ISO 8601 format.

      format = "date-time"

    • createdBy string
      Required

      Identifier of the user who created the data product.

    • updatedAt string
      Required

      Timestamp of the most recent update in ISO 8601 format.

      format = "date-time"

    • updatedBy string
      Required

      Identifier of the user who last updated the data product.

    • datasetIds array of strings
      Required
    • trustScore object
      Show trustScore properties
      • score number
        Required

        format = float

      • dimensions array of objects
        Show dimensions properties
        • id string
          Required
        • score number

          format = float

        • previousScore number

          format = float

        • applicableDatasets number
          Required

          format = int32

      • previousScore number

        format = float

      • applicableDatasets number
        Required

        format = int32

    • activatedAt string

      Timestamp when the data product was most recently activated in ISO 8601 format.

      format = "date-time"

    • activatedOn array of strings
      Required

      List of target environments or platforms where the data product is activated.

    • description string
    • glossaryIds array of strings
      Required
    • keyContacts array of objects
      Required

      Represents a designated contact person for a data product, optionally with their role.

      Show keyContacts properties
      • role string

        Role of the key contact in the Data Product.

        maxLength = 200

      • userId string
        Required

        Unique identifier of the user.
    • pendingChangesCount integer

      Number of pending changes that are not yet activated.

      format = int32

    • apiConsumableDatasetIds array of strings
      Required

      List of dataset IDs for which API consumption is enabled

      uniqueItems = true

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
GET /api/data-governance/data-products/{dataProductId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.getDataProduct(
  'string',
)
qlik data-governance data-product get 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "mainId": "string",
  "readMe": "string",
  "ownerId": "string",
  "quality": {
    "validity": 42,
    "completeness": 42
  },
  "spaceId": "string",
  "tenantId": "string",
  "activated": true,
  "createdAt": "2018-03-20T09:12:28Z",
  "createdBy": "string",
  "updatedAt": "2018-03-20T09:12:28Z",
  "updatedBy": "string",
  "datasetIds": [
    "string"
  ],
  "trustScore": {
    "score": 42,
    "dimensions": [
      {
        "id": "string",
        "score": 42,
        "previousScore": 42,
        "applicableDatasets": 42
      }
    ],
    "previousScore": 42,
    "applicableDatasets": 42
  },
  "activatedAt": "2018-03-20T09:12:28Z",
  "activatedOn": [
    "string"
  ],
  "description": "string",
  "glossaryIds": [
    "string"
  ],
  "keyContacts": [
    {
      "role": "Data Steward",
      "userId": "exampleUserId"
    }
  ],
  "pendingChangesCount": 42,
  "apiConsumableDatasetIds": [
    "string"
  ]
}

Update a data product

Partially updates an existing data product using JSON Patch operations. Use this endpoint to modify properties such as name, description, datasets, tags, or key contacts. Changes are tracked in the data product changelog.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Request Body

Required
  • application/json array of objects

    maxItems = 8

    Show application/json properties
    • op string
      Required

      Can be one of: "replace"

    • path string
      Required

      Can be one of: "/name""/description""/datasetIds""/glossaryIds""/readMe""/keyContacts""/tags""/apiConsumableDatasetIds"

    • value string|array
      One of:
      • string

        Value is expected to be null or a string if the path is either /name, /description, or /readMe

      • ArrayOfUniqueStrings array of strings
      • array of objects

        Value is expected to be null or an array of object if the path is /keyContacts

Responses

204

Data product updated successfully.

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
PATCH /api/data-governance/data-products/{dataProductId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.patchDataProduct(
  'string',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'string',
    },
  ],
)
qlik data-governance data-product patch 'string' \
  --op 'replace' \
  --path '/name'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"string"}]'

Delete a data product

Permanently removes a data product from the tenant. This action cannot be undone and does not affect the underlying datasets. Requires delete permissions for the data product.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

204

Data product deleted successfully.

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
DELETE /api/data-governance/data-products/{dataProductId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.deleteDataProduct(
  'string',
)
qlik data-governance data-product rm 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Activate a data product

Activates a data product for publishing and consumption. Once activated, the data product becomes discoverable and accessible to authorized users. Requires publish permissions and valid data product configuration.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Request Body

Required
  • application/json object
    Show application/json properties
    • name string
      Required

      Name of the data product to activate.

      maxLength = 200

    • tags array of strings

      List of tags for the data product.

      maxItems = 50

    • spaceId string

      Unique identifier of the space.

    • description string

      A description of the data product.

      maxLength = 1024

Responses

201

Data product activated successfully. Glossary links are reconciled asynchronously after publication.

  • application/json object
    Show application/json properties
    • id string
      Required
    • qri string
      Required

      Qlik Resource Identifier (QRI) uniquely identifying the data product across the platform.

    • name string
      Required
    • tags array of strings
      Required
    • mainId string

      Primary identifier used for main data product reference.

    • readMe string

      Documentation in Markdown format providing detailed information about the data product.

    • ownerId string
      Required

      Identifier of the user who owns the data product and is responsible for governance.

    • quality object
      Show quality properties
      • validity number
        Required

        format = float

      • completeness number
        Required

        format = float

    • spaceId string
    • tenantId string
      Required
    • activated boolean

      Indicates whether the data product is currently activated for consumption.

    • createdAt string
      Required

      Timestamp when the data product was created in ISO 8601 format.

      format = "date-time"

    • createdBy string
      Required

      Identifier of the user who created the data product.

    • updatedAt string
      Required

      Timestamp of the most recent update in ISO 8601 format.

      format = "date-time"

    • updatedBy string
      Required

      Identifier of the user who last updated the data product.

    • datasetIds array of strings
      Required
    • trustScore object
      Show trustScore properties
      • score number
        Required

        format = float

      • dimensions array of objects
        Show dimensions properties
        • id string
          Required
        • score number

          format = float

        • previousScore number

          format = float

        • applicableDatasets number
          Required

          format = int32

      • previousScore number

        format = float

      • applicableDatasets number
        Required

        format = int32

    • activatedAt string

      Timestamp when the data product was most recently activated in ISO 8601 format.

      format = "date-time"

    • activatedOn array of strings
      Required

      List of target environments or platforms where the data product is activated.

    • description string
    • glossaryIds array of strings
      Required
    • keyContacts array of objects
      Required

      Represents a designated contact person for a data product, optionally with their role.

      Show keyContacts properties
      • role string

        Role of the key contact in the Data Product.

        maxLength = 200

      • userId string
        Required

        Unique identifier of the user.
    • pendingChangesCount integer

      Number of pending changes that are not yet activated.

      format = int32

    • apiConsumableDatasetIds array of strings
      Required

      List of dataset IDs for which API consumption is enabled

      uniqueItems = true

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

502

Business Glossary source links could not be captured before publication.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products/{dataProductId}/actions/activate 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.activateDataProduct(
  'string',
  {
    description:
      'This is an example data product.',
    name: 'ExampleDataProductName',
    spaceId: 'ExampleSpaceId',
    tags: ['example'],
  },
)
qlik data-governance data-product activate 'string' \
  --name 'ExampleDataProductName'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/actions/activate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"ExampleDataProductName","tags":["example"],"spaceId":"ExampleSpaceId","description":"This is an example data product."}'

Example Response

{
  "id": "string",
  "qri": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "mainId": "string",
  "readMe": "string",
  "ownerId": "string",
  "quality": {
    "validity": 42,
    "completeness": 42
  },
  "spaceId": "string",
  "tenantId": "string",
  "activated": true,
  "createdAt": "2018-03-20T09:12:28Z",
  "createdBy": "string",
  "updatedAt": "2018-03-20T09:12:28Z",
  "updatedBy": "string",
  "datasetIds": [
    "string"
  ],
  "trustScore": {
    "score": 42,
    "dimensions": [
      {
        "id": "string",
        "score": 42,
        "previousScore": 42,
        "applicableDatasets": 42
      }
    ],
    "previousScore": 42,
    "applicableDatasets": 42
  },
  "activatedAt": "2018-03-20T09:12:28Z",
  "activatedOn": [
    "string"
  ],
  "description": "string",
  "glossaryIds": [
    "string"
  ],
  "keyContacts": [
    {
      "role": "Data Steward",
      "userId": "exampleUserId"
    }
  ],
  "pendingChangesCount": 42,
  "apiConsumableDatasetIds": [
    "string"
  ]
}

Trigger data quality computation for the data-product's datasets

Triggers a full data quality computation for all datasets in the data product, running profile calculation followed by data quality assessment. Returns a batchComputationId that can be used to track overall progress via the batch computation status endpoint (GET /api/data-governance/data-qualities/batch-computations/{batchComputationId}). The computation runs asynchronously. Poll the status endpoint until status is FINISHED.

Facts

Rate limit Special (10 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

202

Data quality computation triggered successfully.

  • application/json object

    Response containing the batch computation identifier and per-dataset quality computation results.

    Show application/json properties
    • datasetResponses array of objects
      Required

      List of computation results, one entry per dataset in the data product.

      Show datasetResponses properties
      • error string

        Error message if the computation failed; absent on success.

      • status string
        Required

        Current execution status of the computation (REQUESTED or FAILED).

        Can be one of: "REQUESTED""FAILED"

      • datasetId string
        Required

        The ID of the dataset

        pattern = "^[0-9a-zA-Z-]{1,36}$"

      • computationId string
        Required

        Unique identifier for this individual data quality computation job.
    • batchComputationId string
      Required

      Unique identifier for the data quality batch computation job.

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products/{dataProductId}/actions/compute-datasets-data-quality 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.computeDatasetsDataQualityDataProduct(
  'string',
)
qlik data-governance data-product compute-datasets-data-quality 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/actions/compute-datasets-data-quality" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "datasetResponses": [
    {
      "error": "string",
      "status": "REQUESTED",
      "datasetId": "669144f5aa2d642638ef1dd0",
      "computationId": "string"
    }
  ],
  "batchComputationId": "string"
}

Deactivate a data product

Deactivates a data product, preventing it from being consumed by other services or users.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

204

No content

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products/{dataProductId}/actions/deactivate 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.deactivateDataProduct(
  'string',
)
qlik data-governance data-product deactivate 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/actions/deactivate" \
-X POST \
-H "Authorization: Bearer <access_token>"

Export data product documentation

Exports data product documentation in Markdown format. Use this endpoint to generate documentation for sharing or archiving. Requires read access to the data product.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

200

Documentation exported successfully in Markdown format.

  • text/markdown string

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

406

MIME type isn't supported.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

415

Unsupported output format requested.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
GET /api/data-governance/data-products/{dataProductId}/actions/export-documentation 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.exportDocumentationDataProduct(
  'string',
)
qlik data-governance data-product export-documentation 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/actions/export-documentation" \
-H "Authorization: Bearer <access_token>"

Example Response

"string"

Move a data product

Moves a data product from its current space to a different space. Use this endpoint to reorganize data products across workspaces or governance domains. Requires delete permissions in the source space and create permissions in the target space.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Request Body

Required
  • application/json object
    Show application/json properties
    • spaceId string
      Required

      Unique identifier of the space.

Responses

204

No content

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products/{dataProductId}/actions/move 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.moveDataProduct(
  'string',
  { spaceId: 'exampleSpaceId' },
)
qlik data-governance data-product move 'string' \
  --spaceId 'exampleSpaceId'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/actions/move" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"spaceId":"exampleSpaceId"}'

Get data product changelogs

Retrieves a paginated history of all notable changes made to a data product. Each changelog entry captures the operation type, affected property, and timestamp. Use this endpoint to track the history of changes or data product evolution over time.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • page integer

    Page number.

    minimum = 1, default = 1, format = int32, default = 1

  • limit integer

    Maximum number of items to return per page.

    minimum = 1, maximum = 100, default = 10, format = int32, default = 10

  • sort string

    Sort order for changelog entries. Use +createdAt for oldest first or -createdAt for newest first. Prefix with + for ascending or - for descending order. Default: -createdAt.

    Can be one of: "+createdAt""-createdAt"

    default = "-createdAt"

Path Parameters

  • dataProductId string
    Required

    Unique identifier of the data product. Must be a valid GUID assigned when the data product was created.

Responses

200

OK response

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • id string
      • changes array of objects
        Show changes properties
        • path string

          Can be one of: "/name""/description""/spaceId""/datasetIds""/glossaryIds""/readMe""/keyContacts""/tags""/activatedOn""/apiConsumableDatasetIds""/semanticModel""/semanticModel/relationships""/semanticModel/measures""/semanticModel/dimensions""/semanticModel/tables"

        • value string|array|object
          One of:
          • string

            Value is expected to be null or a string if the path is either /name, /description, /readMe, /spaceId, /semanticModel/relationships, /semanticModel/measures or /semanticModel/dimensions. For the semantic model sub-paths, the string is the identifier of the affected relationship, measure or dimension entity.

          • ArrayOfUniqueStrings array of strings
          • ChangelogTableUpdate object

            Fields added to and removed from a semantic model table by a dataset schema change.

            Show ChangelogTableUpdate properties
            • tableId string
              Required

              Identifier of the updated table.

            • addedFieldIds array of strings

              Identifiers of the fields added to the table. Empty when no field was added.

            • removedFieldIds array of strings

              Identifiers of the fields removed from the table. Empty when no field was removed.
          • array of objects

            value is expected to be null or an array of object if the path is /keyContacts.

          • any

            Value is always null if the path is /semanticModel.

        • operator string

          removedFromCatalog is a removal applied by the system after a catalog event (dataset updated or deleted), as opposed to remove, which is a removal deliberately performed by a user. update is a partial modification of an existing entity applied by the system after a catalog event (dataset schema updated). It is currently only used with the /semanticModel/tables path, where the value describes the fields added to and removed from a table.

          Can be one of: "replace""add""remove""removedFromCatalog""update"

      • createdAt string

        Timestamp when this changelog entry was created in ISO 8601 format.

        format = "date-time"

      • createdBy string

        Identifier of the user who made these changes.

      • updatedAt string

        Timestamp of the last event included in this aggregated changelog entry. Only set for aggregated events that span multiple source events.

        format = "date-time"

    • page integer

      format = int32

    • limit integer

      format = int32

    • links object
      Show links properties
      • last object
        Show last properties
        • href string
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string
      • first object
        Show first properties
        • href string
    • pages integer

      format = int32

    • total integer

      format = int64

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

409

The input request conflicts with the current state of the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
GET /api/data-governance/data-products/{dataProductId}/changelogs 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.getDataProductChangelogs(
  'string',
  {},
)
qlik data-governance data-product changelog ls 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/{dataProductId}/changelogs" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "string",
      "changes": [
        {
          "path": "/name",
          "value": "string",
          "operator": "replace"
        }
      ],
      "createdAt": "2018-03-20T09:12:28Z",
      "createdBy": "string",
      "updatedAt": "2018-03-20T09:12:28Z"
    }
  ],
  "page": 42,
  "limit": 42,
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  },
  "pages": 42,
  "total": 42
}

Generate provider URL

Generates a URL to access a third-party provider's user interface. Use this endpoint to integrate external services with your data product.

Facts

Rate limit Tier 2 (100 requests per minute)

Query Parameters

  • dataSetId string
    Required

    Unique identifier of the dataset.

    minLength = 1

Responses

200

OK response

  • application/json object
    Show application/json properties
    • url string
      Required

400

The request is in incorrect format.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

401

User does not have valid authentication credentials.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

403

User does not have access to the resource.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

404

Resource does not exist.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

500

Internal server error.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string

503

Service temporarily unavailable. Retry the request.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • meta object

        Optional structured context. cycle is present for CIRCULAR_REFERENCE errors. dimensions and measures contain semantic-model element IDs: for DP-101 the elements referencing inaccessible glossary entries, for DP-103 the elements whose term-link snapshot could not be replayed, for DP-104 the elements whose submitted term-link snapshot was invalid.

        Show meta properties
        • cycle array of objects

          Present only for CIRCULAR_REFERENCE errors. The tables forming the detected cycle, in order (first and last entries repeated to close the loop).

          Show cycle properties
          • tableId string
            Required
          • tableName string
            Required
        • measures array of strings

          Semantic-model measure IDs. For DP-101, measures linked to inaccessible glossary entries. For DP-103, measures whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, measures whose submitted term-link snapshot was invalid.

        • dimensions array of strings

          Semantic-model dimension IDs. For DP-101, dimensions linked to inaccessible glossary entries. For DP-103, dimensions whose captured Business Glossary term-link snapshot could no longer be replayed. For DP-104, dimensions whose submitted term-link snapshot was invalid.
      • title string
      • detail string
      • status string
    • traceId string
POST /api/data-governance/data-products/actions/generate-provider-url 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.dataGovernance.dataProducts.generateProviderUrlDataProducts(
  { dataSetId: 'string' },
)
qlik data-governance data-product generate-provider-url \
  --dataSetId 'string'
curl "https://{tenant}.{region}.qlikcloud.com/api/data-governance/data-products/actions/generate-provider-url" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "url": "string"
}