Backlogged Triggers Search

get

https://{serverUrl}/app/components/task/app/api/v2/triggers/backlog

Returns information about backlogged triggers.

Backlogged triggers are due to be processed, meaning trigger status is New or Unpaused, and the scheduled time is earlier than the current time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

source

string

Optional name of the source the triggers belong to.

sourceId

string

Optional sourceId - only used if source is also provided.

group

string

Optional source group - only used if source is also provided.

tree

string

Optional name of the tree - only used if source is also provided.

action

string

enum

Optional Action describing the type of trigger.

Allowed:

branchId

int32

Optional Id of the branch.

runId

int32

Optional Id of the run.

selectionCriterion

string

Optional selection criterion that matches the selection criterion of a handler.

token

string

Optional unique value of the deferred task to resume.

treeId

int32

Optional Id of the tree.

treeType

string

enum

Optional triggers that belong to the specified type of tree / routine.

Allowed:

timeline

string

enum

date/time field to use for sorting

Allowed:

direction

string

enum

Defaults to DESC

direction of sorting

Allowed:

start

date-time

ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') formatted date/time where the timeline field is later than this value.

end

date-time

ISO8601 (yyyy-MM-dd'T'HH:mm:ss'Z') formatted date/time where the timeline field is earlier than this value.

limit

int32

Defaults to 100

Number of results to limit the search to.

offset

int32

Defaults to 0

Offset beginning for paginated results.

include

array of strings

comma-separated list of additional properties to include in the response

include

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

200OK