Schedule Entity
| The following are the attributes in the body of a Schedule service. | |||
| Attribute | Type | Updatable | Comments |
|---|---|---|---|
| id | UUID | no | (Required for PUT only)For PUT the ID in body must valid ID and must match step on the URL.
For POST this is ignored. |
| version | no | (Optional) This is shown to the user for informational purposes only. | |
| name | string | yes | (Required) Unique among other schedules. A Valid SQL Identifier |
| description | string | yes | (Optional) |
| labels | list<string> | yes | (Optional) |
| cronExpression | string | yes | (Required) Refer to Create Schedule for cron expression syntax. |
| status | string | yes | (Optional) Currently “ACTIVE” or “SUSPENDED”. Required if payloadId or payloadName are present |
| payloadType | string | yes | (Required) The type of the object which is being scheduled.currently “step” or “pipeline” |
| payloadId | UUID | yes | (Required) The Id of the object which is being scheduled. If you provide this you must also provide payloadType. If you don’t provide this, you must provide payloadName. |
| condition | string | yes | (Optional) Refer to Create Schedule for condition expression syntax. |
| canOverlap | boolean | yes | (Optional) |
| retries | int | yes | (Optional) Number of retries |
| retryIntervalMinutes | int | yes | (Optional) Minutes to wait between retries |
| onConditionFalseObjectType | string | yes | (Optional) The condition-false object’s type: only “step” is allowed right now |
| onConditionFalseObjectId | UUID | yes | (Optional) The ID of the onConditionFalse object. If you provide this you must also provide onConditionFalseObjectType. |
| createdInstant | datetime | no | (Optional) |
| createdBy | string | no | (Optional) Username associated with session |
| modifiedInstant | datetime | no | (Optional) |
| modifiedBy | string | no | (Optional) Username associated with session |
List of APIs
Note: We have tried to keep this list up to date. However, for the most up to date list, see the interactive docs: https://connect-i1.xactlycorp.com/connect/docs/swagger-ui.html
POST /connect/v1/schedulesCreates a Schedule for managing the periodic invocation of a step or pipeline. Returns the resulting schedule ID in the Location header.
DELETE /connect/v1/schedules/{id}Delete a Schedule from the collection.
GET /connect/v1/schedulesGet a paginated list of all Schedule definitions. You can provide a page number (default 0) and a page size (default 100, max 1000). A description of the pagination pattern and metadata can be found here: [LINK]
GET /connect/v1/schedules/{id}Get a single Schedule definition. You have to provide a valid Schedule ID.
PUT /connect/v1/schedules/{id}Update a Schedule definition.
You have to provide a valid Schedule definition ID in the URL and in the payload. The ID attribute can not be updated.