Simple Scheduled Task

Simple scheduled tasks are used to define schedules for the execution of data flows.

The results of the executed schedules are stored in execution plan states which are contained in the scheduled task.

Note
To access the Simple Scheduled Tasks API the AutomationServices license feature must be enabled and the API user must have the maintainSchedule feature permission specified as part of their role.

For help with simple scheduled tasks see the related tutorials.

Create a simple scheduled task

A POST request creates a simple scheduled task.

Request Parameters

Parameter Description

container

The container locator of the requested scheduled tasks.

ltk

The authentication token.

Request Fields

Path Type Description

id

String

The identity of the scheduled task. It must be unique and will be allocated if not specified at creation.

name

String

The name of the scheduled task. This must be unique in the container.

description

String

The description of the scheduled task.

enabled

Boolean

true if schedule is enabled, defaults to true.

runPropertySet

Object

The Run Property Set for the Scheduled Task

runPropertySet.runProperties

Array

A list of run properties.

runPropertySet.runProperties[0].name

String

The name of the run property.

runPropertySet.runProperties[0].value

String

The value of the run property.

runPropertySet.runProperties[1].name

String

The name of the run property.

runPropertySet.runProperties[1].value

String

The value of the run property.

triggerProperties

Object

Trigger Properties e.g. 'cronExpression'.

triggerProperties.cronExpression

String

Quartz Cron Expression.

triggerProperties.startDateTime

String

The date and time when the schedule starts in ISO-8601 format.

triggerProperties.endDateTime

String

The date and time when the schedule ends in ISO-8601 format.

followUps

Array

List of follow up actions taken on completion of Data Flow execution.

followUps[0].enabled

Boolean

Specifies whether the follow up action is enabled or not.

followUps[0].condition

String

Condition on which to execute the follow up action. SUCCEEDED - execute if previous data flow succeeded, FAILED - execute if previous data flow failed.

followUps[0].action

Object

Action to take.

followUps[0].action.type

String

Type of action: executeDataFlowFollowUpAction - execute a data flow, sendEmailFollowUpAction - send an email to a specified list of recipients.

followUps[0].action.data

Object

Information specific to the action.

followUps[0].action.data.dataflowLocator

String

Locator of data flow to execute when executeDataFlowFollowUpAction is specified.

followUps[0].action.data.runPropertySet

Null

Optional Run Property Set to use with follow up data flow when executeDataFlowFollowUpAction is specified.

followUps[1].action.data.emailDistributionList

Array

List of email recipients when sendEmailFollowUpAction is specified.

Response Fields

Path Type Description

data.locator

String

Object resource locator. Used to identify the resource.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

Example request

In this example the follow-ups are configured to execute another data flow if the scheduled data flow succeeds and to send an email if either data flow fails to execute.

POST /api/v4/simple-scheduled-tasks?container=object:!tenant:defaultTenant~directory:workspace-id&ltk=AUTHENTICATION_TOKEN HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Content-Length: 1230
Host: localhost:8080

{"id":"simple-scheduled-task-v4-id","name":"Schedule Name","description":"Schedule Description","enabled":false,"triggerProperties":{"cronExpression":"0 00 00 1 1/1 ? *","startDateTime":"Start Date is ISO 8601 format","endDateTime":"Start Date is ISO 8601 format"},"dataflowId":"dataflowId","dataflowLocator":null,"runPropertySet":{"id":null,"name":null,"runProperties":[{"name":"runPropertyName1","value":"runPropertyValue1","source":null,"dataType":null,"editorData":null,"managementData":null},{"name":"runPropertyName2","value":"runPropertyValue2","source":null,"dataType":null,"editorData":null,"managementData":null}],"parentRunPropertySetLocators":null,"lastKnownParentNames":null,"description":null},"searchPath":["object:!tenant:defaultTenant~directory:workspace-id"],"runAsUserLocator":"object:!tenant:defaultTenant~user:runAsUser","followUps":[{"condition":"SUCCEEDED","action":{"type":"executeDataFlowFollowUpAction","data":{"runPropertySet":null,"dataflowLocator":"object:!tenant:defaultTenant~directory:workspace-id~graph:followUpGraphId"}},"enabled":true},{"condition":"FAILED","action":{"type":"sendEmailFollowUpAction","data":{"emailDistributionList":["user1@company.com","user2@company.com"]}},"enabled":false}]}

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 152

{
  "status" : "OK",
  "data" : {
    "locator" : "object:!tenant:defaultTenant~directory:workspace-id~scheduled-task:simple-scheduled-task-v4-id"
  }
}

Update a simple scheduled task

A PUT request updates a simple scheduled task.

Path Parameters

Table 1. /api/v4/simple-scheduled-tasks/{scheduledTaskLocator}
Parameter Description

scheduledTaskLocator

The locator for the scheduled task to update.

Request Parameters

Parameter Description

ltk

The authentication token.

Request Fields

Path Type Description

id

String

The identity of the scheduled task. It must be unique and will be allocated if not specified at creation.

name

String

The name of the scheduled task. This must be unique in the container.

description

String

The description of the scheduled task.

enabled

Boolean

true if schedule is enabled, defaults to true.

runPropertySet

Object

The Run Property Set for the Scheduled Task

runPropertySet.runProperties

Array

A list of run properties.

runPropertySet.runProperties[0].name

String

The name of the run property.

runPropertySet.runProperties[0].value

String

The value of the run property.

runPropertySet.runProperties[1].name

String

The name of the run property.

runPropertySet.runProperties[1].value

String

The value of the run property.

triggerProperties

Object

Trigger Properties e.g. 'cronExpression'.

triggerProperties.cronExpression

String

Quartz Cron Expression.

triggerProperties.startDateTime

String

The date and time when the schedule starts in ISO-8601 format.

triggerProperties.endDateTime

String

The date and time when the schedule ends in ISO-8601 format.

followUps

Array

List of follow up actions taken on completion of Data Flow execution.

followUps[0].enabled

Boolean

Specifies whether the follow up action is enabled or not.

followUps[0].condition

String

Condition on which to execute the follow up action. SUCCEEDED - execute if previous data flow succeeded, FAILED - execute if previous data flow failed.

followUps[0].action

Object

Action to take.

followUps[0].action.type

String

Type of action: executeDataFlowFollowUpAction - execute a data flow, sendEmailFollowUpAction - send an email to a specified list of recipients.

followUps[0].action.data

Object

Information specific to the action.

followUps[0].action.data.dataflowLocator

String

Locator of data flow to execute when executeDataFlowFollowUpAction is specified.

followUps[0].action.data.runPropertySet

Null

Optional Run Property Set to use with follow up data flow when executeDataFlowFollowUpAction is specified.

followUps[1].action.data.emailDistributionList

Array

List of email recipients when sendEmailFollowUpAction is specified.

Response Fields

None

Example request

PUT /api/v4/simple-scheduled-tasks/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Content-Length: 1230
Host: localhost:8080

{"id":"simple-scheduled-task-v4-id","name":"Schedule Name","description":"Schedule Description","enabled":false,"triggerProperties":{"cronExpression":"0 00 00 1 1/1 ? *","startDateTime":"Start Date is ISO 8601 format","endDateTime":"Start Date is ISO 8601 format"},"dataflowId":"dataflowId","dataflowLocator":null,"runPropertySet":{"id":null,"name":null,"runProperties":[{"name":"runPropertyName1","value":"runPropertyValue1","source":null,"dataType":null,"editorData":null,"managementData":null},{"name":"runPropertyName2","value":"runPropertyValue2","source":null,"dataType":null,"editorData":null,"managementData":null}],"parentRunPropertySetLocators":null,"lastKnownParentNames":null,"description":null},"searchPath":["object:!tenant:defaultTenant~directory:workspace-id"],"runAsUserLocator":"object:!tenant:defaultTenant~user:runAsUser","followUps":[{"condition":"SUCCEEDED","action":{"type":"executeDataFlowFollowUpAction","data":{"runPropertySet":null,"dataflowLocator":"object:!tenant:defaultTenant~directory:workspace-id~graph:followUpGraphId"}},"enabled":true},{"condition":"FAILED","action":{"type":"sendEmailFollowUpAction","data":{"emailDistributionList":["user1@company.com","user2@company.com"]}},"enabled":false}]}

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 162

{
  "status" : "OK",
  "data" : {
    "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id"
  }
}

Get a specified scheduled task

A GET request returns the specified scheduled task.

Path Parameters

Table 2. /api/v4/simple-scheduled-tasks/{locator}
Parameter Description

locator

The object resource locator of the requested scheduled task.

Request Parameters

Parameter Description

ltk

The authentication token.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

Response Fields

