Report templates

Download specification

Get descriptive info for the specified templates.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • limitinteger

    If present, restrict the number of returned items to this value.

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

  • namestring

    Template name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix.

  • ownerIdstring

    Return the templates for the specified owner.

  • skipinteger

    If present, skip this number of the returned values in the result set (facilitates paging).

    minimum = 0, maximum = 2147483647, default = 0, format = int32, default = 0

  • sortarray of strings

    Field to sort by. Prefix with +/- to indicate ascending/descending. By default, the sort order is ascending.

    Values may be any of: "name""+name""-name""createdAt""+createdAt""-createdAt""updatedAt""+updatedAt""-updatedAt""type""+type""-type"

  • sourceAppIdstring

    Return the templates that are using the specified app as data source.

Responses

200

application/json

The templates list was retrieved.

  • application/jsonobject
    Show application/json properties
    • dataarray of objects

      The current page data.

      Show data properties
      • idstring

        The template ID

        format = "uuid"

      • namestring

        Template name

      • ownerIdstring

        The user that this template is scoped to.

      • createdAtstring

        The date and time when the template was created.

        format = "date-time"

      • createdBystring

        The id of the user who created the template.

      • updatedAtstring

        The date and time when the template was last updated.

        format = "date-time"

      • updatedBystring

        The id of the user who last updated the template.

      • descriptionstring

        Template description

      • sourceAppIdstring

        The id of the app that this template is using as data source.

      • sourceAppNamestring

        The name of the app that this template is using as data source.

      • metadataVersioninteger

        The template metadata version

        format = int32

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          The URL for the pagination link.

          format = "uri"

      • prevobject
        Show prev properties
        • hrefstring

          The URL for the pagination link.

          format = "uri"

      • selfobject
        Show self properties
        • hrefstring

          The URL for the pagination link.

          format = "uri"

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

GET /v1/report-templates 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates" \
-H "Authorization: Bearer <API-key>"

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

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
      "name": "Qlik report",
      "ownerId": "0rTsxGg_rtsZAs19Zib_421n6haydjIh",
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
      "updatedAt": "2018-10-30T07:06:22Z",
      "updatedBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
      "description": "A daily report of interesting data",
      "sourceAppId": "c4c70012-29c7-47c2-820d-4ff74cb164a9",
      "sourceAppName": "Qlik app",
      "metadataVersion": 1
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Create a new report template.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Request Body

application/json

The upload request.

  • application/jsonobject
    Show application/json properties
    • namestring
      Required

      Template name

      minLength = 1, maxLength = 255

    • descriptionstring

      Template description

      maxLength = 255

    • sourceAppIdstring

      The ID of the app that this template is using as data source. The id stored in the template file metadata is used if no value is specified.

    • sourceAppActionstring

      Specifies the action to perform with the given source app id. Use "validate" to verify that the template source app matches the provided value. Use "replace" to migrate the template to a different app by replacing the source app id.

      Can be one of: "validate""replace"

    • temporaryContentIdstring
      Required

      The ID of a previously uploaded temporary content file

      minLength = 1

Responses

201

application/json

New template was created.

  • application/jsonobject
    Show application/json properties
    • idstring

      The template ID

      format = "uuid"

    • namestring

      Template name

    • ownerIdstring

      The user that this template is scoped to.

    • createdAtstring

      The date and time when the template was created.

      format = "date-time"

    • createdBystring

      The id of the user who created the template.

    • updatedAtstring

      The date and time when the template was last updated.

      format = "date-time"

    • updatedBystring

      The id of the user who last updated the template.

    • descriptionstring

      Template description

    • sourceAppIdstring

      The id of the app that this template is using as data source.

    • sourceAppNamestring

      The name of the app that this template is using as data source.

    • metadataVersioninteger

      The template metadata version

      format = int32

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

413

application/json

The template file exceeds the user's quota for maximum file to upload.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

POST /v1/report-templates 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","description":"string","sourceAppId":"string","sourceAppAction":"validate","temporaryContentId":"string"}'

