Skip to main content

WorkflowScheduleRecordWithPreview

namestringrequired

Possible values: non-empty and <= 100 characters

enabledbooleanrequired
resolvedTargetstringrequired

Server only accepts the exact published version, not latest or draft.

Possible values: Value must match regular expression ^\d+\.\d+\.\d+$

entrypointIdstringrequired

Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

timezonestringrequired

IANA Time zone, for example, Asia/Shanghai.

trigger objectrequired
kind stringrequired

Possible values: [WorkflowScheduleWindowIntervalTrigger, WorkflowScheduleCronTrigger]

weekdaysinteger[]required

Monday to Sunday correspond to 1 to 7.

Possible values: >= 1

windows object[]required

Local time windows that do not overlap, with start and end times included in the trigger range.

Possible values: >= 1, <= 12

  • Array [
    • startstringrequired

    Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

    endstringrequired

    Possible values: Value must match regular expression ^(?:[01]\d|2[0-3]):[0-5]\d$

  • ]
    • intervalMinutesintegerrequired

    Possible values: >= 1 and <= 1440

    paramValues objectrequired

    The validation is defined by static parameters of the fixed version selected entrypoint.

    property name*any

    The validation is defined by static parameters of the fixed version selected entrypoint.

    idstring<uuid>required
    workflowIdstringrequired
    createdByUserIdstringrequired
    nextFireAtstring<date-time>
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    preview objectrequired
    nextRunsstring<date-time>[]required

    Possible values: >= 5, <= 5

    WorkflowScheduleRecordWithPreview
    {
      "name": "string",
      "enabled": true,
      "resolvedTarget": "string",
      "entrypointId": "string",
      "timezone": "string",
      "trigger": {
        "kind": "window-interval",
        "weekdays": [
          0
        ],
        "windows": [
          {
            "start": "string",
            "end": "string"
          }
        ],
        "intervalMinutes": 0
      },
      "paramValues": {},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "workflowId": "string",
      "createdByUserId": "string",
      "nextFireAt": "2024-07-29T15:51:28.071Z",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "preview": {
        "nextRuns": [
          "2024-07-29T15:51:28.071Z"
        ]
      }
    }