{ "info": { "title": "apps", "version": "" }, "paths": { "/v1/apps": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "description": "Creates a new app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CreateApp" } } }, "required": true, "description": "Attributes that the user wants to set in new app." }, "x-qlik-access-control": [ "create" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "a81b195a-4aec-4e83-88e6-4336569d9e0f", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Retrieves information for a specific app.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "ba092387-ff06-4924-8710-b5bbe3703a0a", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "put": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Updates the information for a specific app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateApp" } } }, "required": true, "description": "Attributes that user wants to set." }, "x-qlik-access-control": [ "update" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "1bf67333-bc94-434f-8618-f97d829b5527", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "delete": { "responses": { "200": { "content": { "application/json": {} }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Deletes a specific app.", "x-qlik-access-control": [ "delete" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "bc9c6790-e7a9-4893-82da-fe45259f54b5", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/copy": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Copies a specific app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CreateApp" } } }, "required": true, "description": "Attributes that should be set in the copy." }, "x-qlik-access-control": [ "duplicate" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "dd0aaced-a03f-417b-9bbd-431c71dec61f", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/data/lineage": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LineageInfoRest" } } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Retrieves the lineage for an app.\nReturns a JSON-formatted array of strings describing the lineage of the app.", "x-qlik-access-control": [ "reload" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "1779deaf-82e9-4678-a064-6c93c0a6dd65", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/data/metadata": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataModelMetadata" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Retrieves the data model and reload statistics metadata of an app.\nAn empty metadata structure is returned if the metadata is not available in the app.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "7c7e780b-e62d-4617-ad7f-77506154a6d1", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/export": { "post": { "responses": { "201": { "headers": { "Location": { "schema": { "type": "string" }, "description": "The URL of the exported app on Temporary content service." } }, "description": "Created" }, "400": { "headers": {}, "description": "Bad request" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "query", "name": "NoData", "schema": { "type": "boolean" }, "description": "The flag indicating if only object contents should be exported." } ], "description": "Exports a specific app.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "70a53bc3-7775-42c5-b334-6a057e84d4c9", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/insight-analyses": { "get": { "tags": [ "insight-analyses" ], "summary": "Returns information about supported analyses for the app's data model. Lists available analysis types, along with minimum and maximum number of dimensions, measures, and fields.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisDescriptorResponse" } } }, "description": "The request is successfully processed and information about supported analyses is returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Bad request. The payload is not formed correctly." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "User is not authorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Unprocessable entity. The payload contains fields\nthat are invalid, such as too long of a query.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Internal server error" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "header", "name": "accept-language", "schema": { "type": "string" }, "required": false, "description": "language specified as an ISO-639-1 code. Defaults to 'en' (English)." } ], "operationId": "getAnalyses", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "14cdd0da-6840-47d1-bf6a-36cc8670dc94", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/insight-analyses/actions/recommend": { "post": { "tags": [ "insight-analyses" ], "summary": "Returns analysis recommendations in response to a natural language question, a set of fields and master items, or a set of fields and master items with an optional target analysis.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisRecommendationResponse" } } }, "description": "The request is successfully processed and recommendations are returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Bad request. The payload is not formed correctly." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "User is not authorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Invalid Business Logic" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Unprocessable entity. The payload contains fields\nthat are invalid, such as too long of a query.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Internal server error" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "header", "name": "accept-language", "schema": { "type": "string" }, "required": false, "description": "language specified as an ISO-639-1 code. Defaults to 'en' (English)." } ], "operationId": "getRecommendations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisRecommendRequest" } } }, "required": true }, "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "b6a2fa17-78de-4a23-a5f5-7777102b58ba", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/insight-analyses/model": { "get": { "tags": [ "insight-analyses" ], "summary": "Returns information about model used to make analysis recommendations. Lists all fields and master items in the logical model, along with an indication of the validity of the logical model if the default is not used.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalysisModelResponse" } } }, "description": "The request is successfully processed and information about model is returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Bad request. The payload is not formed correctly." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "User is not authorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Not found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Invalid Business Logic" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Unprocessable entity. The payload contains fields\nthat are invalid, such as too long of a query.\n" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } }, "description": "Internal server error" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid" }, "required": true, "description": "Qlik Sense app identifier" } ], "operationId": "getBusinessModel", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "6d57ea41-9b7b-40c1-b422-e64a8e787e46", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/media/files/{path}": { "get": { "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Unique application identifier." }, { "in": "path", "name": "path", "schema": { "type": "string" }, "required": true, "description": "Path to file content." } ], "description": "Gets media content from file.\nReturns a stream of bytes containing the media file content on success, or error if file is not found.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "bb894cab-35e9-4f42-af3a-6d6e2f6825a2", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "put": { "responses": { "200": { "content": { "application/json": {} }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Unique application identifier." }, { "in": "path", "name": "path", "schema": { "type": "string" }, "required": true, "description": "Path to file content." } ], "description": "Stores the media content file.\nReturns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.", "requestBody": { "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/FileData" } } }, "required": true, "description": "" }, "x-qlik-access-control": [ "update" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "5deba42b-0e1b-48b9-aa13-54dccc647921", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "delete": { "responses": { "200": { "content": { "application/json": {} }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Unique application identifier." }, { "in": "path", "name": "path", "schema": { "type": "string" }, "required": true, "description": "Path to file content." } ], "description": "Deletes a media content file or complete directory.\nReturns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.", "x-qlik-access-control": [ "update" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "fb53da60-2d25-422b-a5ae-849acb4828f1", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/media/list/{path}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppContentList" } } }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Unique application identifier." }, { "in": "path", "name": "path", "schema": { "type": "string" }, "required": true, "description": "The path to sub folder with static content relative to the root folder. Use empty path to access the root folder." }, { "in": "query", "name": "show", "schema": { "type": "string" }, "description": "Optional. List output can include files and folders in different ways:\n* Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.\n* Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.\n* All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories." } ], "description": "Lists media content.\nReturns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "9f37a9e7-1e71-4d9a-a9b6-4e584013e8ca", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/media/thumbnail": { "get": { "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Unique application identifier." } ], "description": "Gets media content from file currently used as application thumbnail.\nReturns a stream of bytes containing the media file content on success, or error if file is not found.\nThe image selected as thumbnail is only updated when application is saved.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "ad104a43-46d3-4c37-bffd-5c9aa0288c22", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/objects/{objectId}/actions/change-owner": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxAppObject" } } }, "headers": {}, "description": "OK" }, "400": { "headers": {}, "description": "Bad request" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "path", "name": "objectId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the object." } ], "description": "Sets owner on an app object.\nThe user must be the owner of the object.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateOwner" } } }, "required": true, "description": "New owner." }, "x-qlik-access-control": [ "update" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "bf7ed92e-2cff-4c49-b6c4-65eefb7400e4", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/owner": { "put": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" }, "403": { "headers": {}, "description": "Forbidden" }, "404": { "headers": {}, "description": "Not Found" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Changes owner of the app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UpdateOwner" } } }, "required": true, "description": "New owner." }, "x-qlik-access-control": [ "change_owner" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "f98c1c46-926f-441a-87bb-2f4415629225", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/publish": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Publishes a specific app to a managed space.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PublishApp" } } }, "required": true, "description": "Publish information for the app." }, "x-qlik-access-control": [ "publish" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "1864fbee-8b17-4b2d-84ef-e21e3c5ca716", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "put": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NxApp" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Republishes a published app to a managed space.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RepublishApp" } } }, "required": true, "description": "Republish information for the app." }, "x-qlik-access-control": [ "publish" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "02c3d6c2-93d3-4e3a-9b5d-b1ebb4ca9f3d", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/reloads/logs": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptLogList" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Retrieves the metadata about all script logs stored for an app.\nReturns an array of ScriptLogMeta objects.", "x-qlik-access-control": [ "reload" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "23e517c3-cb0a-4f72-ac8d-da9965ca7b71", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/reloads/logs/{reloadId}": { "get": { "responses": { "200": { "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "path", "name": "reloadId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the reload." } ], "description": "Retrieves the log of a specific reload.\nReturns the log as \"text/plain; charset=UTF-8\".", "x-qlik-access-control": [ "reload" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "f624792e-34a8-4965-8c73-024f109b6467", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/reloads/metadata/{reloadId}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReloadListMetadata" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app" }, { "in": "path", "name": "reloadId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the reload. Use empty reloadId to get all reloads." }, { "in": "query", "name": "includeSkipStoreReloads", "schema": { "type": "boolean" }, "description": "Include metadata for reloads ran with SkipStore flag set to true. Default: false" }, { "in": "query", "name": "limit", "schema": { "type": "string" }, "description": "Maximum number of records to return from this request. Default: 100" } ], "description": "Retrieves the app reload metadata list.\nReload metadata contains reload information, including reload id, duration, endtime and lineage load info.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "1bc4b140-12f1-48cf-a975-d00fb59b6e8e", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/report-filters": { "get": { "tags": [ "filters" ], "summary": "Get the filter list", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterList" } } }, "description": "The filters have been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Bad request. Malformed syntax, errors in params." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Unauthorized, JWT invalid or not provided." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Forbidden, user lacks sufficient permissions to access the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Too many request. Indicates the user has sent too many requests in a given amount of time, aka \"rate limiting\"." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Internal server error." } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid", "example": "11ecf638-0be4-4b94-a9e6-91218f34e175" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "query", "name": "filterTypes", "schema": { "type": "array", "items": { "enum": [ "REP", "SUB" ], "type": "string" }, "minItems": 1 }, "required": true, "description": "The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark." }, { "in": "query", "name": "filter", "schema": { "type": "string" }, "required": false, "description": "The advanced filtering to use for the query. Refer to [RFC 7644](https://datatracker.ietf.org/doc/rfc7644/) for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.\nThe following fields support the `co` (contains) operator: `name` , `description`\nThe following fields support the `eq` (equals) operator: `ownerId`\n```\nExample:\n```\n(name co \"query1\" or description co \"query2\") and ownerId eq \"123\"\n```\n" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "example": 20, "maximum": 100, "minimum": 1 }, "required": false, "description": "Limit the returned result set" }, { "in": "query", "name": "page", "schema": { "type": "string", "example": "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1", "nullable": true }, "example": "NzlmNzI5NWMtZGJlZC00Y2Y4LThkNDAtMzQ5ZDU3YzNjMzQ1", "description": "If present, the cursor that starts the page of data that is returned." }, { "in": "query", "name": "sort", "schema": { "type": "array", "items": { "enum": [ "+ownerId", "-ownerId", "-name", "+name", "+description", "-description", "+createdAt", "-createdAt", "+updatedAt", "-updatedAt" ], "type": "string" } }, "required": false } ], "description": "List all filters that are present in the given app. Filters allow to reduce the app data visible in a report output. Each filter can contain definitions on one or multiple fields.", "operationId": "filtersList", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/build" ], "x-qlik-entity-revision": "126a14c0-d86a-44d9-9b28-76afb690946c", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "post": { "tags": [ "filters" ], "summary": "Create a new filter.", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } }, "description": "The filter has been successfully created." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Bad request, malformed syntax, errors in params or the report request is not valid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Unauthorized, JWT invalid or not provided." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Forbidden, user lacks sufficient permissions to access the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Filter name conflict." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Too many request. Indicates the user has sent too many requests in a given amount of time, aka \"rate limiting\"." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Internal server error." } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid", "example": "11ecf638-0be4-4b94-a9e6-91218f34e175" }, "required": true, "description": "Qlik Sense app identifier" } ], "description": "Creates a new report filter which is used to re-apply selections, variables, patches to an engine session.", "operationId": "filtersCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterRequest" } } }, "required": true, "description": "The filter definition." }, "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/build" ], "x-qlik-entity-revision": "166d15d9-c31c-4772-8899-bd781505bba3", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/report-filters/{id}": { "get": { "tags": [ "filters" ], "summary": "Get a filter", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } }, "description": "The filter has been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Bad request. Malformed syntax, errors in params." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Unauthorized, JWT invalid or not provided." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Forbidden, user lacks sufficient permissions to access the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Too many request. Indicates the user has sent too many requests in a given amount of time, aka \"rate limiting\"." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Internal server error." } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid", "example": "01562a37-23e3-4b43-865d-84c26122276c" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "path", "name": "id", "schema": { "type": "string", "example": "01562a37-23e3-4b43-865d-84c26122276c" }, "required": true, "description": "The filter id identifier (bookmarkId)." } ], "operationId": "filtersGet", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/build" ], "x-qlik-entity-revision": "8b164ad9-3081-4522-9916-0213f85ddc4a", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "delete": { "tags": [ "filters" ], "summary": "Delete a filter", "responses": { "204": { "description": "The filter has been successfully deleted." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Bad request. Malformed syntax, errors in params." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Unauthorized, JWT invalid or not provided." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Forbidden, user lacks sufficient permissions to access the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Too many request. Indicates the user has sent too many requests in a given amount of time, aka \"rate limiting\"." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Internal server error." } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid", "example": "01562a37-23e3-4b43-865d-84c26122276c" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "path", "name": "id", "schema": { "type": "string", "example": "01562a37-23e3-4b43-865d-84c26122276c" }, "required": true, "description": "The filter id identifier (bookmarkId)." } ], "operationId": "filtersDelete", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/build" ], "x-qlik-entity-revision": "34a7c75e-aed9-4111-8dad-5902d2c02327", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/report-filters/actions/count": { "get": { "tags": [ "filters" ], "summary": "Get the number of filters for the given app and filter types", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiltersCount" } } }, "description": "The count of filters." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Bad request. Malformed syntax, errors in params." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Unauthorized, JWT invalid or not provided." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Forbidden, user lacks sufficient permissions to access the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Too many request. Indicates the user has sent too many requests in a given amount of time, aka \"rate limiting\"." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterErrors" } } }, "description": "Internal server error." } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string", "format": "uid", "example": "01562a37-23e3-4b43-865d-84c26122276c" }, "required": true, "description": "Qlik Sense app identifier" }, { "in": "query", "name": "filterTypes", "schema": { "type": "array", "items": { "enum": [ "REP", "SUB" ], "type": "string" }, "example": [ "REP" ], "minItems": 1 }, "required": true, "description": "The filter type (REP, SUB). REP stands for report bookmark, SUB for subscription bookmark." } ], "operationId": "filtersCount", "x-qlik-visibility": "public", "x-qlik-stability": "stable", "x-qlik-categories": [ "external/build" ], "x-qlik-entity-revision": "c58b2356-146e-48b2-9224-dade548152e1", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/v1/apps/{appId}/scripts": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptMetaList" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "query", "name": "filter", "schema": { "type": "string" }, "description": "A scim filter expression defining which script versions should be retrieved. Filterable fields are:\n* ScriptId\n* ModifiedTime\n* ModifierId" }, { "in": "query", "name": "limit", "schema": { "type": "string" }, "description": "Maximum number of records to return from this request." }, { "in": "query", "name": "page", "schema": { "type": "string" }, "description": "Opaque definition of which page of the result set to return. Returned from a previous call using the same filter. Not yet supported." } ], "description": "Retrieves the script history for an app.\nReturns information about the saved versions of the script.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "b4ce019e-53ac-4a7d-b44f-efddfdb483f7", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "post": { "responses": { "200": { "content": { "application/json": {} }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." } ], "description": "Sets script for an app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ScriptVersion" } } }, "required": true, "description": "The script to set." }, "x-qlik-access-control": [ "update" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "0e189948-07ef-4d73-a71b-0e3342b80cee", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/v1/apps/{appId}/scripts/{version}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScriptVersion" } } }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "path", "name": "version", "schema": { "type": "string" }, "required": true, "description": "Identifier of the script version, or 'current' for retrieving the current version." } ], "description": "Retrieves a version of the script for an app.\nReturns the script text.", "x-qlik-access-control": [ "read" ], "x-qlik-visibility": "public", "x-qlik-stability": "locked", "x-qlik-categories": [ "external/manage", "external/build" ], "x-qlik-entity-revision": "117e28c0-ba97-4880-aaaf-de2cee3fe6be", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "patch": { "responses": { "200": { "content": { "application/json": {} }, "headers": {}, "description": "OK" } }, "parameters": [ { "in": "path", "name": "appId", "schema": { "type": "string" }, "required": true, "description": "Identifier of the app." }, { "in": "path", "name": "version", "schema": { "type": "string" }, "required": true, "description": "Identifier of the script version." } ], "description": "Updates a specific version of the script for an app.", "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NxPatch" } } }, "required": true, "description": "Array of patches for the object ScriptVersion.\n