Path Type Description

data.locator

String

The object resource locator of the requested scheduled task.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.object.id

String

The identity of the scheduled task. It must be unique and will be allocated if not specified at creation.

data.object.name

String

The name of the scheduled task. This must be unique in the container.

data.object.description

String

The description of the scheduled task.

data.object.enabled

Boolean

true if schedule is enabled, defaults to true.

data.object.runPropertySet

Object

The Run Property Set for the Scheduled Task

data.object.runPropertySet.runProperties

Array

A list of run properties.

data.object.runPropertySet.runProperties[0].name

String

The name of the run property.

data.object.runPropertySet.runProperties[0].value

String

The value of the run property.

data.object.runPropertySet.runProperties[1].name

String

The name of the run property.

data.object.runPropertySet.runProperties[1].value

String

The value of the run property.

data.object.triggerProperties

Object

Trigger Properties e.g. 'cronExpression'.

data.object.triggerProperties.cronExpression

String

Quartz Cron Expression.

data.object.triggerProperties.startDateTime

String

The date and time when the schedule starts in ISO-8601 format.

data.object.triggerProperties.endDateTime

String

The date and time when the schedule ends in ISO-8601 format.

data.object.followUps

Array

List of follow up actions taken on completion of Data Flow execution.

data.object.followUps[0].enabled

Boolean

Specifies whether the follow up action is enabled or not.

data.object.followUps[0].condition

String

Condition on which to execute the follow up action. SUCCEEDED - execute if previous data flow succeeded, FAILED - execute if previous data flow failed.

data.object.followUps[0].action

Object

Action to take.

data.object.followUps[0].action.type

String

Type of action: executeDataFlowFollowUpAction - execute a data flow, sendEmailFollowUpAction - send an email to a specified list of recipients.

data.object.followUps[0].action.data

Object

Information specific to the action.

data.object.followUps[0].action.data.dataflowLocator

String

Locator of data flow to execute when executeDataFlowFollowUpAction is specified.

data.object.followUps[0].action.data.runPropertySet

Null

Optional Run Property Set to use with follow up data flow when executeDataFlowFollowUpAction is specified.

data.object.followUps[1].action.data.emailDistributionList

Array

List of email recipients when sendEmailFollowUpAction is specified.

data.metadata

Object

Metadata for the resource.

data.metadata.locator

String

The resource locator that uniquely identifies the resource.

data.metadata.createdBy

String

The userid of the user that created the resource.

data.metadata.createdByName

String

The username of the user that created the resource.

data.metadata.createdOn

String

Creation time of resource in ISO-8601 format.

data.metadata.modifiedBy

String

The userid of the user that last modified the resource.

data.metadata.modifiedByName

String

The username of the user that last modified the resource.

data.metadata.modifiedOn

String

Last modification time of resource in ISO-8601 format.

data.metadata.containerLocator

String

The resource locator that uniquely identifies the container resource.

data.metadata.resourceId.objectType

String

The resource type.

data.metadata.resourceId.objectId

String

The resource id.

data.metadata.resourceId.universal

Boolean

True if the resource id is universally addressable.

Example request

GET /api/v4/simple-scheduled-tasks/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN&fields=object,metadata HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 3002

