Qlik NPrinting API

You can extend your reporting system by using the Qlik NPrinting API. This API provides endpoints to perform operations on apps, On-Demand requests and results, reports, filters, and so on.

For all requests, the data returned is filtered based on user permissions. That is, if a user is not authorized to access a certain object, that object is not returned in the reponse.

API Stability: Experimental.

Deprecation period: None. Can change at any point and should be used only to evaluate upcoming functionality.

Version: 0.4.0

Methods

[ Jump to Models ]

Table of Contents

Apps

Authentication

Connections

Filters

Groups

OnDemand

Reports

Roles

TaskExecutions

Tasks

Users

Apps

Up
get /apps
Generates the list of Qlik NPrinting Apps.

This endpoint returns the complete list of Qlik NPrinting apps that the current user has permission to see. The list is always filtered based on user permissions.

The response includes the title and other details about each app, and lists the apps in the order specified by the sort parameter.

Query parameters

sort (optional)

A comma separated list of fields to use for sorting the apps. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /apps?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

AppListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "created" : "2000-01-23T04:56:07.000+00:00",
      "name" : "aeiou",
      "description" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }
}

Responses

200

Success. A paginated list of apps is returned.

400

The string of query parameters is malformed.

Up
get /apps/{id}
Returns details about a specific app.
This endpoint returns detailed information about the app specified by the id parameter. The calling user must be authorized to view the specified app.

Path parameters

id (required)
The ID of the app.

Return type

AppResponse

Example data

Content-Type: application/json
{
  "data" : {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "name" : "aeiou",
    "description" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}

Responses

200

Success. The app details are returned.

400

The id parameter is malformed.

404

An app with the specified ID does not exist.

Authentication

Up
get /login/ntlm
Authenticates the caller using NTLM authentication.

Call this endpoint to authenticate the user. For cross-site (CORS) requests, set withCredentials to true.

Javascript clients must pass the NTLM token using XHR credentials.

Examples:


// Plain javascript
// https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials

var xhr = new XMLHttpRequest();
xhr.open('GET', 'http://example.com:port/api/v1/login/ntlm', true);
xhr.withCredentials = true;
xhr.send(null);

// Jquery
// http://api.jquery.com/jquery.ajax/

$.ajax({
   url: 'http://example.com:port/api/v1/login/ntlm',
   xhrFields: {
      withCredentials: true
   }
});

Responses

200

The user is authenticated.

403

The user is not authenticated. The user is not in the system, is not bound to a Windows domain, or is not authorized to use the APIs.

Connections

Up
get /connections
Gets the list of connections.
Returns the list of connections. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.

Query parameters

app_id (optional)
The ID of the app to filter on.
sort (optional)

A comma separated list of fields to be used for sorting the connections. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /connections?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

ConnectionListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "connectionString" : "aeiou",
      "created" : "2000-01-23T04:56:07.000+00:00",
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "name" : "aeiou",
      "connectionStatus" : "Unknown",
      "description" : "aeiou",
      "cacheStatus" : "NeverGenerated",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ]
  }
}

Responses

200

Success. A paginated list of connections is returned.

400

The specified ID is not a valid GUID.

Up
get /connections/{id}
Gets a specific connection.
Returns the connection specified by the id parameter.

Path parameters

id (required)
The ID of the connection.

Return type

ConnectionResponse

Example data

Content-Type: application/json
{
  "data" : {
    "connectionString" : "aeiou",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "aeiou",
    "connectionStatus" : "Unknown",
    "description" : "aeiou",
    "cacheStatus" : "NeverGenerated",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}

Responses

200

Success. The specified connection is returned.

400

The specified ID is not a valid GUID.

404

A connection with the specified ID was not found.

Up
patch /connections/{id}/reload
Aborts all reload metadata for a specific connection. This is requested by setting the status field to "aborted".
Aborts all running reload metadata for the connection specified by the id parameter.

Path parameters

id (required)
The ID of the connection.

Request body

patch (required)
Patch_2 The status patch.

Return type

ConnectionResponse

Example data

Content-Type: application/json
{
  "data" : {
    "connectionString" : "aeiou",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "aeiou",
    "connectionStatus" : "Unknown",
    "description" : "aeiou",
    "cacheStatus" : "NeverGenerated",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}

Responses

200

Success. The specified connection is returned.

400

The ID of the connection is malformed or the patch body is malformed. Currently, only patching the status to "aborted" is supported.

403

The user is not authorized to reload metadata for this connection.

404

A connection with the specified ID was not found.

Up
post /connections/{id}/reload
Reloads metadata for a specific connection.
Reloads metadata for the connection specified by the id parameter.

Path parameters

id (required)
The ID of the connection.

Return type

ConnectionResponse

Example data

Content-Type: application/json
{
  "data" : {
    "connectionString" : "aeiou",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "aeiou",
    "connectionStatus" : "Unknown",
    "description" : "aeiou",
    "cacheStatus" : "NeverGenerated",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}

Responses

200

Success. The specified connection is returned.

400

The specified ID is not a valid GUID.

403

The user is not authorized to reload metadata for this connection.

404

A connection with the specified ID was not found.

Filters

Up
get /filters
Gets the list of filters.

Returns the list of filters that are visible to the user.

The response includes the title and other details about each filter. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.

Query parameters

appId (optional)
The ID of the app to filter on.
enabled (optional)
Indicates whether to retrieve the active filters (true) or inactive filters (false).
sort (optional)

A comma separated list of fields used for sorting the filters. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /filters?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

FilterListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "created" : "2000-01-23T04:56:07.000+00:00",
      "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "aeiou",
      "description" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "fields" : [ {
        "overrideValues" : true,
        "values" : [ {
          "type" : "text",
          "value" : "aeiou"
        } ],
        "name" : "aeiou",
        "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
      } ],
      "enabled" : true
    } ]
  }
}

