Reorder a pipeline's actions
Sets the order actions run in. Every action id of the pipeline must be listed, once each.
Last updated:
Sets the order actions run in. Every action id of the pipeline must be listed, once each.
PUT /api/v1/pipelines/{pipelineId}/actions/reorder
Authorization
Requires a signed-in person with this scope: pipelines:write.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Workspace-Id | header | yes | string (uuid) | The workspace the call acts in. Take it from the workspace list. |
pipelineId | path | yes | string (uuid) | The pipeline's id. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
actionIds | list of string (uuid) | yes |
Example request:
{
"actionIds": [
"4b2c3d4e-5f60-7182-93a4-b5c6d7e8f9a0"
]
}Responses
200
The pipeline with its actions in the new order.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
name | string | yes | |
description | string | yes | |
status | one of DRAFT, VALID, INVALID | yes | |
statusReason | string | no | |
schedule | string | yes | |
createdBy | string | yes | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes | |
actions | list of object | yes | |
actions[].id | string (uuid) | yes | |
actions[].type | one of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORT | yes | |
actions[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].sequenceIndex | integer | yes | |
actions[].sourceEnvironmentId | string (uuid) | no | |
actions[].targetEnvironmentId | string (uuid) | yes | |
actions[].status | one of VALID, INCOMPLETE, INVALID | yes | |
actions[].entitySelections | list of object | yes | |
actions[].entitySelections[].selectionId | string | no | |
actions[].entitySelections[].entityIdentifier | string | no | |
actions[].entitySelections[].entityName | string | no | |
actions[].entitySelections[].entityDisplayName | string | no | |
actions[].entitySelections[].filterExpression | string | no | |
actions[].entitySelections[].transformations | list of object | no | |
actions[].entitySelections[].transformations[].fieldIdentifier | string | no | |
actions[].entitySelections[].transformations[].fieldName | string | no | |
actions[].entitySelections[].transformations[].fieldType | string | no | |
actions[].entitySelections[].transformations[].type | string | no | |
actions[].entitySelections[].transformations[].parameters | object | no | |
actions[].entitySelections[].transformations[].orderIndex | integer | no | |
actions[].entitySelections[].keyAttributes | list of string | no | |
actions[].entitySelections[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].entitySelections[].moduleIdentifier | string | no | |
actions[].entitySelections[].moduleName | string | no | |
actions[].entitySelections[].fields | list of object | no | |
actions[].entitySelections[].fields[].identifier | string | no | |
actions[].entitySelections[].fields[].name | string | no | |
actions[].entitySelections[].fields[].type | string | no | |
actions[].entitySelections[].fields[].typeDescriptor | string | no | |
actions[].config | object | yes | |
actions[].connectorName | string | no | Display name of the workspace connector an Export writes through, beside its id in config. Null when the action references no connector or that connector was deleted. |
400
Either pipelineId is not a valid id, or the action list does not match the pipeline's actions exactly.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |
404
There is no such pipeline.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |