Reload tasks

reload-tasks are the resources of reload tasks

Endpoints

Skip to section
GET/v1/reload-tasks
POST/v1/reload-tasks
GET/v1/reload-tasks/{taskId}
PUT/v1/reload-tasks/{taskId}
DELETE/v1/reload-tasks/{taskId}

Find and return the tasks that the user can access.

manage

Header Parameters GET /v1/reload-tasks

Authorization
string

JWT containing tenant credentials.

Query Parameters GET /v1/reload-tasks

appId
optional
string

The case sensitive string used to search for a task by app ID.

limit
optional, default=10, minimum=1, maximum=100
integer<int32>

The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

next
optional
string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

partial
optional
boolean

The boolean value used to search for a task is partial or not

prev
optional
string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

Responses GET /v1/reload-tasks

200
optional, application/json

Expected response to a valid request.

400
optional, application/json

Bad Request.

401
optional, application/json

Unauthorized, JWT invalid or not provided.

403
optional, application/json

Forbidden, the requesting JWT does not allow for retrieval of this task.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

503
optional, application/json

Service Unavailable.

GET/v1/reload-tasks

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

Response GET /v1/reload-tasks

{
  "data": [
    {
      "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
      "partial": true,
      "timeZone": "string",
      "autoReload": true,
      "recurrence": [
        "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
        "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
      ],
      "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
      "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
      "autoReloadPartial": true,
      "id": "5be59decca62aa00097268a4",
      "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.",
      "links": {
        "self": {
          "href": "http://example.com"
        }
      },
      "state": "Enabled",
      "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
      "spaceId": "602c2c2be2be220002a22a22",
      "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
      "fortressId": "5c5b097116d25a0001a48b06",
      "lastExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC",
      "nextExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC"
    }
  ],
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    }
  }
}

Create a task for a specified app.

manage

Header Parameters POST /v1/reload-tasks

Authorization
string

JWT containing tenant credentials.

Request Body POST /v1/reload-tasks

optional, application/json

Request body specifying the task parameters.

Responses POST /v1/reload-tasks

201
optional, application/json

Expected response to a valid request.

400
optional, application/json

Bad Request.

401
optional, application/json

Unauthorized, JWT invalid or not provided.

403
optional, application/json

Forbidden, the requesting JWT does not allow for retrieval of this task.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

503
optional, application/json

Service Unavailable.

POST/v1/reload-tasks

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":true,"timeZone":"string","autoReload":true,"recurrence":["FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0","FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"],"endDateTime":"2018-11-09 14:46:07.697 +0000 UTC","startDateTime":"2018-11-09 14:46:07.697 +0000 UTC","autoReloadPartial":true,"type":"scheduled_reload"}'

Request POST /v1/reload-tasks

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "partial": true,
  "timeZone": "string",
  "autoReload": true,
  "recurrence": [
    "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
    "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
  ],
  "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "autoReloadPartial": true,
  "type": "scheduled_reload"
}

Response POST /v1/reload-tasks

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "string",
    "autoReload": true,
    "recurrence": [
      "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
      "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
    ],
    "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "autoReloadPartial": true,
    "id": "5be59decca62aa00097268a4",
    "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.",
    "links": {
      "self": {
        "href": "http://example.com"
      }
    },
    "state": "Enabled",
    "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
    "spaceId": "602c2c2be2be220002a22a22",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "nextExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC"
  }
}

Find and return a task.

manage

Header Parameters GET /v1/reload-tasks/{taskId}

Authorization
string

JWT containing tenant credentials.

Path Parameters GET /v1/reload-tasks/{taskId}

taskId
string

The unique identifier of the task.

Responses GET /v1/reload-tasks/{taskId}

200
optional, application/json

Expected response to a valid request.

400
optional, application/json

Bad Request.

401
optional, application/json

Unauthorized, JWT invalid or not provided.

403
optional, application/json

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

503
optional, application/json

Service Unavailable.

GET/v1/reload-tasks/{taskId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/reload-tasks/{taskId}

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "string",
    "autoReload": true,
    "recurrence": [
      "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
      "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
    ],
    "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "autoReloadPartial": true,
    "id": "5be59decca62aa00097268a4",
    "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.",
    "links": {
      "self": {
        "href": "http://example.com"
      }
    },
    "state": "Enabled",
    "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
    "spaceId": "602c2c2be2be220002a22a22",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "nextExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC"
  }
}

Update an existing task.

manage

Header Parameters PUT /v1/reload-tasks/{taskId}

Authorization
string

JWT containing tenant credentials.

Path Parameters PUT /v1/reload-tasks/{taskId}

taskId
string

The unique identifier of the task.

Request Body PUT /v1/reload-tasks/{taskId}

optional, application/json

Request body specifying the task parameters.

Responses PUT /v1/reload-tasks/{taskId}

200
optional, application/json

Expected response to a valid request.

400
optional, application/json

Bad Request.

401
optional, application/json

Unauthorized, JWT invalid or not provided.