Responses

200

Success. A paginated list of filters is returned.

400

Parameters of the query string are malformed.

Up
delete /filters/{id}
Deletes a filter.
Deletes the filter specified by the id parameter.

Path parameters

id (required)
The ID of the filter to delete.

Responses

204

Success. The filter has been deleted.

400

The ID of the request is malformed.

403

The user is not authorized to delete a filter.

404

The specified filter was not found.

Up
get /filters/{id}
Gets details of the specified filter.
Returns the details of the filter specified by the id parameter.

Path parameters

id (required)
The ID of the filter.

Return type

FilterResponse

Example data

Content-Type: application/json
{
  "data" : {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "appId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "aeiou",
    "description" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "fields" : [ {
      "overrideValues" : true,
      "values" : [ {
        "type" : "text",
        "value" : "aeiou"
      } ],
      "name" : "aeiou",
      "connectionId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "enabled" : true
  }
}

Responses

200

Success. The specified filter is returned.

400

The filter ID parameter is malformed.

404

The specified filter ID was not found.

Up
put /filters/{id}
Updates an existing filter.
Updates the filter specified by the id parameter.

Path parameters

id (required)
ID of the filter to update.

Request body

body (required)
FilterRequest The filter details to update.

Responses

200

Success. The details of the updated filter are returned.

400

One of the following errors has occurred:

403

The user is not authorized to perform an update request.

404

The specified filter was not found.

Up
post /filters
Creates a new filter.
Creates a new filter, and returns its ID.

Request body

filterRequest (required)
FilterRequest the filter request

Responses

201

Success. The filter has been created.

400

One of the following errors has occurred:

403

The user is not authorized to create a new filter.

Groups

Up
get /groups
Gets the groups.
Returns the list of groups.

Query parameters

groupname (optional)
The group name to use as a filter.
enabled (optional)
Indicates whether to retrieve the active groups (true) or inactive groups (false).
sort (optional)

A comma separated list of fields to use for sorting the entries. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /groups?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

GroupListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "created" : "2000-01-23T04:56:07.000+00:00",
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "aeiou",
      "description" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "enabled" : true
    } ]
  }
}

Responses

200

Success. A paginated list of groups is returned.

400

The query string is malformed.

Up
delete /groups/{id}
Deletes a group.
Deletes the group specified by the id parameter.

Path parameters

id (required)
The ID of the group to delete.

Responses

204

Success. The group has been deleted.

400

The ID of the request is malformed.

403

The user is not authorized to delete a group.

404

The specified group was not found.

Up
get /groups/{id}
Get a specific group.
Returns the group specified by the ID parameter.

Path parameters

id (required)
The ID of the group.

Return type

GroupResponse

Example data

Content-Type: application/json
{
  "data" : {
    "created" : "2000-01-23T04:56:07.000+00:00",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "aeiou",
    "description" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "enabled" : true
  }
}

Responses

200

Success. The group with the specified ID is returned.

400

The ID parameter is malformed.

404

The specified group was not found.

Up
put /groups/{id}
Updates a group.
Update the group specified by the id parameter.

Path parameters

id (required)
The ID of the group to be updated.

Request body

body (required)
GroupUpdateRequest The group details to update.

Responses

200

Success. The details of the updated group are returned.

400

The ID of the request is malformed or the body is malformed.

403

The user is not authorized to perform an update request.

404

The specified group was not found.

Up
get /groups/{id}/users
Gets the users in a group.
Returns the list of users for the specified group.

