API docs by Redocly

Mod Scheduler API (v1)

Mod Scheduler API

getSchedulerTimers

Retrieve timer list

query Parameters
offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "timerDescriptors": [
    ],
  • "totalRecords": 0
}

createSchedulerTimers

Create timer for a module

Request Body schema: application/json
id
string <uuid>

Timer identifier

type
string (Timer Type Schema)
Default: "user"
Enum: "user" "system"

Timer type

modified
boolean

Whether modified

required
object (RoutingEntry)

Okapi proxy routing entry

methods
Array of strings <= 1 items

List of methods GET, POST,.. * (for all)

pathPattern
string

Path pattern match. * matches any path. {x} matches one or more characters but not slash

path
string

Path prefix match

unit
string (Timer Delay Schema)
Enum: "millisecond" "second" "minute" "hour" "day"

Timer Delay unit

delay
string

Delay between calls; a value of zero disables timer

object

Timer schedule using cron-utils

enabled
required
boolean

Whether enabled

moduleName
string

Module name timer belongs to (module id should be used instead)

moduleId
string

Module id timer belongs to (if present module name is not needed)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "user",
  • "modified": true,
  • "routingEntry": {
    },
  • "enabled": true,
  • "moduleName": "string",
  • "moduleId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "user",
  • "modified": true,
  • "routingEntry": {
    },
  • "enabled": true,
  • "moduleName": "string",
  • "moduleId": "string"
}

getSchedulerTimerById

Retrieve scheduler timer by id

path Parameters
id
required
string <uuid>

Entity/document id

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "user",
  • "modified": true,
  • "routingEntry": {
    },
  • "enabled": true,
  • "moduleName": "string",
  • "moduleId": "string"
}

updateSchedulerTimerById

Update scheduler timer by id

path Parameters
id
required
string <uuid>

Entity/document id

Request Body schema: application/json
id
string <uuid>

Timer identifier

type
string (Timer Type Schema)
Default: "user"
Enum: "user" "system"

Timer type

modified
boolean

Whether modified

required
object (RoutingEntry)

Okapi proxy routing entry

methods
Array of strings <= 1 items

List of methods GET, POST,.. * (for all)

pathPattern
string

Path pattern match. * matches any path. {x} matches one or more characters but not slash

path
string

Path prefix match

unit
string (Timer Delay Schema)
Enum: "millisecond" "second" "minute" "hour" "day"

Timer Delay unit

delay
string

Delay between calls; a value of zero disables timer

object

Timer schedule using cron-utils

enabled
required
boolean

Whether enabled

moduleName
string

Module name timer belongs to (module id should be used instead)

moduleId
string

Module id timer belongs to (if present module name is not needed)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "user",
  • "modified": true,
  • "routingEntry": {
    },
  • "enabled": true,
  • "moduleName": "string",
  • "moduleId": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "user",
  • "modified": true,
  • "routingEntry": {
    },
  • "enabled": true,
  • "moduleName": "string",
  • "moduleId": "string"
}

deleteSchedulerTimerById

delete scheduler timer by id

path Parameters
id
required
string <uuid>

Entity/document id

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}