403
optional, application/json

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

503
optional, application/json

Service Unavailable.

PUT/v1/reload-tasks/{taskId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":true,"timeZone":"string","autoReload":true,"recurrence":["FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0","FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"],"endDateTime":"2018-11-09 14:46:07.697 +0000 UTC","startDateTime":"2018-11-09 14:46:07.697 +0000 UTC","autoReloadPartial":true,"state":"Disabled"}'

Request PUT /v1/reload-tasks/{taskId}

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "partial": true,
  "timeZone": "string",
  "autoReload": true,
  "recurrence": [
    "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
    "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
  ],
  "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "autoReloadPartial": true,
  "state": "Disabled"
}

Response PUT /v1/reload-tasks/{taskId}

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "string",
    "autoReload": true,
    "recurrence": [
      "FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
      "FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
    ],
    "endDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "startDateTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "autoReloadPartial": true,
    "id": "5be59decca62aa00097268a4",
    "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.",
    "links": {
      "self": {
        "href": "http://example.com"
      }
    },
    "state": "Enabled",
    "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
    "spaceId": "602c2c2be2be220002a22a22",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "nextExecutionTime": "2018-11-09 14:46:07.697 +0000 UTC"
  }
}

Delete a task.

manage

Header Parameters DELETE /v1/reload-tasks/{taskId}

Authorization
string

JWT containing tenant credentials.

Path Parameters DELETE /v1/reload-tasks/{taskId}

taskId
string

The unique identifier of the task.

Responses DELETE /v1/reload-tasks/{taskId}

204
optional, application/json

Task deleted or not found.

400
optional, application/json

Bad Request.

401
optional, application/json

Unauthorized, JWT invalid or not provided.

403
optional, application/json

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

404
optional, application/json

Not Found.

500
optional, application/json

Internal server error.

DELETE/v1/reload-tasks/{taskId}

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

Response DELETE /v1/reload-tasks/{taskId}

{
  "errors": [
    {
      "code": "TASKS-123",
      "title": "short error message",
      "details": "detailed error message"
    }
  ],
  "traceId": "7975401f3954aa47"
}

Error

object

Properties

code
string

No description

title
string

No description

detail
optional
string

No description

Errors

object

Properties

errors
optional

No description

traceId
optional
string

No description

Href

object

Properties

href
string<uri>

No description

PostTaskBody

Properties

appId
optional
string

The ID of the app.

partial
optional, default=false
boolean

The task is partial reload or not

timeZone
optional
string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

autoReload
optional, default=false
boolean

A flag that indicates whether a reload is triggered when data of the app is changed

recurrence
optional
Array<string>

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

endDateTime
optional
string

The time that the task will stop recurring.

startDateTime
optional
string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartial
optional, default=false
boolean

A flag that indicates whether it is a partial reload or not for the auto reload

type
deprecated
optional
string

type of task being created - deprecated

PutTaskBody

Properties

appId
optional
string

The ID of the app.

partial
optional, default=false
boolean

The task is partial reload or not

timeZone
optional
string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

autoReload
optional, default=false
boolean

A flag that indicates whether a reload is triggered when data of the app is changed

recurrence
optional
Array<string>

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

endDateTime
optional
string

The time that the task will stop recurring.

startDateTime
optional
string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartial
optional, default=false
boolean

A flag that indicates whether it is a partial reload or not for the auto reload

state
optional
string

Toggle for enabling and disabling the reload task

Task

Properties

appId
optional
string

The ID of the app.

partial
optional, default=false
boolean

The task is partial reload or not

timeZone
optional
string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

autoReload
optional, default=false
boolean

A flag that indicates whether a reload is triggered when data of the app is changed

recurrence
optional
Array<string>

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

endDateTime
optional
string

The time that the task will stop recurring.

startDateTime
optional
string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartial
optional, default=false
boolean

A flag that indicates whether it is a partial reload or not for the auto reload

id
optional
string

The ID of the task.

log
optional
string

The reason why the task was disabled.

links

No description

state
optional
string

Toggle for enabling and disabling the reload task

userId
optional
string

The ID of the user who owns the task.

spaceId
optional
string

The space ID of the application

tenantId
optional
string

The ID of the tenant who owns the task.

fortressId
optional
string

The fortress ID of the application

lastExecutionTime
optional
string

The last time the task executed.

nextExecutionTime
optional
string

The next time the task will execute.

TaskBase

object

Properties

appId
optional
string

The ID of the app.

partial
optional, default=false
boolean

The task is partial reload or not

timeZone
optional
string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

autoReload
optional, default=false
boolean

A flag that indicates whether a reload is triggered when data of the app is changed

recurrence
optional
Array<string>

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

endDateTime
optional
string

The time that the task will stop recurring.

startDateTime
optional
string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartial
optional, default=false
boolean

A flag that indicates whether it is a partial reload or not for the auto reload

Tasks

object

Properties

data

No description

links

No description

v0.448.13
Was this page helpful?