{
  "status" : "OK",
  "data" : {
    "metadata" : {
      "createdByName" : "Created By User Name",
      "modifiedByName" : "Modified By User Name",
      "browsingMetadata" : {
        "name" : "Scheduled Task",
        "description" : "Scheduled Task"
      },
      "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:scheduled-task-id-001",
      "containerLocator" : "object:!tenant:defaultTenant~directory:workspace-id",
      "createdBy" : "created-by-user-Id",
      "createdOn" : "2022-11-25T16:49:03+0000",
      "modifiedBy" : "modified-by-user-Id",
      "modifiedOn" : "2022-11-25T16:49:03+0000",
      "resourceId" : {
        "objectType" : "simple-scheduled-task-v4",
        "objectId" : "scheduled-task-id-001",
        "universal" : false
      },
      "universalLocator" : null,
      "universalContainerLocator" : null
    },
    "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:scheduled-task-id-001",
    "object" : {
      "id" : "scheduled-task-id-001",
      "name" : "Scheduled Task",
      "description" : "Schedule Description",
      "enabled" : false,
      "triggerProperties" : {
        "cronExpression" : "0 00 00 1 1/1 ? *",
        "startDateTime" : "Start Date is ISO 8601 format",
        "endDateTime" : "Start Date is ISO 8601 format"
      },
      "dataflowId" : "dataflowId",
      "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-id~graph:dataflowId",
      "runPropertySet" : {
        "id" : null,
        "name" : "Scheduled Task",
        "description" : null,
        "runProperties" : [ {
          "name" : "runPropertyName1",
          "value" : "runPropertyValue1",
          "source" : null,
          "dataType" : null,
          "encryptionType" : "NO_ENCRYPTION",
          "editorData" : null,
          "managementData" : null
        }, {
          "name" : "runPropertyName2",
          "value" : "runPropertyValue2",
          "source" : null,
          "dataType" : null,
          "encryptionType" : "NO_ENCRYPTION",
          "editorData" : null,
          "managementData" : null
        } ],
        "lastKnownParentNames" : null,
        "parentRunPropertySetLocators" : [ ]
      },
      "searchPath" : [ "object:!tenant:defaultTenant~directory:workspace-id" ],
      "runAsUserLocator" : null,
      "followUps" : [ {
        "condition" : "SUCCEEDED",
        "action" : {
          "type" : "executeDataFlowFollowUpAction",
          "data" : {
            "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-idgraph%3AfollowUpDataFlowId",
            "runPropertySet" : null
          }
        },
        "enabled" : true
      }, {
        "condition" : "FAILED",
        "action" : {
          "type" : "sendEmailFollowUpAction",
          "data" : {
            "emailDistributionList" : [ "user1@company.com", "user2@company.com" ]
          }
        },
        "enabled" : true
      } ]
    }
  }
}

Get a list of scheduled tasks

A GET request returns a list of scheduled tasks.

Path Parameters

None

Request Parameters

Parameter Description

container

The container locator of the requested scheduled tasks.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

filter

An optional FIQL filter expression. Supports searching by the 'name' attribute. For example filter=name=='Object Name'

ltk

The authentication token.

Response Fields

Path Type Description

data.objects[].locator

String

The object resource locator of the requested scheduled task.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the scheduled task. It must be unique and will be allocated if not specified at creation.

data.objects[].object.name

String

The name of the scheduled task. This must be unique in the container.

data.objects[].object.description

String

The description of the scheduled task.

data.objects[].object.enabled

Boolean

true if schedule is enabled, defaults to true.

data.objects[].object.runPropertySet

Object

The Run Property Set for the Scheduled Task

data.objects[].object.runPropertySet.runProperties

Array

A list of run properties.

data.objects[].object.runPropertySet.runProperties[0].name

String

The name of the run property.

data.objects[].object.runPropertySet.runProperties[0].value

String

The value of the run property.

data.objects[].object.runPropertySet.runProperties[1].name

String

The name of the run property.

data.objects[].object.runPropertySet.runProperties[1].value

String

The value of the run property.

data.objects[].object.triggerProperties

Object

Trigger Properties e.g. 'cronExpression'.

data.objects[].object.triggerProperties.cronExpression

String

Quartz Cron Expression.

data.objects[].object.triggerProperties.startDateTime

String

The date and time when the schedule starts in ISO-8601 format.

data.objects[].object.triggerProperties.endDateTime

String

The date and time when the schedule ends in ISO-8601 format.

data.objects[].object.followUps

Array

List of follow up actions taken on completion of Data Flow execution.

data.objects[].object.followUps[0].enabled

Boolean

Specifies whether the follow up action is enabled or not.

data.objects[].object.followUps[0].condition

String

Condition on which to execute the follow up action. SUCCEEDED - execute if previous data flow succeeded, FAILED - execute if previous data flow failed.

data.objects[].object.followUps[0].action

Object

Action to take.

data.objects[].object.followUps[0].action.type

String

Type of action: executeDataFlowFollowUpAction - execute a data flow, sendEmailFollowUpAction - send an email to a specified list of recipients.

data.objects[].object.followUps[0].action.data

Object

Information specific to the action.

data.objects[].object.followUps[0].action.data.dataflowLocator

String

Locator of data flow to execute when executeDataFlowFollowUpAction is specified.

data.objects[].object.followUps[0].action.data.runPropertySet

Null

Optional Run Property Set to use with follow up data flow when executeDataFlowFollowUpAction is specified.

data.objects[].object.followUps[1].action.data.emailDistributionList

Array

List of email recipients when sendEmailFollowUpAction is specified.