Path parameters

id (required)
The ID of the group.

Query parameters

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

array[UUID]

Example data

Content-Type: application/json
[ "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]

Responses

200

Success. The list of users for the specified group is returned.

400

One of the following errors has occurred:

404

The specified ID was not found.

Up
post /groups
Adds a new group.
Adds a new group, and returns the group object created.

Request body

request (required)
GroupRequest Details about the group to create.

Responses

201

Success. The group has been created.

400

One of the following errors has occurred:

403

The user is not authorized to create a new group.

OnDemand

Up
get /ondemand/requests
Gets the list of On-Demand requests.
Returns the list of statuses of all the On-Demand requests queued by the calling user. The list can be filtered by a particular app or report. The list is sorted in the order specified by the sort parameter.

Query parameters

appId (optional)
The ID of the app to filter on.
reportId (optional)
The ID of the report to filter on.
sort (optional)

A comma separated list of fields to be used for sorting the requests. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /requests?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

OnDemandRequestStatusListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "reportType" : "Excel",
      "requestType" : "report",
      "created" : "2000-01-23T04:56:07.000+00:00",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "title" : "aeiou",
      "outputFormat" : "pdf",
      "status" : "queued"
    } ]
  }
}

Responses

200

Success. A paginated list of request statuses is returned.

400

The string of query parameters is malformed.

Up
post /ondemand/requests
Queues a new On-Demand request.
This endpoint queues a new report generation request. Use the returned request ID to get the status of this request and to download the report upon completion. Note that Qlik Sense selections specified in the On-Demand request must be of type string or numeric; evaluated formulas are not supported.

Request body

request (required)
OnDemandRequest The request to add to the queue.

Return type

OnDemandRequestStatusResponse

Example data

Content-Type: application/json
{
  "data" : {
    "reportType" : "Excel",
    "requestType" : "report",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "title" : "aeiou",
    "outputFormat" : "pdf",
    "status" : "queued"
  }
}

Responses

202

Accepted. The request has been queued. The status of the request is returned.

400

One of the following errors has occurred:

403

One of the following errors has occurred:


Up
delete /ondemand/requests/{requestId}
Stops and deletes the specified On-Demand request.
Stops and deletes the On-Demand request specified by the reqeustID parameter. Its status is set to "aborted".

Path parameters

requestId (required)
The request ID.

Responses

204

Success. The On-Demand request has been deleted.

400

The request ID is malformed.

403

The user is not authorized to delete the On-Demand request.

404

The request does not exist or has expired.

Up
get /ondemand/requests/{requestId}
Gets details about a specific On-Demand request.
Returns details about the On-Demand request specified by requestID and queued by the current user.

Path parameters

requestId (required)
The request ID.

Return type

OnDemandRequestStatusResponse

Example data

Content-Type: application/json
{
  "data" : {
    "reportType" : "Excel",
    "requestType" : "report",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "title" : "aeiou",
    "outputFormat" : "pdf",
    "status" : "queued"
  }
}

Responses

200

Success. Details about the specified On-Demand request are returned.

400

The request ID is malformed.

404

The request does not exist or has expired.

Up
patch /ondemand/requests/{requestId}
Updates the status of the specified request. Currently, the only supported operation is updating the status field to "aborted".
Aborts an existing On-Demand request. The request is removed from the queue and stopped if it is running. Request status is set to "aborted".

Path parameters

requestId (required)
The request ID.

Request body

patch (required)
Patch The status patch.

Return type

OnDemandRequestStatusResponse

Example data

Content-Type: application/json
{
  "data" : {
    "reportType" : "Excel",
    "requestType" : "report",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "title" : "aeiou",
    "outputFormat" : "pdf",
    "status" : "queued"
  }
}

Responses

200

Success. Details about the patched On-Demand request are returned.

400

The ID of the request is malformed or the patch body is malformed. Currently, only patching the status to "aborted" is supported.

403

The user is not authorized to abort the On-Demand request.

404

The request does not exist or has expired.

Up
get /ondemand/requests/{requestId}/result
Gets the result of a specific On-Demand request.

Returns the result of the On-Demand request specified by the requestID parameter.

Currently, only requests of type "report" are supported. If the request exists but is of type "task", this method returns a 404 error.

The content-type depends on the report output format specified in the original request. It can be one of:

Path parameters

requestId (required)
The request ID.

Responses

200

Success. The binary result file (base64 encoded) of the request (of type "report") is returned.

400

The ID of the request is malformed.

404

One of the following errors has occurred:


Reports

Up
get /reports
Gets the list of enabled and On-Demand enabled reports.

Returns the list of reports that the calling user is authorized to view.

