Machine Learning

The Machine Learning API allows you to generate profile insights to analyze datasets, create and manage machine learning experiments, deploy models, and run predictions.

Download specification

Endpoints

GET

/v1/ml/deployments
POST

/v1/ml/deployments
GET

/v1/ml/deployments/{deploymentId}
PATCH

/v1/ml/deployments/{deploymentId}
DELETE

/v1/ml/deployments/{deploymentId}
POST

/v1/ml/deployments/{deploymentId}/actions/activate-models
POST

/v1/ml/deployments/{deploymentId}/actions/deactivate-models
GET

/v1/ml/deployments/{deploymentId}/batch-predictions
POST

/v1/ml/deployments/{deploymentId}/batch-predictions
GET

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
PATCH

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
DELETE

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}
POST

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict
GET

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
PATCH

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
PUT

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
DELETE

/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule
POST

/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run
GET

/v1/ml/experiments
POST

/v1/ml/experiments
GET

/v1/ml/experiments/{experimentId}
PATCH

/v1/ml/experiments/{experimentId}
DELETE

/v1/ml/experiments/{experimentId}
GET

/v1/ml/experiments/{experimentId}/models
GET

/v1/ml/experiments/{experimentId}/models/{modelId}
GET

/v1/ml/experiments/{experimentId}/versions
POST

/v1/ml/experiments/{experimentId}/versions
GET

/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
PATCH

/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
DELETE

/v1/ml/experiments/{experimentId}/versions/{experimentVersionId}
POST

/v1/ml/jobs/{corrType}/{corrId}/actions/cancel
POST

/v1/ml/profile-insights
GET

/v1/ml/profile-insights/{dataSetId}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

filterstring
Deployment fields by which you can filter responses.
- spaceId ID string (or empty string for personal space) - ID of space in which deployment(s) exist
- modelId UUID string - By model ID
- createdBy ID string
- ownerId ID string
- approverId ID string - ID of user that approved a model in the deployment
- experimentId UUID string - ID of experiment in which model(s) exist
- experimentVersionId UUID string - ID of experiment version in which model(s) exist
- predictionEnabled boolean - Are predictions enabled
- exactName string - Deployments with exact name. Names may not be unique.
- nameContains string - Deployments where name includes this. Names may not be unique
- modelName string - Partial or exact, case-insensitive name of model in the deployment
- modelState enum string - State by which to find models
  - Valid states: pending, enabled, disabled, inactive
sortstring

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limitinteger

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Required
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  Required
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  Required
  
  ID of owner/user for this entity
  
  spaceIdstring
  Required
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  enablePredictionsboolean
  Required
  
  Whether to allow predictions
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