Example request

GET /api/v4/simple-scheduled-tasks?container=object:!tenant:defaultTenant~directory:workspace-id&fields=object&filter=name%3D%3D'Schedule%20Name'&ltk=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 4560

{
  "status" : "OK",
  "data" : {
    "objects" : [ {
      "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:scheduled-task-id-001",
      "object" : {
        "id" : "scheduled-task-id-001",
        "name" : "First Scheduled Task",
        "description" : "Schedule Description",
        "enabled" : false,
        "triggerProperties" : {
          "cronExpression" : "0 00 00 1 1/1 ? *",
          "startDateTime" : "Start Date is ISO 8601 format",
          "endDateTime" : "Start Date is ISO 8601 format"
        },
        "dataflowId" : "dataflowId",
        "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-id~graph:dataflowId",
        "runPropertySet" : {
          "id" : null,
          "name" : "First Scheduled Task",
          "description" : null,
          "runProperties" : [ {
            "name" : "runPropertyName1",
            "value" : "runPropertyValue1",
            "source" : null,
            "dataType" : null,
            "encryptionType" : "NO_ENCRYPTION",
            "editorData" : null,
            "managementData" : null
          }, {
            "name" : "runPropertyName2",
            "value" : "runPropertyValue2",
            "source" : null,
            "dataType" : null,
            "encryptionType" : "NO_ENCRYPTION",
            "editorData" : null,
            "managementData" : null
          } ],
          "lastKnownParentNames" : null,
          "parentRunPropertySetLocators" : [ ]
        },
        "searchPath" : [ "object:!tenant:defaultTenant~directory:workspace-id" ],
        "runAsUserLocator" : null,
        "followUps" : [ {
          "condition" : "SUCCEEDED",
          "action" : {
            "type" : "executeDataFlowFollowUpAction",
            "data" : {
              "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-idgraph%3AfollowUpDataFlowId",
              "runPropertySet" : null
            }
          },
          "enabled" : true
        }, {
          "condition" : "FAILED",
          "action" : {
            "type" : "sendEmailFollowUpAction",
            "data" : {
              "emailDistributionList" : [ "user1@company.com", "user2@company.com" ]
            }
          },
          "enabled" : true
        } ]
      }
    }, {
      "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:scheduled-task-id-002",
      "object" : {
        "id" : "scheduled-task-id-002",
        "name" : "Second Scheduled Task",
        "description" : "Schedule Description",
        "enabled" : false,
        "triggerProperties" : {
          "cronExpression" : "0 00 00 1 1/1 ? *",
          "startDateTime" : "Start Date is ISO 8601 format",
          "endDateTime" : "Start Date is ISO 8601 format"
        },
        "dataflowId" : "dataflowId",
        "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-id~graph:dataflowId",
        "runPropertySet" : {
          "id" : null,
          "name" : "Second Scheduled Task",
          "description" : null,
          "runProperties" : [ {
            "name" : "runPropertyName1",
            "value" : "runPropertyValue1",
            "source" : null,
            "dataType" : null,
            "encryptionType" : "NO_ENCRYPTION",
            "editorData" : null,
            "managementData" : null
          }, {
            "name" : "runPropertyName2",
            "value" : "runPropertyValue2",
            "source" : null,
            "dataType" : null,
            "encryptionType" : "NO_ENCRYPTION",
            "editorData" : null,
            "managementData" : null
          } ],
          "lastKnownParentNames" : null,
          "parentRunPropertySetLocators" : [ ]
        },
        "searchPath" : [ "object:!tenant:defaultTenant~directory:workspace-id" ],
        "runAsUserLocator" : null,
        "followUps" : [ {
          "condition" : "SUCCEEDED",
          "action" : {
            "type" : "executeDataFlowFollowUpAction",
            "data" : {
              "dataflowLocator" : "object:!tenant:defaultTenant~directory:workspace-idgraph%3AfollowUpDataFlowId",
              "runPropertySet" : null
            }
          },
          "enabled" : true
        }, {
          "condition" : "FAILED",
          "action" : {
            "type" : "sendEmailFollowUpAction",
            "data" : {
              "emailDistributionList" : [ "user1@company.com", "user2@company.com" ]
            }
          },
          "enabled" : true
        } ]
      }
    } ]
  }
}

Delete a simple scheduled task

A DELETE request deletes a simple scheduled task.

Path Parameters

