Sign in

v1

latestOpenAPI 3.0.02026-08-0451027.5 KB
reload-tasks

Update an existing task

Updates an existing task

put/api/v1/reload-tasks/{taskId}

Path parameters

taskIdstring required

The unique identifier of the task.

Headers

Authorizationstring required

JWT containing tenant credentials.

Request body

appIdstring

The ID of the app.

partialboolean

The task is partial reload or not

timeZonestring

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.

autoReloadboolean

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

recurrencestring[]

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

endDateTimestring

The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.

startDateTimestring

The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartialboolean

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

state'Enabled' | 'Disabled' | 'Completed'

Toggle for enabling and disabling the reload task

Example request

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "timeZone": "America/Toronto",
  "recurrence": [
    "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0",
    "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"
  ],
  "endDateTime": "2022-10-12T23:59:00",
  "startDateTime": "2022-09-19T11:18:00",
  "state": "Disabled"
}

Response

Expected response to a valid request.

appIdstring required

The ID of the app.

partialboolean

The task is partial reload or not

timeZonestring required

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.

autoReloadboolean

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

recurrencestring[]

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

endDateTimestring

The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.

startDateTimestring

The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

autoReloadPartialboolean

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

idstring required

The ID of the task.

logstring

The reason why the task was disabled.

state'Enabled' | 'Disabled' | 'Completed' required

Toggle for enabling and disabling the reload task

userIdstring required

The ID of the user who owns the task.

spaceIdstring

The space ID of the application

migratedboolean

A flag indicating whether the task has been migrated to the new scheduling service.

tenantIdstring required

The ID of the tenant who owns the task.

fortressIdstring

The fortress ID of the application

disabledCode'MANUALLY' | 'CONSECUTIVE-FAILURES' | 'OWNER-DELETED' | 'OWNER-DISABLED'

The reason why the task was disabled.

lastExecutionTimestring

The last time the task executed.

nextExecutionTimestring

The next time the task will execute.

Example response

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "timeZone": "America/Toronto",
  "recurrence": [
    "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0",
    "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"
  ],
  "endDateTime": "2022-10-12T23:59:00",
  "startDateTime": "2022-09-19T11:18:00",
  "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",
  "disabledCode": "CONSECUTIVE-FAILURES",
  "lastExecutionTime": "2022-09-20T17:17:00Z",
  "nextExecutionTime": "2022-09-20T17:17:00Z"
}