The response includes the title and other details about each report. The list can be filtered by a particular app, and is sorted in the order specified by the sort parameter.

Query parameters

appId (optional)
The ID of the app to filter on.
sort (optional)

A comma separated list of fields to be used for sorting the reports. Allowed field values are "title" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /reports?sort=+title,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

ReportListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "outputFormats" : [ "pdf" ],
      "created" : "2000-01-23T04:56:07.000+00:00",
      "description" : "aeiou",
      "entityId" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "title" : "aeiou",
      "type" : "Excel"
    } ]
  }
}

Responses

200

Success. A paginated list of reports is returned.

400

Parameters of the query string are malformed.

Up
get /reports/{reportId}
Gets details about a specific report.
Returns the details about the specified report specified by the reportId parameter.

Path parameters

reportId (required)
The report ID.

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "data" : {
    "outputFormats" : [ "pdf" ],
    "created" : "2000-01-23T04:56:07.000+00:00",
    "description" : "aeiou",
    "entityId" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "title" : "aeiou",
    "type" : "Excel"
  }
}

Responses

200

Success. The report details are returned.

400

The report ID is malformed.

403

The user is not authorized to view the report, or the report is disabled.

404

ID not found. The report does not exist.

Roles

Up
get /roles
Get the roles.
Returns the list of all roles.

Query parameters

rolename (optional)
The role name to use as a filter.
enabled (optional)
Indicates whether to retrieve the active roles (true) or inactive roles (false).
sort (optional)

A comma separated list of fields to use for sorting the entries. Allowed field values are "name" and "description". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /roles?sort=+name,-description

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

RoleListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "hasAllActions" : true,
      "isSystemRole" : true,
      "hasAllApps" : true,
      "name" : "aeiou",
      "description" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "enabled" : true
    } ]
  }
}

Responses

200

Success. A paginated list of roles is returned.

400

The query string is malformed.

Up
get /roles/{id}
Get a specific role.
Returns the role specified by the id parameter.

Path parameters

id (required)
The ID of the role.

Return type

RoleResponse

Example data

Content-Type: application/json
{
  "data" : {
    "hasAllActions" : true,
    "isSystemRole" : true,
    "hasAllApps" : true,
    "name" : "aeiou",
    "description" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "enabled" : true
  }
}

Responses

200

Success. The specified role is returned.

400

The id parameter is malformed.

404

The specified role was not found.

Up
get /users/{id}/roles
Gets the roles for a user.
Returns the ordered list of role IDs for the specified user.

Path parameters

id (required)
The ID of the user.

Return type

array[UUID]

Example data

Content-Type: application/json
[ "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]

Responses

200

The list of roles for the specified user.

400

One of the following errors has occurred:

404

The specified ID was not found.

Up
put /users/{id}/roles
Updates the roles for a user.
Updates the list of role IDs for the specified user.

Path parameters

id (required)
The ID of the user.

Request body

body (required)
UUID The unordered list of roles for the specified user.

Responses

200

Success. The unordered user role list for the specified user is returned.

400

One of the following errors has occurred:

404

The specified user was not found.

TaskExecutions

Up
get /tasks/{taskId}/executions
Gets the task executions associated with a specific task.
Returns the task executions for the task specified by the taskId parameter.

Path parameters

taskId (required)
The ID of the task.

Query parameters

sort (optional)

A field to be used to sort the tasks executions. Currently, the only allowed field value is "created". It can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.

Usage example: /tasks/{taskId}/executions?sort=+created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

TaskExecutionsListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "result" : "aeiou",
      "task" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "created" : "2000-01-23T04:56:07.000+00:00",
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "progress" : 5.962134,
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "completed" : "2000-01-23T04:56:07.000+00:00",
      "type" : "publish",
      "status" : "WaitingForRetry"
    } ]
  }
}

Responses

200

Success. The list of task executions for the specified task is returned.

400

One of the following errors has occurred:

404

The specified task ID was not found.

Up
get /tasks/{taskId}/executions/{id}
Gets a specific task execution.
Returns the task execution of for the task specified by the taskId and id parameters.

Path parameters

taskId (required)
The ID of the task.
id (required)
The ID of the task execution.

Return type

TaskExecution

Example data

Content-Type: application/json
{
  "result" : "aeiou",
  "task" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "progress" : 0.8008282,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "completed" : "2000-01-23T04:56:07.000+00:00",
  "type" : "publish",
  "status" : "WaitingForRetry"
}

Responses

200

Success. The specified task execution is returned.

400

One of the following errors has occurred:

404

One of the following errors has occurred:


Up
patch /tasks/{taskId}/executions/{id}
Aborts the specified task execution by setting the status to "aborted".
Stops the task specified by the taskId and id parameters.

