Change an action
Changes one action's configuration. Its place in the pipeline does not change.
Last updated:
Changes one action's configuration. Its place in the pipeline does not change.
PUT /api/v1/pipelines/{pipelineId}/actions/{actionId}
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. |
actionId | path | yes | string (uuid) | The action's id. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
type | one of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORT | no | |
writeStrategy | one of INSERT, MERGE, CLEAN | no | |
sourceEnvironmentId | string (uuid) | no | |
targetEnvironmentId | string (uuid) | no | |
entitySelections | list of object | no | |
entitySelections[].selectionId | string | no | |
entitySelections[].entityIdentifier | string | no | |
entitySelections[].entityName | string | no | |
entitySelections[].entityDisplayName | string | no | |
entitySelections[].filterExpression | string | no | |
entitySelections[].transformations | list of object | no | |
entitySelections[].transformations[].fieldIdentifier | string | no | |
entitySelections[].transformations[].fieldName | string | no | |
entitySelections[].transformations[].fieldType | string | no | |
entitySelections[].transformations[].type | string | no | |
entitySelections[].transformations[].parameters | object | no | |
entitySelections[].transformations[].orderIndex | integer | no | |
entitySelections[].keyAttributes | list of string | no | |
entitySelections[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
entitySelections[].moduleIdentifier | string | no | |
entitySelections[].moduleName | string | no | |
entitySelections[].fields | list of object | no | |
entitySelections[].fields[].identifier | string | no | |
entitySelections[].fields[].name | string | no | |
entitySelections[].fields[].type | string | no | |
entitySelections[].fields[].typeDescriptor | string | no | |
config | object | no |
Example request:
{
"writeStrategy": "INSERT"
}Responses
200
The updated action.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
type | one of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORT | yes | |
writeStrategy | one of INSERT, MERGE, CLEAN | no | |
sequenceIndex | integer | yes | |
sourceEnvironmentId | string (uuid) | no | |
targetEnvironmentId | string (uuid) | yes | |
status | one of VALID, INCOMPLETE, INVALID | yes | |
entitySelections | list of object | yes | |
entitySelections[].selectionId | string | no | |
entitySelections[].entityIdentifier | string | no | |
entitySelections[].entityName | string | no | |
entitySelections[].entityDisplayName | string | no | |
entitySelections[].filterExpression | string | no | |
entitySelections[].transformations | list of object | no | |
entitySelections[].transformations[].fieldIdentifier | string | no | |
entitySelections[].transformations[].fieldName | string | no | |
entitySelections[].transformations[].fieldType | string | no | |
entitySelections[].transformations[].type | string | no | |
entitySelections[].transformations[].parameters | object | no | |
entitySelections[].transformations[].orderIndex | integer | no | |
entitySelections[].keyAttributes | list of string | no | |
entitySelections[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
entitySelections[].moduleIdentifier | string | no | |
entitySelections[].moduleName | string | no | |
entitySelections[].fields | list of object | no | |
entitySelections[].fields[].identifier | string | no | |
entitySelections[].fields[].name | string | no | |
entitySelections[].fields[].type | string | no | |
entitySelections[].fields[].typeDescriptor | string | no | |
config | object | yes | |
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
A path id is not even syntactically a valid id (not a well-formed UUID) — distinct from 404, which means a well-formed id that simply does not exist.
| 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 or action.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |
422
The action's configuration is not valid.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |