{ "info": { "title": "data-assets", "version": "" }, "paths": { "/api/v1/data-assets": { "post": { "tags": [ "data-asset" ], "summary": "Save new data asset.", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "description": "Created new data asset successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The input request conflicts with the current state of the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "operationId": "saveDataAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "delete": { "tags": [ "data-asset" ], "summary": "Batch delete data assets by IDs.", "responses": { "204": { "description": "Deleted data asset with all child objects." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The input request conflicts with the current state of the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "operationId": "batchDeleteDataAssets", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchIdDto" } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/api/v1/data-assets/{data-asset-id}": { "get": { "tags": [ "data-asset" ], "summary": "Get data asset by ID.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "description": "Successful Operation." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The input request conflicts with the current state of the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "in": "path", "name": "data-asset-id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "projections", "schema": { "type": "array", "items": { "type": "string" }, "default": [] }, "required": false, "description": "Comma-separated fields to return in the response." } ], "operationId": "getDataAsset", "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "patch": { "tags": [ "data-asset" ], "summary": "Patch data asset.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "description": "Patched data asset successfully." }, "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "description": "Patched data asset successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The input request conflicts with the current state of the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "in": "path", "name": "data-asset-id", "schema": { "type": "string" }, "required": true } ], "operationId": "patchDataAsset", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JsonPatch" }, "description": "Array of JSON patch documents as defined by RFC 6902." } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "put": { "tags": [ "data-asset" ], "summary": "Update data asset.", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "description": "Updated data asset successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The input request conflicts with the current state of the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "in": "path", "name": "data-asset-id", "schema": { "type": "string" }, "required": true } ], "operationId": "updateDataAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataAsset" } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } } }, "openapi": "3.0.0", "components": { "schemas": { "BatchIdDto": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } }, "DataAsset": { "type": "object", "title": "Data Asset", "required": [ "appType", "technicalName" ], "properties": { "id": { "type": "string", "description": "Only required when updating the resource. Must be null for new resources." }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "tags": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "appId": { "type": "string" }, "appType": { "type": "string" }, "ownerId": { "type": "string", "description": "The value is automatically set by the application." }, "spaceId": { "type": "string" }, "version": { "type": "integer", "format": "int64", "description": "Only required when updating the resource. Must be null for new resources." }, "tenantId": { "type": "string", "readOnly": true, "description": "The value is automatically set by the application. User defined value is ignored." }, "createdBy": { "type": "string", "readOnly": true, "description": "The value is automatically set by the application. User defined value is ignored." }, "properties": { "type": "object", "description": "A Map of name-value pairs.", "additionalProperties": { "type": "object", "description": "A Map of name-value pairs." } }, "createdTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The value is automatically set by the application. User defined value is ignored." }, "description": { "type": "string", "maxLength": 1024, "minLength": 0 }, "dataFreshness": { "type": "string", "format": "date-time", "description": "The date-time when the source data was last changed" }, "dataStoreInfo": { "$ref": "#/components/schemas/DataStoreInfo" }, "technicalName": { "type": "string", "maxLength": 255, "minLength": 1 }, "lastModifiedBy": { "type": "string", "readOnly": true, "description": "The value is automatically set by the application. User defined value is ignored." }, "lastModifiedTime": { "type": "string", "format": "date-time", "readOnly": true, "description": "The value is automatically set by the application. User defined value is ignored." }, "technicalDescription": { "type": "string", "maxLength": 1024, "minLength": 0 } } }, "DataStoreInfo": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true } } }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "status": { "type": "string" } } }, "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } }, "traceId": { "type": "string" } } }, "JsonPatch": { "type": "object", "required": [ "op", "path" ], "properties": { "op": { "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "type": "string", "description": "The operation to be performed." }, "from": { "type": "string", "description": "A JSON Pointer path pointing to the location to move/copy from." }, "path": { "type": "string", "description": "A JSON pointer to the property being affected." }, "value": { "type": "object", "description": "The value to add, replace or test." } } } } }, "servers": [ { "url": "https://{tenant}.{region}.qlikcloud.com", "variables": { "region": { "default": "us", "description": "The region the tenant is hosted in" }, "tenant": { "default": "your-tenant", "description": "Name of the tenant that will be called" } } } ] }