Path parameters

taskId (required)
The ID of the task.
id (required)
The ID of the execution of the task.

Request body

patch (required)
Patch_1 The status patch.

Return type

TaskExecution

Example data

Content-Type: application/json
{
  "result" : "aeiou",
  "task" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "progress" : 0.8008282,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "completed" : "2000-01-23T04:56:07.000+00:00",
  "type" : "publish",
  "status" : "WaitingForRetry"
}

Responses

200

Success. The specified task execution object is returned.

400

The specified ID is not a valid GUID or the patch body is malformed. Currently, only patching the status to "aborted" is supported.

403

The user is not authorized to abort the specified task.

404

One of the following errors has occurred:


Up
post /tasks/{taskId}/executions
Creates a new task execution.
Creates a new task execution to run the task specified by the taskId parameter.

Path parameters

taskId (required)
The ID of the task to execute.

Request body

config (optional)
TaskExecutionConfig The configuration settings for the task execution.

Return type

TaskExecution

Example data

Content-Type: application/json
{
  "result" : "aeiou",
  "task" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "created" : "2000-01-23T04:56:07.000+00:00",
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "progress" : 0.8008282,
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "completed" : "2000-01-23T04:56:07.000+00:00",
  "type" : "publish",
  "status" : "WaitingForRetry"
}

Responses

202

Accepted. The task execution has been queued.

400

One of the following errors has occurred:

403

The user is not authorized to create the task execution.

404

A task with the specified ID does not exist.

Tasks

Up
get /tasks
Gets the list of tasks.
Returns the list of tasks. If the app_id parameter is specified, only tasks related to that app are returned.

Query parameters

app_id (optional)
The ID of the app to filter on.
type (optional)

The task type to filter on. Currently, only the "publish" task type is supported, and is the default. Other task types (e.g., cache reload, import) will be available in future versions.

Usage example: /tasks?type=publish

sort (optional)

A field to be used to sort the tasks. Currently the only supported field value is "created". It can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order. Default is -created.

Usage example: /tasks?sort=+created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

TasksListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "created" : "2000-01-23T04:56:07.000+00:00",
      "enable" : true,
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "lastExecution" : "2000-01-23T04:56:07.000+00:00",
      "appId" : "aeiou",
      "name" : "aeiou",
      "description" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type" : "aeiou"
    } ]
  }
}

Responses

200

Success. A paginated list of tasks is returned.

400

One of the following errors has occurred:


Up
get /tasks/{id}
Gets a specific task.
Returns the task specified by the id parameter.

Path parameters

id (required)
The ID of the task.

Return type

Task

Example data

Content-Type: application/json
{
  "created" : "2000-01-23T04:56:07.000+00:00",
  "enable" : true,
  "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
  "lastExecution" : "2000-01-23T04:56:07.000+00:00",
  "appId" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "type" : "aeiou"
}

Responses

200

Success. The task with the specified ID is returned.

400

One of the following errors has occurred:

404

The specified task ID was not found.

Users

Up
get /users
Gets the user list.
Returns the list of users.

Query parameters

email (optional)
The email of the user to be used as a filter.
username (optional)
The username to use as a filter.
enabled (optional)
Indicates whether to retrieve the active users (true) or inactive users (false).
sort (optional)

A comma separated list of fields to be used for sorting the users. Allowed field values are "name" and "created". Fields can be prefixed by "+" and "-" to indicate, respectively, ascending and descending order.

Usage example: /users?sort=+name,-created

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

UserListResponse

Example data

Content-Type: application/json
{
  "data" : {
    "totalItems" : 0,
    "offset" : 6,
    "limit" : 1,
    "items" : [ {
      "folder" : "aeiou",
      "created" : "2000-01-23T04:56:07.000+00:00",
      "domainaccount" : "aeiou",
      "timezone" : "aeiou",
      "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
      "subfolder" : "aeiou",
      "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "locale" : "de",
      "email" : "aeiou",
      "enabled" : true,
      "username" : "aeiou"
    } ]
  }
}

Responses

200

Success. A paginated list of users is returned.

400

The query string is malformed.

Up
delete /users/{id}
Delete a user.
Delete the user specified by the id parameter.

Path parameters

id (required)
The ID of the user to delete.

Responses

204

Success. The specified user has been deleted.

400

One of the following errors has occurred:

403

The user is not authorized to delete a user.

404

The specified user was not found.

Up
get /users/{id}/filters
Gets the filters for a user.
Returns the ordered list of filter IDs for the specified user. Note that the filter sequence, in general, is not commutative, so the order will affect the result.

Path parameters

id (required)
The ID of the user.

Return type