const https = require('https')
  const data = JSON.stringify({"name":"string","description":"string","sourceAppId":"string","sourceAppAction":"validate","temporaryContentId":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/report-templates',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "name": "string",
  "description": "string",
  "sourceAppId": "string",
  "sourceAppAction": "validate",
  "temporaryContentId": "string"
}

Response

{
  "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
  "name": "Qlik report",
  "ownerId": "0rTsxGg_rtsZAs19Zib_421n6haydjIh",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "description": "A daily report of interesting data",
  "sourceAppId": "c4c70012-29c7-47c2-820d-4ff74cb164a9",
  "sourceAppName": "Qlik app",
  "metadataVersion": 1
}

Get descriptive info for the specified report template.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Path Parameters

  • idstring
    Required

    The ID of the report template.

    format = "uuid"

Responses

200

application/json

The template was located.

  • application/jsonobject
    Show application/json properties
    • idstring

      The template ID

      format = "uuid"

    • namestring

      Template name

    • ownerIdstring

      The user that this template is scoped to.

    • createdAtstring

      The date and time when the template was created.

      format = "date-time"

    • createdBystring

      The id of the user who created the template.

    • updatedAtstring

      The date and time when the template was last updated.

      format = "date-time"

    • updatedBystring

      The id of the user who last updated the template.

    • descriptionstring

      Template description

    • sourceAppIdstring

      The id of the app that this template is using as data source.

    • sourceAppNamestring

      The name of the app that this template is using as data source.

    • metadataVersioninteger

      The template metadata version

      format = int32

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

A template with the specified ID was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

GET /v1/report-templates/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates/{id}" \
-H "Authorization: Bearer <API-key>"

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

This API is not included yet in qlik-cli

Response

{
  "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
  "name": "Qlik report",
  "ownerId": "0rTsxGg_rtsZAs19Zib_421n6haydjIh",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "description": "A daily report of interesting data",
  "sourceAppId": "c4c70012-29c7-47c2-820d-4ff74cb164a9",
  "sourceAppName": "Qlik app",
  "metadataVersion": 1
}

Patch an existing report template.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Path Parameters

  • idstring
    Required

    The ID of the report template to patch.

    format = "uuid"

Request Body

application/json

A JSON patch request as defined by RFC 6902.

  • application/jsonarray of objects
    Show application/json properties
    • opstring
    • fromstring
    • pathstring
    • valueobject

application/json-patch+json

A JSON patch request as defined by RFC 6902.

  • application/json-patch+jsonarray of objects

Responses

204

Patch successfully applied to template.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

A template with the specified ID was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

409

application/json

Conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

413

application/json

The template file exceeds the user's quota for maximum file to upload.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

PATCH /v1/report-templates/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"string","from":"string","path":"string","value":{}}]'

const https = require('https')
  const data = JSON.stringify([{"op":"string","from":"string","path":"string","value":{}}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/report-templates/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

[
  {
    "op": "string",
    "from": "string",
    "path": "string",
    "value": {}
  }
]

Update an existing report template.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Path Parameters

  • idstring
    Required

    The ID of the report template to update.

    format = "uuid"

Request Body

application/json

The upload request.

  • application/jsonobject
    Show application/json properties
    • namestring
      Required

      Template name

      minLength = 1, maxLength = 255

    • descriptionstring

      Template description

      maxLength = 255

    • temporaryContentIdstring
      Required

      The ID of a previously uploaded temporary content file

      minLength = 1

Responses

201

application/json

The template was updated.

  • application/jsonobject
    Show application/json properties
    • idstring

      The template ID

      format = "uuid"

    • namestring

      Template name

    • ownerIdstring

      The user that this template is scoped to.

    • createdAtstring

      The date and time when the template was created.

      format = "date-time"

    • createdBystring

      The id of the user who created the template.

    • updatedAtstring

      The date and time when the template was last updated.

      format = "date-time"

    • updatedBystring

      The id of the user who last updated the template.

    • descriptionstring

      Template description

    • sourceAppIdstring

      The id of the app that this template is using as data source.

    • sourceAppNamestring

      The name of the app that this template is using as data source.

    • metadataVersioninteger

      The template metadata version

      format = int32

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

A template with the specified ID was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

409

application/json

Conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

413

application/json

The template file exceeds the user's quota for maximum file to upload.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

PUT /v1/report-templates/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","description":"string","temporaryContentId":"string"}'

const https = require('https')
  const data = JSON.stringify({"name":"string","description":"string","temporaryContentId":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/report-templates/{id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  

This API is not included yet in qlik-cli

Request

{
  "name": "string",
  "description": "string",
  "temporaryContentId": "string"
}

Response

{
  "id": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
  "name": "Qlik report",
  "ownerId": "0rTsxGg_rtsZAs19Zib_421n6haydjIh",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "0rTsxGg_rtsZAs19Zib_421n6htydjIh",
  "description": "A daily report of interesting data",
  "sourceAppId": "c4c70012-29c7-47c2-820d-4ff74cb164a9",
  "sourceAppName": "Qlik app",
  "metadataVersion": 1
}

Delete the specified report template.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Path Parameters

  • idstring
    Required

    The ID of the report template to delete.

    format = "uuid"

Responses

204

The template was deleted.

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

DELETE /v1/report-templates/{id} 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates/{id}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"

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

This API is not included yet in qlik-cli

Download the template file of the specified report template

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Path Parameters

  • idstring
    Required

    The ID of the report template.

    format = "uuid"

Responses

200

application/octet-stream

The template file.

  • application/octet-streamstring

    format = "binary"

400

application/json

Bad Request

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

403

application/json

Forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

404

application/json

Not Found

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • statusCodeinteger

      format = int32

POST /v1/report-templates/{id}/actions/download 
curl "https://your-tenant.us.qlikcloud.com/api/v1/report-templates/{id}/actions/download" \
-X POST \
-H "Authorization: Bearer <API-key>" \
-o "output-file"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/report-templates/{id}/actions/download',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli