Step Entity
| The following are the attributes in the body of a step service. | |||
| Attribute | Type | Updatable | Comments |
|---|---|---|---|
| id | UUID | no | (Required for PUT calls only.)
For PUT the step ID in body must valid step ID and must match step on the URL. For POST this is ignored. |
| version | int | no | (Optional) Shown to the user for informational purposes only |
| name | string | yes | (Required) Unique among other steps. A Valid SQL Identifier |
| description | string | yes | (Optional) |
| labels | list<string> | yes | (Optional) |
| disabled | boolean | yes | (Optional) Default is false. |
| command | string | yes | (Optional) xCL command inside the step |
| 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/stepsCreates a Step that can be can then be added to a pipeline or invoked independently. Returns the resulting step ID in the Location header.
DELETE /connect/v1/steps/{id}Delete a Step from the collection.
GET /connect/v1/stepsGet a paginated list of all Step 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/steps/{id}Get a single Step definition. You have to provide a valid Step ID.