array[UUID]

Example data

Content-Type: application/json
[ "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]

Responses

200

Success. The list of filters for the specified user is returned.

400

One of the following errors has occurred:


Up
put /users/{id}/filters
Update the filters for a user.
Updates the ordered list of filter IDs for the specified user. Note that the filter sequence, in general, is not commutative, so the order will affect the result.

Path parameters

id (required)
The ID of the user

Request body

body (required)
UUID The ordered list of the filters for the specified user.

Responses

200

Success. The location of the updated user is returned.

400

One of the following errors has occurred:

404

The user ID was not found.

Up
get /users/{id}
Gets a specified user.
Returns the user specified by the id parameter.

Path parameters

id (required)
The ID of the user to return.

Return type

UserResponse

Example data

Content-Type: application/json
{
  "data" : {
    "folder" : "aeiou",
    "created" : "2000-01-23T04:56:07.000+00:00",
    "domainaccount" : "aeiou",
    "timezone" : "aeiou",
    "lastUpdate" : "2000-01-23T04:56:07.000+00:00",
    "subfolder" : "aeiou",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "locale" : "de",
    "email" : "aeiou",
    "enabled" : true,
    "username" : "aeiou"
  }
}

Responses

200

Success. Details about the specified user are returned.

400

The id parameter is malformed.

404

The specified user was not found.

Up
get /users/{id}/groups
Gets a list of groups.
Returns the list of groups for the user specified by the id parameter.

Path parameters

id (required)
The ID of the user to return groups for.

Query parameters

offset (optional)
The number of entries to skip. Default is 0.
limit (optional)
The maximum number of entries to return. Default is 50.

Return type

array[UUID]

Example data

Content-Type: application/json
[ "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]

Responses

200

Success. A list of the groups for the specified user is returned.

400

One of the following errors has occurred:


Up
put /users/{id}/groups
Updates a user's list of groups.
Updates the unordered list of group IDs for the specified user.

Path parameters

id (required)
The ID of the user.

Request body

body (required)
UUID The unordered list of groups for the specified user.

Responses

200

Success. The location of the updated user is returned.

400

One of the following errors has occurred:

404

The specified user was not found.

Up
put /users/{id}
Update an existing user.
Update the user specified by the id parameter.

Path parameters

id (required)
The ID of the user object to update.

Request body

body (required)
UserUpdateRequest The user details to update.

Responses

200

Success. The user has been updated.

400

The ID of the request is malformed or the body is malformed.

403

The user is not authorized to perform an update request.

404

The specified user was not found.

Up
get /users/{id}/roles
Gets the roles for a user.
Returns the ordered list of role IDs for the specified user.

Path parameters

id (required)
The ID of the user.

Return type

array[UUID]

Example data

Content-Type: application/json
[ "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]

Responses

200

The list of roles for the specified user.

400

One of the following errors has occurred:

404

The specified ID was not found.

Up
put /users/{id}/roles
Updates the roles for a user.
Updates the list of role IDs for the specified user.

Path parameters

id (required)
The ID of the user.

Request body

body (required)
UUID The unordered list of roles for the specified user.

Responses

200

Success. The unordered user role list for the specified user is returned.

400

One of the following errors has occurred:

404

The specified user was not found.

Up
post /users
Adds a user.
Adds a new user, and returns its ID.

Request body

userRequest (required)
UserRequest The details about the user to add.

Responses

201

Success. User has been created.

400

The request syntax is malformed.

403

The user is not authorized to create a new user.

Models

[ Jump to Methods ]

Table of Contents

  1. App -
  2. AppListResponse -
  3. AppListResponse_data -
  4. AppResponse -
  5. Connection -
  6. ConnectionListResponse -
  7. ConnectionListResponse_data -
  8. ConnectionResponse -
  9. ErrorResponse -
  10. ErrorResponse_error -
  11. Filter -
  12. FilterField -
  13. FilterFieldValue -
  14. FilterListResponse -
  15. FilterListResponse_data -
  16. FilterRequest -
  17. FilterResponse -
  18. Group -
  19. GroupListResponse -
  20. GroupListResponse_data -
  21. GroupRequest -
  22. GroupResponse -
  23. GroupUpdateRequest -
  24. inline_response_200 -
  25. OnDemandRequest -
  26. OnDemandRequestStatus -
  27. OnDemandRequestStatusListResponse -
  28. OnDemandRequestStatusListResponse_data -
  29. OnDemandRequestStatusResponse -
  30. OnDemandRequest_config -
  31. OnDemandRequest_filters -
  32. OnDemandRequest_selections -
  33. patch -
  34. patch_1 -
  35. patch_2 -
  36. Report -
  37. ReportListResponse -
  38. ReportListResponse_data -
  39. Role -
  40. RoleListResponse -
  41. RoleListResponse_data -
  42. RoleResponse -
  43. Task -
  44. TaskExecution -
  45. TaskExecutionConfig -
  46. TaskExecutionsListResponse -
  47. TaskExecutionsListResponse_data -
  48. TasksListResponse -
  49. TasksListResponse_data -
  50. User -
  51. UserListResponse -
  52. UserListResponse_data -
  53. UserRequest -
  54. UserResponse -
  55. UserUpdateRequest -

App - Up

id (optional)
UUID The unique identifier of the app. format: uuid
created (optional)
Date The creation date in RFC 3339 format. format: date-time
name (optional)
String The name of the NPrinting app.
description (optional)
String The description of the app.

AppListResponse - Up

data (optional)

AppListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

AppResponse - Up

data (optional)

Connection - Up

id (optional)
UUID The unique identifier of the connection. format: uuid
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
name (optional)
String The name of the connection.
description (optional)
String The description of the connection.
connectionString (optional)
String The connection string of the connection.
cacheStatus (optional)
String The status of the cache generation task.
Enum:
NeverGenerated
Generating
Generated
Error
connectionStatus (optional)
String The status of the connection.
Enum:
Unknown
Ok
Warning
Error
appId (optional)
UUID The unique identifier of the app associated with this connection. format: uuid

ConnectionListResponse - Up

data (optional)

ConnectionListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

ConnectionResponse - Up

data (optional)

ErrorResponse - Up

error (optional)

ErrorResponse_error - Up

code (optional)
Integer format: int32
message (optional)

Filter - Up

id (optional)
UUID The unique identifier of the filter. format: uuid
appId (optional)
UUID The unique identifier that represents a specific app. format: uuid
enabled (optional)
Boolean Indicates whether the filter is enabled.
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
name (optional)
String The name of the filter.
description (optional)
String The description of the filter.
fields (optional)
array[FilterField] The fields of the filter. It can be empty.

FilterField - Up

connectionId (optional)
UUID The unique identifier that represents a specific connection. format: uuid
name (optional)
String The name of the filter field.
overrideValues (optional)
Boolean Indicates whether the values of this filter field should override the values of the filter fields (with same name and connectionId) previously applied in the filter chain, if any.
values (optional)
array[FilterFieldValue] The values of the filter field. If overrideValues flag is set to false the array must not be empty.

FilterFieldValue - Up

value (optional)
String A value of the filter field.
type (optional)
String The type of the filter field value.
Enum:
text
number
expression

FilterListResponse - Up

data (optional)

FilterListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

FilterRequest - Up

appId
UUID The unique identifier of the app. format: uuid
enabled
Boolean Indicates whether the filter is enabled.
name
String The name of the filter.
description (optional)
String The description of the filter.
fields

FilterResponse - Up

data (optional)

Group - Up

id (optional)
UUID The unique identifier of the group. format: uuid
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
name (optional)
String The name of the group.
description (optional)
String The description of the group.
enabled (optional)
Boolean Indicates whether the group is enabled (true) or disabled.

GroupListResponse - Up

data (optional)

GroupListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

GroupRequest - Up

name
description (optional)
enabled

GroupResponse - Up

data (optional)

GroupUpdateRequest - Up

name
description
enabled

inline_response_200 - Up

data (optional)

OnDemandRequest - Up

type (optional)
String The request type. The "task" type is currently not supported.
Enum:
report
task
config (optional)
filters (optional)
selections (optional)
array[OnDemandRequest_selections] The Sense selections (filters) to apply on reports with a Sense connection.
connectionId (optional)
UUID The ID of the Sense connection associated with the request. Needed only for selections. format: uuid

OnDemandRequestStatus - Up

id (optional)
UUID format: uuid
created (optional)
Date format: date-time
status (optional)
Enum:
queued
running
completed
failed
aborted
warning
title (optional)
requestType (optional)
String The request type. The "task" type is currently not supported.
Enum:
report
task
reportType (optional)
Enum:
Excel
Html
PowerPoint
QlikEntity
Word
PixelPerfect
outputFormat (optional)
Enum:
pdf
doc
ppt
xls
docx
pptx
xslx
docm
pptm
xslm
csv
skv
jpeg
png
tiff
bmp

OnDemandRequestStatusListResponse - Up

data (optional)

OnDemandRequestStatusListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

OnDemandRequestStatusResponse - Up

data (optional)

OnDemandRequest_config - Up

reportId
UUID format: uuid
outputFormat
Enum:
pdf
doc
ppt
xls
docx
pptx
xslx
docm
pptm
xslm
csv
skv
jpeg
png
tiff
bmp

OnDemandRequest_filters - Up

initialBookmark (optional)
additionalFilters (optional)
array[UUID] format: uuid

OnDemandRequest_selections - Up

fieldName (optional)
selectedCount (optional)
Integer The number of values that are selected. format: int32
selectedValues (optional)
array[String] An array of the selected values. Note that selections must be of type string or numeric; evaluated formulas are not supported.
isNumeric (optional)
Boolean Indicates whether the selected values are numeric (true) or string (false).

patch - Up

status (optional)

patch_1 - Up

status (optional)

patch_2 - Up

status (optional)

Report - Up

id (optional)
UUID The unique identifier of the report. format: uuid
created (optional)
Date The creation date in RFC 3339 format. format: date-time
title (optional)
String The name of the report.
description (optional)
String The description of the report.
type (optional)
String The type of the report.
Enum:
Excel
Html
PowerPoint
QlikEntity
Word
PixelPerfect
outputFormats (optional)
Enum:
entityId (optional)
String The Qlik entity ID. Specified only if the report type is "QlikEntity".

ReportListResponse - Up

data (optional)

ReportListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

Role - Up

id (optional)
UUID The unique identifier of the role. format: uuid
name (optional)
String The name of the role.
description (optional)
String The description of the role.
enabled (optional)
Boolean Indicates whether this role is enabled (true) or disabled.
hasAllActions (optional)
Boolean Indicates whether this role contains all possible actions.
hasAllApps (optional)
Boolean Indicates whether this role is related to all apps.
isSystemRole (optional)
Boolean Indicates whether this role is a system role.

RoleListResponse - Up

data (optional)

RoleListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

RoleResponse - Up

data (optional)

Task - Up

id (optional)
UUID The unique identifier of the task. format: uuid
name (optional)
String The name of the task.
description (optional)
String The description of the task.
type (optional)
String The type of the task.
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
lastExecution (optional)
Date The date of the last execution in RFC 3339 format based on the UTC time standard. format: date-time
enable (optional)
Boolean Indicates whether this task is enabled (true) or disabled.
appId (optional)
String The ID of the related app.

TaskExecution - Up

id (optional)
UUID The unique identifier of the task execution. format: uuid
type (optional)
String The type of the task.
Enum:
publish
task (optional)
UUID The unique identifier of the task in this task execution. format: uuid
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
completed (optional)
Date The completion date in RFC 3339 format based on the UTC time standard. format: date-time
progress (optional)
Float The completion progress (min. 0, max. 1). format: float
status (optional)
String The status of the task execution.
Enum:
WaitingForRetry
Enqueued
Assigned
Running
Completed
Aborting
Aborted
Failed
Timeout
Warning
Failing
CompletedWithWarning
result (optional)
String The result of the task execution.

TaskExecutionConfig - Up

priority (optional)
BigDecimal The task priority. The value provided must be in the [0, 1000] range. If it is not, the value is trimmed to 0 (if <0) or 1000 (if >1000). format: integer

TaskExecutionsListResponse - Up

data (optional)

TaskExecutionsListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

TasksListResponse - Up

data (optional)

TasksListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

User - Up

id (optional)
UUID The unique identifier of the user. format: uuid
email (optional)
String The email address of the user.
created (optional)
Date The creation date in RFC 3339 format based on the UTC time standard. format: date-time
lastUpdate (optional)
Date The date of the last update in RFC 3339 format based on the UTC time standard. format: date-time
enabled (optional)
Boolean Indicates whether the user is enabled (true) or disabled.
username (optional)
String The name of the user.
domainaccount (optional)
String The domain account of the user.
timezone (optional)
String The timezone of the user.
locale (optional)
String The locale of the user.
Enum:
de
en
es
fr
it
pt
zh
ja
folder (optional)
String The folder of the user.
subfolder (optional)
String The subfolder of the user.

UserListResponse - Up

data (optional)

UserListResponse_data - Up

totalItems (optional)
Integer format: int32
offset (optional)
Integer format: int32
limit (optional)
Integer format: int32
items (optional)

UserRequest - Up

email
password
String format: password
enabled
username
domainaccount (optional)
timezone
String Be sure to type the name as it appears in the Qlik NPrinting interface.
locale (optional)
Enum:
de
en
es
fr
it
pt
zh
ja
folder (optional)
subfolder (optional)

UserResponse - Up

data (optional)

UserUpdateRequest - Up

email
password
String format: password
enabled
username
domainaccount
timezone
String Be sure to type the name as it appears in the Qlik NPrinting interface.
locale
Enum:
de
en
es
fr
it
pt
zh
ja
folder
subfolder