Add an action to a pipeline

Appends a new action at the end of the pipeline.

Last updated:

Appends a new action at the end of the pipeline.

POST /api/v1/pipelines/{pipelineId}/actions

Authorization

Requires a signed-in person with this scope: pipelines:write.

Parameters

NameInRequiredTypeDescription
X-Workspace-Idheaderyesstring (uuid)The workspace the call acts in. Take it from the workspace list.
pipelineIdpathyesstring (uuid)The pipeline's id.

Request body

FieldTypeRequiredDescription
typeone of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORTyes
writeStrategyone of INSERT, MERGE, CLEANno
sourceEnvironmentIdstring (uuid)no
targetEnvironmentIdstring (uuid)no
entitySelectionslist of objectno
entitySelections[].selectionIdstringno
entitySelections[].entityIdentifierstringno
entitySelections[].entityNamestringno
entitySelections[].entityDisplayNamestringno
entitySelections[].filterExpressionstringno
entitySelections[].transformationslist of objectno
entitySelections[].transformations[].fieldIdentifierstringno
entitySelections[].transformations[].fieldNamestringno
entitySelections[].transformations[].fieldTypestringno
entitySelections[].transformations[].typestringno
entitySelections[].transformations[].parametersobjectno
entitySelections[].transformations[].orderIndexintegerno
entitySelections[].keyAttributeslist of stringno
entitySelections[].writeStrategyone of INSERT, MERGE, CLEANno
entitySelections[].moduleIdentifierstringno
entitySelections[].moduleNamestringno
entitySelections[].fieldslist of objectno
entitySelections[].fields[].identifierstringno
entitySelections[].fields[].namestringno
entitySelections[].fields[].typestringno
entitySelections[].fields[].typeDescriptorstringno
configobjectno

Example request:

{
  "type": "COPY",
  "writeStrategy": "MERGE",
  "sourceEnvironmentId": "2f8b1c6a-9d3e-4f5a-8b7c-1e2d3f4a5b6c",
  "targetEnvironmentId": "5c3d4e5f-6071-8293-a4b5-c6d7e8f9a0b1",
  "entitySelections": [],
  "config": {}
}

Responses

201

The created action.

FieldTypeRequiredDescription
idstring (uuid)yes
typeone of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORTyes
writeStrategyone of INSERT, MERGE, CLEANno
sequenceIndexintegeryes
sourceEnvironmentIdstring (uuid)no
targetEnvironmentIdstring (uuid)yes
statusone of VALID, INCOMPLETE, INVALIDyes
entitySelectionslist of objectyes
entitySelections[].selectionIdstringno
entitySelections[].entityIdentifierstringno
entitySelections[].entityNamestringno
entitySelections[].entityDisplayNamestringno
entitySelections[].filterExpressionstringno
entitySelections[].transformationslist of objectno
entitySelections[].transformations[].fieldIdentifierstringno
entitySelections[].transformations[].fieldNamestringno
entitySelections[].transformations[].fieldTypestringno
entitySelections[].transformations[].typestringno
entitySelections[].transformations[].parametersobjectno
entitySelections[].transformations[].orderIndexintegerno
entitySelections[].keyAttributeslist of stringno
entitySelections[].writeStrategyone of INSERT, MERGE, CLEANno
entitySelections[].moduleIdentifierstringno
entitySelections[].moduleNamestringno
entitySelections[].fieldslist of objectno
entitySelections[].fields[].identifierstringno
entitySelections[].fields[].namestringno
entitySelections[].fields[].typestringno
entitySelections[].fields[].typeDescriptorstringno
configobjectyes
connectorNamestringnoDisplay 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.

Example response:

{
  "id": "4b2c3d4e-5f60-7182-93a4-b5c6d7e8f9a0",
  "type": "COPY",
  "writeStrategy": "MERGE",
  "sequenceIndex": 0,
  "sourceEnvironmentId": "2f8b1c6a-9d3e-4f5a-8b7c-1e2d3f4a5b6c",
  "targetEnvironmentId": "5c3d4e5f-6071-8293-a4b5-c6d7e8f9a0b1",
  "status": "VALID",
  "entitySelections": [],
  "config": {}
}

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.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno

404

There is no such pipeline.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno

422

The action's configuration is not valid.

FieldTypeRequiredDescription
messagestringyes
statusintegeryes
errorCodestringyes
timestampstring (date-time)no
pathstringno
detailsobjectno