Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Creating a Schedule
Updated on 2025-10-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Schedule

Function

This API is used to create a schedule.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/dispatches

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

instance_id

Yes

String

Instance ID.

task_id

Yes

String

Task ID, the unique identifier of a task.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

start_datetime

No

Integer

Start time of a scheduling plan. Range: 946684800000–2147512447000

period

No

String

Unit of the execution period of a schedule. If the Cron expression is used, the value is empty.

  • MIN (minute)

  • HOUR (hour)

  • DAY (day)

  • WEEK (week)

  • MON (month)

dispatch_interval

No

Integer

Interval for executing a schedule.

remark

No

String

Remarks of a schedule.

use_quartz_cron

No

Boolean

Whether the schedule uses the Cron expression.

  • true (using the Cron expression)

  • false (not using the Cron expression)

cron

No

String

Cron expression for a schedule.

cron_timezone

No

String

Time zone information.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

dispatch_id

String

Schedule ID.

task_id

String

ID of a task associated with a schedule.

start_datetime

Integer

Start time of a scheduling plan. Range: 946684800000–2147512447000

period

String

Unit of the execution period of a schedule. If the Cron expression is used, the value is empty.

  • MIN (minute)

  • HOUR (hour)

  • DAY (day)

  • WEEK (week)

  • MON (month)

dispatch_interval

Integer

Interval for executing a schedule.

created_date

Integer

Time when a schedule is created.

last_modified_date

Integer

Last modification time of a schedule.

remark

String

Remarks of a schedule.

use_quartz_cron

Boolean

Whether the schedule uses the Cron expression.

  • true (using the Cron expression)

  • false (not using the Cron expression)

cron

String

Cron expression for a schedule.

cron_timezone

String

Time zone information.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Create a schedule for a specified data integration task with an interval of once a day without using Cron expression.

{
  "use_quartz_cron" : false,
  "remark" : "123",
  "start_datetime" : "2020-11-14T07:38:25.609Z",
  "period" : "DAY",
  "dispatch_interval" : 1
}

Example Responses

Status code: 200

OK

{
  "dispatch_id" : "a0f7fa9897da423dadbe8391d7ea7a43",
  "task_id" : "15366328208d4d77b76532fe9f4006a6",
  "start_datetime" : 1605339505609,
  "period" : "DAY",
  "dispatch_interval" : 1,
  "created_date" : 1605311230685,
  "last_modified_date" : 1605311230685,
  "remark" : "123",
  "use_quartz_cron" : false
}

Status code: 400

Bad Request

{
  "code" : 400,
  "reason" : {
    "error_code" : "FDI.3149",
    "error_msg" : "The task ID is empty."
  }
}

Status code: 404

Not Found

{
  "code" : 404,
  "reason" : {
    "error_code" : "FDI.3180",
    "error_msg" : "This task is not in the project."
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Task Management