Schedule APIs

Scheduling enables automated processing of flow services at specific times or regular intervals. You can use these APIs to create, modify, enable, disable, or delete schedules as needed.

GET - List schedules

List all schedules configured for the services in a project.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers

Parameters

{projectAlias} - Name of the project.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

{
  "output": [
    {
      "runOnceType": "scheduledAt",
      "scheduleType": "runOnce",
      "recurrenceInterval": 0,
      "startDate": 1751092920000,
      "endDate": 0,
      "dayOfTheMonth": 0,
      "lastRunTime": 0,
      "nextRunTime": 1751092920000,
      "serviceName": "hellofs",
      "status": "ACTIVE",
      "isRepeatExecutionOnlyAfterCompletion": false
    },
    {
      "runOnceType": "scheduledAt",
      "scheduleType": "runRecurrent",
      "executionTime": [1750834200000],
      "recurrenceType": "monthly",
      "recurrenceInterval": 0,
      "startDate": 1750834800000,
      "endDate": 1758870000000,
      "dayOfTheMonth": 1,
      "daysOfTheWeek": [],
      "lastRunTime": 0,
      "nextRunTime": 1751439000000,
      "serviceName": "myfs",
      "status": "ACTIVE",
      "isRepeatExecutionOnlyAfterCompletion": false
    },
    {
      "runOnceType": "scheduledAt",
      "scheduleType": "runRecurrent",
      "pipeline": {
        "a": "1"
      },
      "executionTime": [1750748700000],
      "recurrenceType": "Minute",
      "recurrenceInterval": 300,
      "startDate": 1750920060000,
      "endDate": 1751352660000,
      "dayOfTheMonth": 0,
      "lastRunTime": 0,
      "nextRunTime": 1750920060000,
      "serviceName": "add",
      "status": "ACTIVE",
      "isRepeatExecutionOnlyAfterCompletion": true
    },
    {
      "runOnceType": "scheduledAt",
      "scheduleType": "runRecurrent",
      "executionTime": [1750834140000],
      "recurrenceType": "daily",
      "recurrenceInterval": 2,
      "startDate": 1750921200000,
      "endDate": 0,
      "dayOfTheMonth": 0,
      "lastRunTime": 0,
      "nextRunTime": 1751006940000,
      "serviceName": "yfs",
      "status": "ACTIVE",
      "isRepeatExecutionOnlyAfterCompletion": true
    },
    {
      "runOnceType": "scheduledAt",
      "scheduleType": "runRecurrent",
      "executionTime": [1750834200000],
      "recurrenceType": "weekly",
      "recurrenceInterval": 1,
      "startDate": 1750834800000,
      "endDate": 0,
      "dayOfTheMonth": 0,
      "daysOfTheWeek": [2, 5],
      "lastRunTime": 0,
      "nextRunTime": 1751007000000,
      "serviceName": "testfs",
      "status": "ACTIVE",
      "isRepeatExecutionOnlyAfterCompletion": true
    }
  ]
}

GET - Get schedules

Retrieves the details of a specific schedule.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers/{flowServiceName}

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

{
  "output": {
    "runOnceType": "scheduledAt",
    "scheduleType": "runRecurrent",
    "executionTime": [],
    "recurrenceType": "weekly",
    "recurrenceInterval": 1,
    "startDate": 1750834800000,
    "endDate": 0,
    "dayOfTheMonth": 0,
    "daysOfTheWeek": [],
    "isRepeatExecutionOnlyAfterCompletion": true
  }
}

POST - Create schedules

Create a schedule to run a flow service.

URL

../apis/v1/rest/projects/{projectAlais}/configurations/schedulers/{flowServiceName}

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

{
  "runOnceType": "scheduledAt",
  "pipeline": null,
  "scheduleType": "runRecurrent",
  "executionTime": [1748583216000],
  "recurrenceType": "Minute",
  "recurrenceInterval": 600,
  "startDate": 1748583216000,
  "endDate": 1761802339000
}

Response

{
  "output": {
    "code": 0,
    "description": "Success"
  }
}

POST - Status of schedules

Get the status of a specific schedule.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers/{flowServiceName}/status

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

{
  "output": [
    {
      "lastRunTime": 1750830510000,
      "nextRunTime": 1750920060000,
      "status": "ACTIVE"
    }
  ]
}

POST - Pause schedules

Pauses a schedule for a specific duration.

URL

../apis/v1/rest/projects/{projectAlais}/configurations/schedulers/{flowServiceName}/pause

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

{
  "output": {
    "code": 0,
    "description": "Success"
  }
}

POST - Resume schedules

Resume a schedule after a specific duration.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers/{flowServiceName}/resume

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

{
  "output": {
    "code": 0,
    "description": "Success"
  }
}

POST - Import schedules

Import schedules defined to a project from another project.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers

Parameters

{projectAlias} - Name of the project.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

[
  {
    "runOnceType": "scheduledAt",
    "pipeline": null,
    "scheduleType": "runRecurrent",
    "executionTime": [1748583216000],
    "recurrenceType": "Minute",
    "recurrenceInterval": 600,
    "startDate": 1748583216000,
    "endDate": 1761802339000
  },
  {
    "runOnceType": "scheduledAt",
    "pipeline": null,
    "scheduleType": "runRecurrent",
    "executionTime": [1748583216000],
    "recurrenceType": "Minute",
    "recurrenceInterval": 600,
    "startDate": 1748583216000,
    "endDate": 1761802339000
  },
  {
    "runOnceType": "scheduledAt",
    "pipeline": null,
    "scheduleType": "runRecurrent",
    "executionTime": [1748583216000],
    "recurrenceType": "Minute",
    "recurrenceInterval": 600,
    "startDate": 1748583216000,
    "endDate": 1761802339000,
    "serviceName": "testfs",
    "override": false
  },
  {
    "runOnceType": "scheduledAt",
    "pipeline": null,
    "scheduleType": "runRecurrent",
    "executionTime": [1748583216000],
    "recurrenceType": "Minute",
    "recurrenceInterval": 600,
    "startDate": 1748583216000,
    "endDate": 1761802339000,
    "serviceName": "hellofs"
    // "override": false
  }
]

Response

{
  "output": [
    {
      "name": "testfs",
      "status": "failed",
      "details": {
        "error": "Another schedule already exists for flow service: testfs"
      }
    },
    {
      "name": "invalid_service_names",
      "status": "failed",
      "details": {
        "error": "2 schedule(s) skipped: serviceName is null or empty"
      }
    },
    {
      "name": "hellofs",
      "status": "success"
    }
  ]
}

DELETE - Delete schedules

Deletes a schedule.

URL

../apis/v1/rest/projects/{projectAlias}/configurations/schedulers/{flowServiceName}

Parameters

{projectAlias} - Name of the project.
{flowServiceName} - Name of the flow service.

Request headers

Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>

Request body

None

Response

If the request is successful, the HTTP Status 204 (No Content) status code is displayed.