Skip to main content

Get pending Execution Instance tasks

GET 

/execution-instance/:instanceSid/get-tasks

Get pending Execution Instance tasks

Request

Path Parameters

    instanceSid stringrequired
    Example: 00c974cd-8696-45db-9631-6cb5393f67c9

Header Parameters

    Strategy-Secret stringrequired

    The secret for the requested Strategy

Responses

Result

Schema

  • Array [

  • createdAt date-time

    Entity creation date

    updatedAt date-time

    Entity update date

    sid stringrequired

    Execution Event SID

    instanceSid stringrequired

    Execution Instance SID

    strategySid stringrequired

    Execution Strategy SID

    status stringrequired

    Possible values: [ONHOLD, PENDING, QUEUED, EXECUTING, PROCESSED, FAILED, CANCELED, PAUSED]

    Event status

    main booleanrequired

    Is event main

    afterCancellation boolean

    May event execute after instance cancellation

    task stringrequired

    Event task

    date date-timerequired

    Event execution date

    data

    object

    Optional body data

    property name*

    object

    oneOf

    string

    scheduledAt date-time

    Event scheduled at

    scheduleDelta number

    Difference to execution date

    executedAt date-time

    Event executed at

    executionDelta number

    Difference to execution date

    createdCycle number

    Cycle in which it was created

    finishedAt date-time

    Event finished at

    finishDelta number

    Difference to execution date

    executionTime number

    Event execution time

    attempt number

    Event attempt

    jobId string

    Event redis job ID

    correlationId string

    Correlation Id

    taskStatus

    object

    lastStep stringrequired

    Key of last step executed

    taskResults

    object[]

    List of step results

  • Array [

  • step stringrequired

    Step key

    success booleanrequired

    Step status

    fromCache boolean

    Step status from cache

    message string

    Error message

    stack string

    Error stack

    httpData

    object

    Request Http data

    request objectrequired
    response objectrequired
    data object

    Result body

    afterResumeData object

    First result body if resume is executed

    overrides object

    Result overrides

    correlationId string

    Correlation Id

  • ]

  • cachedTaskStatus

    object

    lastStep stringrequired

    Key of last step executed

    taskResults

    object[]

    List of step results

  • Array [

  • step stringrequired

    Step key

    success booleanrequired

    Step status

    fromCache boolean

    Step status from cache

    message string

    Error message

    stack string

    Error stack

    httpData

    object

    Request Http data

    request objectrequired
    response objectrequired
    data object

    Result body

    afterResumeData object

    First result body if resume is executed

    overrides object

    Result overrides

    correlationId string

    Correlation Id

  • ]

  • errorMessage string

    Event error message

    cancelReason string

    Possible values: [INSTANCE_CANCEL_TASK_REQUESTED, CANCEL_INSTANCE, SKIP_CYCLE, RESUME_MAIN_EVENT]

    Cancel reason

    serverLockOwner string

    Server lock owner identifier

    lockOwner string

    Runner lock owner identifier

    execStrategyVersion number

    Execution strategy version

    resumeStrategyVersion number

    Resume strategy version

    instance

    object

    createdAt date-time

    Entity creation date

    updatedAt date-time

    Entity update date

    sid stringrequired

    Execution Instance ID

    description string

    Execution Strategy description

    strategyId stringrequired

    Execution Strategy name or sid

    status stringrequired

    Possible values: [ACTIVE, CANCELED, PAUSED]

    Instance status

    cycle numberrequired

    Execution cycle

    startDate date-timerequired

    Execution start date

    endDate date-time

    Execution end date

    executionDate date-timerequired

    Next execution date

    executionDay numberrequired

    Saves the execution day in the month

    attributes

    object

    Optional instance data

    property name*

    object

    oneOf

    string

    nextEvent

    object

    sid stringrequired
    date date-timerequired
    cancelReason string

    Possible values: [HTTP_REQUEST, CONTROLLER_HELPER, MAX_ATTEMPTS, CREATE_CYCLE_ERROR]

    Cancel reason

    strategy

    object

    createdAt date-time

    Entity creation date

    updatedAt date-time

    Entity update date

    sid stringrequired

    Execution Strategy ID

    name stringrequired

    Execution Strategy name

    description string

    Execution Strategy description

    secret stringrequired

    Execution Strategy secret

    version number

    Default value: 1

    Execution Strategy version

    settings

    object

    required

    config

    object

    Strategy configuration

    requestDelayTime number

    Possible values: <= 5000

    Time in ms to delay each service call

    manualTrigger boolean

    Events won't be automatically queued if true

    timezone string

    Timezone to use

    instanceValidation object

    Instance attributes JTD validation

    schedule

    object

    required

    Schedule configurations

    initialDelay

    object

    Initial scheduling delay

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    calendars

    object[]

    required

    List of calendars

  • Array [

  • key stringrequired

    Calendar key

    description string

    Calendar description

    runOnCycle number

    Possible values: >= 1

    Cycle number on which to run calendar

    runOnCycleCallback string

    Cycle number callback to validate if calendar should run

    nextCycleDateCallback string

    Calculate the next cycle date

    scheduleAfter

    object

    required

    Schedule after time

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    task string

    Key of task to run

    leadingUpTasks

    object[]

    Tasks to run leading up to main task

  • Array [

  • task string

    Key of task to run

    scheduleBefore

    object

    Schedule before time

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

  • ]

  • ]

  • onCreateTasks

    object[]

    Tasks to execute on instance creation

  • Array [

  • delayBy

    object

    Delay after event

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    manualTrigger boolean

    Events won't be automatically queued if true

    createIf string

    Callback to validate if event should be created

    task stringrequired

    Name of task to execute

  • ]

  • onCancelTasks

    object[]

    Tasks to execute on instance cancelation

  • Array [

  • delayBy

    object

    Delay after event

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    manualTrigger boolean

    Events won't be automatically queued if true

    createIf string

    Callback to validate if event should be created

    task stringrequired

    Name of task to execute

  • ]

  • services

    object[]

    required

    List of services

  • Array [

  • key stringrequired

    Service key

    description string

    Service description

    baseUrls

    object[]

    required

    List of base URLs, per environment

  • Array [

  • environment stringrequired

    Environment name

    url stringrequired

    URL for environment

  • ]

  • authorization

    object[]

    List of authoriozation configurations, per environment

  • Array [

  • headers

    object

    Optional set of headers

    property name*

    object

    oneOf

    string

    params

    object

    Optional set of params

    property name*

    object

    oneOf

    string

    data

    object

    Optional body data

    property name*

    object

    oneOf

    string

    attributes

    object

    Optional set of attributes

    property name*

    object

    oneOf

    string

    environment stringrequired

    Environment name

    url stringrequired

    Authorization URL

    method stringrequired

    Possible values: [get, delete, post, put, patch]

    API method

    noCache boolean

    Cache the authorization token for all service methods

  • ]

  • credentialPath string

    Path to credential

    credentialType string

    Credential type

    methods

    object[]

    required

    List of methods

  • Array [

  • key stringrequired

    Method key

    description string

    Method description

    url stringrequired

    Method resource URL

    method stringrequired

    Possible values: [get, delete, post, put, patch]

    API method

    async boolean

    Method is asynchronous

    requestValidation string

    Request validation schema

    responseValidation object

    Response validation schema

  • ]

  • ]

  • tasks

    object[]

    required

    List of tasks

  • Array [

  • key stringrequired

    Task key

    description string

    Task description

    retryConfig

    object

    Task retry configuration

    times numberrequired

    Number of times to retry

    retryAfter

    object

    Task retry configuration

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    pauseBeforeCancel boolean

    When the maximum number of attempts has been reached, pause instead of canceling.

    retryStrategy

    object[]

  • Array [

  • unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    amount numberrequired
  • ]

  • steps

    object[]

    required

    List of steps

  • Array [

  • key stringrequired

    Step key

    description string

    Step description

    retryConfig

    object

    Task retry configuration

    times numberrequired

    Number of times to retry

    retryAfter

    object

    Task retry configuration

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    pauseBeforeCancel boolean

    When the maximum number of attempts has been reached, pause instead of canceling.

    retryStrategy

    object[]

  • Array [

  • unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    amount numberrequired
  • ]

  • resetAttempts boolean

    Reset attemps

    action string

    Action to execute with step

    final boolean

    Is step final

    controller string

    Controller to use with step

    controllerCallback string

    Controller callback to use with step

    resumeControllerCallback string

    Resume controller callback is executed when the event is resumed

    optional boolean

    Is step optional

    repeatOnRetry boolean

    Should step execute again on retry

    nextStep string

    Step key

    nextStepRules

    object[]

    Next step rules

  • Array [

  • if stringrequired

    Possible values: [onError, onBeforeRetry, onBeforePause, callback]

    Next step if event of type

    ifCallback string

    Next step callback validator

    description string

    Next step rule description

    nextStep string

    Next step key

  • ]

  • ]

  • initialStep stringrequired

    Task initial step

  • ]

  • actions

    object[]

    required

    List of actions

  • Array [

  • headers

    object

    Optional set of headers

    property name*

    object

    oneOf

    string

    params

    object

    Optional set of params

    property name*

    object

    oneOf

    string

    data

    object

    Optional body data

    property name*

    object

    oneOf

    string

    attributes

    object

    Optional set of attributes

    property name*

    object

    oneOf

    string

    key stringrequired

    Action key

    service stringrequired

    Key of service to use

    method stringrequired

    Key of service method to use

  • ]

  • encryptedSettings

    object

    iv stringrequired

    Encryption iv

    hash stringrequired

    Encryption hash

    encryptedText stringrequired

    Encrypted text

    strategy

    object

    createdAt date-time

    Entity creation date

    updatedAt date-time

    Entity update date

    sid stringrequired

    Execution Strategy ID

    name stringrequired

    Execution Strategy name

    description string

    Execution Strategy description

    secret stringrequired

    Execution Strategy secret

    version number

    Default value: 1

    Execution Strategy version

    settings

    object

    required

    config

    object

    Strategy configuration

    requestDelayTime number

    Possible values: <= 5000

    Time in ms to delay each service call

    manualTrigger boolean

    Events won't be automatically queued if true

    timezone string

    Timezone to use

    instanceValidation object

    Instance attributes JTD validation

    schedule

    object

    required

    Schedule configurations

    initialDelay

    object

    Initial scheduling delay

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    calendars

    object[]

    required

    List of calendars

  • Array [

  • key stringrequired

    Calendar key

    description string

    Calendar description

    runOnCycle number

    Possible values: >= 1

    Cycle number on which to run calendar

    runOnCycleCallback string

    Cycle number callback to validate if calendar should run

    nextCycleDateCallback string

    Calculate the next cycle date

    scheduleAfter

    object

    required

    Schedule after time

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    task string

    Key of task to run

    leadingUpTasks

    object[]

    Tasks to run leading up to main task

  • Array [

  • task string

    Key of task to run

    scheduleBefore

    object

    Schedule before time

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

  • ]

  • ]

  • onCreateTasks

    object[]

    Tasks to execute on instance creation

  • Array [

  • delayBy

    object

    Delay after event

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    manualTrigger boolean

    Events won't be automatically queued if true

    createIf string

    Callback to validate if event should be created

    task stringrequired

    Name of task to execute

  • ]

  • onCancelTasks

    object[]

    Tasks to execute on instance cancelation

  • Array [

  • delayBy

    object

    Delay after event

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    manualTrigger boolean

    Events won't be automatically queued if true

    createIf string

    Callback to validate if event should be created

    task stringrequired

    Name of task to execute

  • ]

  • services

    object[]

    required

    List of services

  • Array [

  • key stringrequired

    Service key

    description string

    Service description

    baseUrls

    object[]

    required

    List of base URLs, per environment

  • Array [

  • environment stringrequired

    Environment name

    url stringrequired

    URL for environment

  • ]

  • authorization

    object[]

    List of authoriozation configurations, per environment

  • Array [

  • headers

    object

    Optional set of headers

    property name*

    object

    oneOf

    string

    params

    object

    Optional set of params

    property name*

    object

    oneOf

    string

    data

    object

    Optional body data

    property name*

    object

    oneOf

    string

    attributes

    object

    Optional set of attributes

    property name*

    object

    oneOf

    string

    environment stringrequired

    Environment name

    url stringrequired

    Authorization URL

    method stringrequired

    Possible values: [get, delete, post, put, patch]

    API method

    noCache boolean

    Cache the authorization token for all service methods

  • ]

  • credentialPath string

    Path to credential

    credentialType string

    Credential type

    methods

    object[]

    required

    List of methods

  • Array [

  • key stringrequired

    Method key

    description string

    Method description

    url stringrequired

    Method resource URL

    method stringrequired

    Possible values: [get, delete, post, put, patch]

    API method

    async boolean

    Method is asynchronous

    requestValidation string

    Request validation schema

    responseValidation object

    Response validation schema

  • ]

  • ]

  • tasks

    object[]

    required

    List of tasks

  • Array [

  • key stringrequired

    Task key

    description string

    Task description

    retryConfig

    object

    Task retry configuration

    times numberrequired

    Number of times to retry

    retryAfter

    object

    Task retry configuration

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    pauseBeforeCancel boolean

    When the maximum number of attempts has been reached, pause instead of canceling.

    retryStrategy

    object[]

  • Array [

  • unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    amount numberrequired
  • ]

  • steps

    object[]

    required

    List of steps

  • Array [

  • key stringrequired

    Step key

    description string

    Step description

    retryConfig

    object

    Task retry configuration

    times numberrequired

    Number of times to retry

    retryAfter

    object

    Task retry configuration

    unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    Unit of time

    amount numberrequired

    Amount of unit

    from string

    Calculate from date in instance attributes

    resetTo

    object

    Reset time to especified values after delta

    month number

    Possible values: >= 1 and <= 12

    Reset month to value

    day number

    Possible values: >= 1 and <= 31

    Reset day to value

    hour number

    Possible values: <= 24

    Reset hour to value

    minute number

    Possible values: <= 59

    Reset minute to value

    retryEventCallback string

    Controller to get the custom period for each retry. If not mapped will use current unit/amount as default

    pauseBeforeCancel boolean

    When the maximum number of attempts has been reached, pause instead of canceling.

    retryStrategy

    object[]

  • Array [

  • unit stringrequired

    Possible values: [years, months, days, hours, minutes]

    amount numberrequired
  • ]

  • resetAttempts boolean

    Reset attemps

    action string

    Action to execute with step

    final boolean

    Is step final

    controller string

    Controller to use with step

    controllerCallback string

    Controller callback to use with step

    resumeControllerCallback string

    Resume controller callback is executed when the event is resumed

    optional boolean

    Is step optional

    repeatOnRetry boolean

    Should step execute again on retry

    nextStep string

    Step key

    nextStepRules

    object[]

    Next step rules

  • Array [

  • if stringrequired

    Possible values: [onError, onBeforeRetry, onBeforePause, callback]

    Next step if event of type

    ifCallback string

    Next step callback validator

    description string

    Next step rule description

    nextStep string

    Next step key

  • ]

  • ]

  • initialStep stringrequired

    Task initial step

  • ]

  • actions

    object[]

    required

    List of actions

  • Array [

  • headers

    object

    Optional set of headers

    property name*

    object

    oneOf

    string

    params

    object

    Optional set of params

    property name*

    object

    oneOf

    string

    data

    object

    Optional body data

    property name*

    object

    oneOf

    string

    attributes

    object

    Optional set of attributes

    property name*

    object

    oneOf

    string

    key stringrequired

    Action key

    service stringrequired

    Key of service to use

    method stringrequired

    Key of service method to use

  • ]

  • encryptedSettings

    object

    iv stringrequired

    Encryption iv

    hash stringrequired

    Encryption hash

    encryptedText stringrequired

    Encrypted text

  • ]

Loading...