Table 3. /api/v4/simple-scheduled-tasks/{scheduledTaskLocator}
Parameter Description

scheduledTaskLocator

The locator of the scheduled task to delete.

Request Parameters

Parameter Description

ltk

The authentication token.

Request Fields

None

Response Fields

None

Example request

DELETE /api/v4/simple-scheduled-tasks/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 162

{
  "status" : "OK",
  "data" : {
    "locator" : "object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id"
  }
}

Ad-hoc run of a simple scheduled task

A POST request executes an ad-hoc run of a simple scheduled task.

Run property values can be overridden for this run only if required.

A failed execution plan state can be run again by specifying the execution plan state locator.

Path Parameters

Table 4. /api/v4/simple-scheduled-tasks/run-now/{scheduledTaskLocator}
Parameter Description

scheduledTaskLocator

The locator of the scheduled task to run.

Request Parameters

Parameter Description

ltk

The authentication token.

Request Fields

Path Type Description

executionPlanStateLocator

String

The locator for the execution plan state locator when re-running a failed execution plan state.

overriddenRunPropertySet

Object

The Run Property Set for the Scheduled Task

overriddenRunPropertySet.runProperties

Array

A list of run properties.

overriddenRunPropertySet.runProperties[0].name

String

The name of the run property.

overriddenRunPropertySet.runProperties[0].value

String

The value of the run property.

overriddenRunPropertySet.runProperties[1].name

String

The name of the run property.

overriddenRunPropertySet.runProperties[1].value

String

The value of the run property.

concurrentExecutionStrategy

String

The concurrent execution strategy. SKIP means that the run will be skipped if a run is already in progress for this schedule, RUN_CONCURRENTLY means that multiple runs can take place at the same time. The default value is SKIP.

Response Fields

Path Type Description

data.locator

String

Object resource locator of execution plan state for run. Use with the Execution Plan States API to identify the state of the run.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

Example request

POST /api/v4/simple-scheduled-tasks/run-now/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

ltk=AUTHENTICATION_TOKEN

Example response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197

{
  "status" : "OK",
  "data" : {
    "locator" : "object:!tenant:defaultTenant~directory:workspace-id~scheduled-task:simple-scheduled-task-v4-id~execution-plan-state:execution-plan-state-id"
  }
}

Example request to re-run failed task

POST /api/v4/simple-scheduled-tasks/run-now/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Content-Length: 338
Host: localhost:8080

{"executionPlanStateLocator":"object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-idexecution-plan-state:execution-plan-state-id","overriddenRunPropertySet":null,"overriddenSuccessDataflowRunPropertySet":null,"overriddenFailDataflowRunPropertySet":null,"concurrentExecutionStrategy":null}

Example request to run with overridden run property values

POST /api/v4/simple-scheduled-tasks/run-now/object:!tenant:defaultTenant~directory:workspace-id~simple-scheduled-task-v4:simple-scheduled-task-v4-id?ltk=AUTHENTICATION_TOKEN HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Content-Length: 584
Host: localhost:8080

{"executionPlanStateLocator":null,"overriddenRunPropertySet":{"id":null,"name":null,"runProperties":[{"name":"runPropertyName1","value":"overriddenrunPropertyValue1","source":null,"dataType":null,"editorData":null,"managementData":null},{"name":"runPropertyName2","value":"overriddenrunPropertyValue2","source":null,"dataType":null,"editorData":null,"managementData":null}],"parentRunPropertySetLocators":null,"lastKnownParentNames":null,"description":null},"overriddenSuccessDataflowRunPropertySet":null,"overriddenFailDataflowRunPropertySet":null,"concurrentExecutionStrategy":null}

Errors

See errors for details of the error response.

Error Code Description Arguments

lae.scheduler.invalidCronExpression

The specified cronExpression does not conform to the Quartz Cron Expression format.

  • Specified cronExpression

lae.scheduler.missingCronExpression

The cronExpression attribute is not specified.

lae.scheduler.scheduledTaskNameNotUnique

The specified name attribute is not unique.

  • The specified name

lae.scheduler.scheduledTaskNameNotSpecified

The name attribute is not specified.

lae.scheduler.scheduledTaskIdNotSpecified

The id attribute is not specified. id is mandatory for update.

lae.scheduler.executionPlanStateRunning

The scheduled task could not be deleted as it is currently running.

  • Object Resource Locator of the running executon plan state.