Qlik Community

Ask a Question

Integration, Extension & APIs

Discussion board where members can learn more about Integration, Extensions and API’s for Qlik Sense.

Announcements
Support Cases coming to Qlik Community Oct. 4! Start chats, open cases, explore resources: READ DETAILS
cancel
Showing results for 
Search instead for 
Did you mean: 
philipp_kunz
Partner
Partner

QRS API Stability Index

Hello together,

 

I was wondering what "stability index" the Qlik Sense Repository Service (QRS) API has. I read through the official help but could not find an answer. My question is simple: how reliable is that API and will it be supported in future Qlik Sense Versions?

Thank you very much.

Labels (2)
1 Solution

Accepted Solutions
Levi_Turner
Employee
Employee

It will be outlined in the spec for each endpoint. From https://help.qlik.com/en-US/sense-developer/Content/Sense_Helpsites/api-governance.htm we have the definitions. When we call GET /qrs/about/openapi/main we get responses like this:

    "/app/full": {
      "get": {
        "operationId": "05ddfd59-e691-6860-0577-660c7a93dc12",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "type": "string",
            "allowEmptyValue": true
          },
          {
            "name": "orderby",
            "in": "query",
            "required": false,
            "type": "string",
            "allowEmptyValue": true
          },
          {
            "name": "privileges",
            "in": "query",
            "required": false,
            "default": false,
            "type": "boolean",
            "allowEmptyValue": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/App"
              }
            }
          }
        },
        "x-qlik-visibility": "Public",
        "x-qlik-stability": "Locked"
      }
    }

 

Inspect the x-qlik-visibility and x-qlik-stability elements.

View solution in original post

1 Reply
Levi_Turner
Employee
Employee

It will be outlined in the spec for each endpoint. From https://help.qlik.com/en-US/sense-developer/Content/Sense_Helpsites/api-governance.htm we have the definitions. When we call GET /qrs/about/openapi/main we get responses like this:

    "/app/full": {
      "get": {
        "operationId": "05ddfd59-e691-6860-0577-660c7a93dc12",
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "required": false,
            "type": "string",
            "allowEmptyValue": true
          },
          {
            "name": "orderby",
            "in": "query",
            "required": false,
            "type": "string",
            "allowEmptyValue": true
          },
          {
            "name": "privileges",
            "in": "query",
            "required": false,
            "default": false,
            "type": "boolean",
            "allowEmptyValue": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/App"
              }
            }
          }
        },
        "x-qlik-visibility": "Public",
        "x-qlik-stability": "Locked"
      }
    }

 

Inspect the x-qlik-visibility and x-qlik-stability elements.

View solution in original post