GET /v1/ml/deployments

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "deployment",
      "attributes": {
        "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "name": "string",
        "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
        "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "ownerId": "string",
        "spaceId": "string",
        "createdAt": "string",
        "createdBy": "string",
        "updatedAt": "string",
        "deprecated": true,
        "description": "string",
        "errorMessage": "string",
        "enablePredictions": true
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Request Body

application/json

Input for creating a new deployment

application/jsonobject

Input for creating a new deployment
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "deployment"
  
  default = "deployment"
  
  attributesobject
  
  Show attributes properties
  
  namestring
  Required
  
  Name of this entity
  
  modelIdstring
  Required
  
  ID of the model
  
  format = "uuid"
  
  spaceIdstring
  Required
  
  Space ID for this entity (empty string for personal space)
  
  deprecatedboolean
  
  Whether this deployment is deprecated
  
  descriptionstring
  
  Description of this entity
  
  enablePredictionsboolean
  
  Whether to allow real-time predictions

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Required
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  Required
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  Required
  
  ID of owner/user for this entity
  
  spaceIdstring
  Required
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  enablePredictionsboolean
  Required
  
  Whether to allow predictions

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

POST /v1/ml/deployments

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"deployment","attributes":{"name":"string","modelId":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4","spaceId":"string","deprecated":true,"description":"string","enablePredictions":true}}}'

const https = require('https')
  const data = JSON.stringify({"data":{"type":"deployment","attributes":{"name":"string","modelId":"c35f4b70-3ce4-4a30-b62b-2aef16943bc4","spaceId":"string","deprecated":true,"description":"string","enablePredictions":true}}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "data": {
    "type": "deployment",
    "attributes": {
      "name": "string",
      "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "spaceId": "string",
      "deprecated": true,
      "description": "string",
      "enablePredictions": true
    }
  }
}

Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "deployment",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
      "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "ownerId": "string",
      "spaceId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "deprecated": true,
      "description": "string",
      "errorMessage": "string",
      "enablePredictions": true
    }
  }
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "deployment"
  
  attributesobject
  Required
  
  A deployed model against which you can run predictions
  
  Show attributes properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  Required
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  modelIdstring
  Required
  
  ID of the model
  
  format = "uuid"
  
  ownerIdstring
  Required
  
  ID of owner/user for this entity
  
  spaceIdstring
  Required
  
  Space ID for this entity (empty string for personal space)
  
  createdAtstring
  Required
  
  Timestamp when this was created
  
  createdBystring
  Required
  
  ID of the owner/user that created this entity
  
  updatedAtstring
  Required
  
  Timestamp when this was updated
  
  deprecatedboolean
  Required
  
  Whether this deployment is deprecated
  
  descriptionstring
  Required
  
  Description of this entity
  
  errorMessagestring
  
  JSON string of error object
  
  enablePredictionsboolean
  Required
  
  Whether to allow predictions

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

GET /v1/ml/deployments/{deploymentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "deployment",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
      "modelId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "ownerId": "string",
      "spaceId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "updatedAt": "string",
      "deprecated": true,
      "description": "string",
      "errorMessage": "string",
      "enablePredictions": true
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/json

Values that can be patched.

application/jsonarray of objects

Values that can be patched.
Show application/json properties
- opstring
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- pathstring
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/spaceId"
- valueany
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

PATCH /v1/ml/deployments/{deploymentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New Name"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/name","value":"New Name"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New Name"
  }
]

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

DELETE /v1/ml/deployments/{deploymentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

POST /v1/ml/deployments/{deploymentId}/actions/activate-models

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/actions/activate-models" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/actions/activate-models',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

POST /v1/ml/deployments/{deploymentId}/actions/deactivate-models

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models" \
-X POST \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/actions/deactivate-models',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Query Parameters

filterstring
Batch prediction fields by which you can filter responses.
- modelId UUID string - By model ID
sortstring

Field(s) by which to sort response

Can be one of: "createdAt""+createdAt""-createdAt""description""+description""-description""name""+name""-name""updatedAt""+updatedAt""-updatedAt"
limitinteger

Number of results per page. Default is 32.

maximum = 100, default = 32, default = 32
offsetinteger

Number of rows to skip before getting page[size]

Path Parameters

deploymentIdstring
Required

ID of the deployment

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  ownerIdstring
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Show writeback properties
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  A column name upon which to create an index
  
  deploymentIdstring
  
  ID of the deployment that processes these predictions
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset
- metaobject
  
  Meta for FIND operations
  
  Show meta properties
  
  countinteger
  Required
- linksobject
  Required
  
  Resource links included in paginated responses
  
  Show links properties
  
  lastobject
  Required
  
  Show last properties
  
  hrefstring
  
  Link to the last set of responses from limit minus offset to limit
  
  format = "uri"
  
  nextobject
  Required
  
  Show next properties
  
  hrefstring
  
  Link to the next set of responses
  
  format = "uri"
  
  prevobject
  Required
  
  Show prev properties
  
  hrefstring
  
  Link to the previous set of responses
  
  format = "uri"
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  
  Link to the current set of responses
  
  format = "uri"
  
  firstobject
  Required
  
  Show first properties
  
  hrefstring
  
  Link to the first set of responses from offset 0 to count `limit``
  
  format = "uri"

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

GET /v1/ml/deployments/{deploymentId}/batch-predictions

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/batch-predictions',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "type": "batch-prediction",
      "attributes": {
        "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "name": "string",
        "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
        "status": "modified",
        "ownerId": "string",
        "schedule": {
          "status": "pending",
          "timezone": "America/Toronto",
          "recurrence": [
            [
              "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
              "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
            ]
          ],
          "endDateTime": "string",
          "chronosJobId": "string",
          "startDateTime": "string",
          "failureAttempts": 42,
          "applyDatasetChangeOnly": true,
          "lastSuccessfulDateTime": "string"
        },
        "createdAt": "string",
        "createdBy": "string",
        "dataSetId": "672e55cfcadfb8a18281523e",
        "datasetId": "string",
        "updatedAt": "string",
        "writeback": {
          "format": "parquet",
          "dstName": "string",
          "spaceId": "string",
          "dstShapName": "string",
          "dstSourceName": "string",
          "dstCoordShapName": "string",
          "dstNotPredictedName": "string"
        },
        "indexColumn": "string",
        "deploymentId": "string",
        "errorMessage": "string",
        "outputDataset": "string"
      }
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment

Request Body

application/json

Input values for creating a batch prediction configuration

application/jsonobject

Input values for creating a batch prediction configuration
Show application/json properties
- dataobject
  
  Show data properties
  
  typestring
  
  Can be one of: "batch-prediction"
  
  default = "batch-prediction"
  
  attributesobject
  
  Show attributes properties
  
  namestring
  
  Name of this entity
  
  scheduleobject
  
  Configuration to schedule a batch prediction
  
  Show schedule properties
  
  timezonestring
  Required
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job is scheduled to finish
  
  startDateTimestring
  Required
  
  When the job is scheduled to start
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  writebackobject
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Show writeback properties
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  descriptionstring
  
  indexColumnstring
  
  A column name upon which to create an index (empty string or undefined will default to automl-generated index)
  
  deploymentIdstring
  
  The ID of the deployment used to make these predictions

Responses

201

application/json

Created

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  ownerIdstring
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Show writeback properties
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  A column name upon which to create an index
  
  deploymentIdstring
  
  ID of the deployment that processes these predictions
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

POST /v1/ml/deployments/{deploymentId}/batch-predictions

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"data":{"type":"batch-prediction","attributes":{"name":"string","schedule":{"timezone":"America/Toronto","recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0"],"endDateTime":"2025-12-31T23:59:00","startDateTime":"2025-12-25T00:00:00","applyDatasetChangeOnly":true},"dataSetId":"672e55cfcadfb8a18281523e","writeback":{"format":"parquet","dstName":"string","spaceId":"string","dstShapName":"string","dstSourceName":"string","dstCoordShapName":"string","dstNotPredictedName":"string"},"description":"string","indexColumn":"string","deploymentId":"string"}}}'

const https = require('https')
  const data = JSON.stringify({"data":{"type":"batch-prediction","attributes":{"name":"string","schedule":{"timezone":"America/Toronto","recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0"],"endDateTime":"2025-12-31T23:59:00","startDateTime":"2025-12-25T00:00:00","applyDatasetChangeOnly":true},"dataSetId":"672e55cfcadfb8a18281523e","writeback":{"format":"parquet","dstName":"string","spaceId":"string","dstShapName":"string","dstSourceName":"string","dstCoordShapName":"string","dstNotPredictedName":"string"},"description":"string","indexColumn":"string","deploymentId":"string"}}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/batch-predictions',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "data": {
    "type": "batch-prediction",
    "attributes": {
      "name": "string",
      "schedule": {
        "timezone": "America/Toronto",
        "recurrence": [
          "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=16;BYMINUTE=30;BYSECOND=0"
        ],
        "endDateTime": "2025-12-31T23:59:00",
        "startDateTime": "2025-12-25T00:00:00",
        "applyDatasetChangeOnly": true
      },
      "dataSetId": "672e55cfcadfb8a18281523e",
      "writeback": {
        "format": "parquet",
        "dstName": "string",
        "spaceId": "string",
        "dstShapName": "string",
        "dstSourceName": "string",
        "dstCoordShapName": "string",
        "dstNotPredictedName": "string"
      },
      "description": "string",
      "indexColumn": "string",
      "deploymentId": "string"
    }
  }
}

Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
      "status": "modified",
      "ownerId": "string",
      "schedule": {
        "status": "pending",
        "timezone": "America/Toronto",
        "recurrence": [
          [
            "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
            "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
          ]
        ],
        "endDateTime": "string",
        "chronosJobId": "string",
        "startDateTime": "string",
        "failureAttempts": 42,
        "applyDatasetChangeOnly": true,
        "lastSuccessfulDateTime": "string"
      },
      "createdAt": "string",
      "createdBy": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "datasetId": "string",
      "updatedAt": "string",
      "writeback": {
        "format": "parquet",
        "dstName": "string",
        "spaceId": "string",
        "dstShapName": "string",
        "dstSourceName": "string",
        "dstCoordShapName": "string",
        "dstNotPredictedName": "string"
      },
      "indexColumn": "string",
      "deploymentId": "string",
      "errorMessage": "string",
      "outputDataset": "string"
    }
  }
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

200

application/json

OK

application/jsonobject
Show application/json properties
- dataobject
  Required
  
  Show data properties
  
  idstring
  Required
  
  ID of this entity
  
  format = "uuid"
  
  typestring
  Required
  
  Can be one of: "batch-prediction"
  
  attributesobject
  Required
  
  A batch prediction job configuration
  
  Show attributes properties
  
  idstring
  
  ID of this entity
  
  format = "uuid"
  
  namestring
  
  Name of this entity
  
  errorsarray of objects
  
  JSON string with list of error objects.
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error
  
  statusstring
  
  Status of this batch prediction
  
  Can be one of: "modified""ready""error""cancelled""pending"
  
  ownerIdstring
  
  ID of owner/user for this entity
  
  scheduleobject
  
  Batch prediction job schedule
  
  Show schedule properties
  
  statusstring
  
  The status of the schedule
  
  Can be one of: "pending""active""error""error_scheduler_unreachable""error_scheduler_callback_error""licence_advanced_features_required""failing_schedule_permission"
  
  timezonestring
  
  Timezone used for the date-time fields
  
  recurrencearray of strings
  
  Recurrence rules. Maximum is DAILY but you can specify the hour, minute, and second it runs each day. One string per rule.
  
  endDateTimestring
  
  When the job finished
  
  chronosJobIdstring
  
  The ID of the chronos job
  
  startDateTimestring
  
  When the job is scheduled to start
  
  failureAttemptsnumber
  
  Number of times a scheduled prediction job has failed
  
  applyDatasetChangeOnlyboolean
  
  If true, only run prediction if dataset has changed to avoid duplicates. If set to false, re-runs predictions on unchanged datasets.
  
  default = true
  
  lastSuccessfulDateTimestring
  
  When the last successful job happened
  
  createdAtstring
  
  Timestamp when this was created
  
  createdBystring
  
  ID of the owner/user that ran this prediction batch
  
  dataSetIdstring
  
  The Qlik catalog dataset ID
  
  datasetIdstring
  
  ID of the dataset with the prediction results
  
  updatedAtstring
  
  Timestamp when this was updated
  
  writebackobject
  
  Sets which files, file names, and spaces are used to write results of batch predictions (output files) to the catalog.
  
  Show writeback properties
  
  formatstring
  Required
  
  File format for write back files (this applies to all)
  
  Can be one of: "qvd""parquet""csv"
  
  default = "parquet"
  
  dstNamestring
  Required
  
  spaceIdstring
  Required
  
  Space ID where you want to save batch prediction writebacks or empty string ('') save them to your personal space.
  
  dstShapNamestring
  
  dstSourceNamestring
  
  dstCoordShapNamestring
  
  dstNotPredictedNamestring
  
  indexColumnstring
  
  A column name upon which to create an index
  
  deploymentIdstring
  
  ID of the deployment that processes these predictions
  
  errorMessagestring
  
  JSON string of error object
  
  outputDatasetstring
  
  Where to output dataset

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

GET /v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": {
    "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "type": "batch-prediction",
    "attributes": {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "string",
      "errors": "[{\"code\":\"AML-145\",\"title\":\"datasync dependent service error, service profile\",\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\",\"meta\":{\"errorId\":\"c1546687-ad5d-4002-87f6-8c9711298db1\"}}]\n",
      "status": "modified",
      "ownerId": "string",
      "schedule": {
        "status": "pending",
        "timezone": "America/Toronto",
        "recurrence": [
          [
            "Daily at 11:10:00 AM [\"RRULE:FREQ=DAILY;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]",
            "Weekly on Mondays at 11:10:00 AM [\"RRULE:FREQ=WEEKLY;INTERVAL:1;BYDAY=MO;BYHOUR=11;BYMINUTE=10;BYSECOND=0\"]"
          ]
        ],
        "endDateTime": "string",
        "chronosJobId": "string",
        "startDateTime": "string",
        "failureAttempts": 42,
        "applyDatasetChangeOnly": true,
        "lastSuccessfulDateTime": "string"
      },
      "createdAt": "string",
      "createdBy": "string",
      "dataSetId": "672e55cfcadfb8a18281523e",
      "datasetId": "string",
      "updatedAt": "string",
      "writeback": {
        "format": "parquet",
        "dstName": "string",
        "spaceId": "string",
        "dstShapName": "string",
        "dstSourceName": "string",
        "dstCoordShapName": "string",
        "dstNotPredictedName": "string"
      },
      "indexColumn": "string",
      "deploymentId": "string",
      "errorMessage": "string",
      "outputDataset": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Request Body

application/json

Values that can be patched. - name: Name of this entity - description: Description of this entity - dataSetId - outputDataset - indexColumn: Column name upon which to create an index (empty string or undefined will default to automl-generated index) - applyDatasetChangeOnly - ownerId: ID of batch owner/user - writeback: Where to write prediction results

application/jsonarray of objects
Values that can be patched.
- name: Name of this entity
- description: Description of this entity
- dataSetId
- outputDataset
- indexColumn: Column name upon which to create an index (empty string or undefined will default to automl-generated index)
- applyDatasetChangeOnly
- ownerId: ID of batch owner/user
- writeback: Where to write prediction results
Show application/json properties
- opstring
  Required
  
  All patch requests use the replace operation
  
  Can be one of: "replace"
- pathstring
  Required
  
  Path for the property you want to update
  
  Can be one of: "/name""/description""/dataSetId""/indexColumn""/applyDatasetChangeOnly""/ownerId""/writeback/spaceId""/writeback/format""/writeback/dstName""/writeback/dstShapName""/writeback/dstCoordShapName""/writeback/dstNotPredictedName""/writeback/dstSourceName"
- valueany
  Required
  
  Use for fields that can be any type (string, number, etc.)

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

502

application/json

Bad Gateway

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

503

application/json

Service Unavailable

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

default

application/json

Unexpected Error

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

PATCH /v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"New Name"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/name","value":"New Name"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New Name"
  }
]

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories

Path Parameters

deploymentIdstring
Required

ID of the deployment
batchPredictionIdstring
Required

ID of the batch prediction

Responses

204

No Content

400

application/json

Bad Request

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

401

application/json

Unauthorized

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

403

application/json

Forbidden

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

404

application/json

Not Found

application/jsonobject
Show application/json properties
- errorsarray of objects
  Required
  
  An error object
  
  uniqueItems = true
  
  Show errors properties
  
  codestring
  Required
  
  Qlik error code (not HTTP response status code)
  
  metaobject
  
  Additional details about the error. These may vary by error.
  
  Show meta properties
  
  issuestring
  
  The issue code
  
  detailsstring
  
  Extra details for what may have caused the error
  
  errorIdstring
  
  The unique id of the error instance
  
  argumentstring
  
  The argument
  
  resourcestring
  
  The resource type that the error occurred on
  
  resourceIdstring
  
  The resource id that the error occurred on
  
  titlestring
  Required
  
  Short summary of error
  
  detailstring
  
  Description of the error

500

application/json

Internal Error

application/json

Machine Learning

Endpoints

List deployments

Facts

Query Parameters

Responses

200

400

401

403

404

500

502

503

default

Response

Create a deployment

Facts

Request Body

Responses

201

400

401

403

500

502

503

default

Request

Response

Get a deployment

Facts

Path Parameters

Responses

200

400

401

403

404

500

502

503

default

Response

Update a deployment

Facts

Path Parameters

Request Body

Responses

204

400

401

403

404

500

502

503

default

Request

Delete a deployment

Facts

Path Parameters

Responses

204

400

401

403

404

500

502

503

default

Activate the model for this deployment

Facts

Path Parameters

Responses

204

400

401

403