Skip to main content
PUT
/
api
/
orchestrator-pipeline-steps
/
{id}
Update OrchestratorPipelineStep
curl --request PUT \
  --url https://platform.kodexa.ai/api/orchestrator-pipeline-steps/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "condition": {},
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "entryPoint": "<string>",
  "id": "<string>",
  "metadata": {},
  "moduleId": "<string>",
  "moduleVersion": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "pipelineVersionId": "<string>",
  "properties": {},
  "retryPolicy": {},
  "sequenceOrder": 123,
  "timeoutSeconds": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "condition": {},
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "entryPoint": "<string>",
  "id": "<string>",
  "metadata": {},
  "moduleId": "<string>",
  "moduleVersion": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "pipelineVersionId": "<string>",
  "properties": {},
  "retryPolicy": {},
  "sequenceOrder": 123,
  "timeoutSeconds": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

An orchestrator pipeline step represents a single processing step within a pipeline.

changeSequence
integer<int32>
condition
object
createdOn
string<date-time>
description
string | null
entryPoint
string
id
string
metadata
object
moduleId
string
moduleVersion
string
name
string
organizationId
string
pipelineVersionId
string
properties
object
retryPolicy
object
sequenceOrder
integer<int32>
timeoutSeconds
integer<int32>
updatedOn
string<date-time>
uuid
string

Response

Updated OrchestratorPipelineStep

An orchestrator pipeline step represents a single processing step within a pipeline.

changeSequence
integer<int32>
condition
object
createdOn
string<date-time>
description
string | null
entryPoint
string
id
string
metadata
object
moduleId
string
moduleVersion
string
name
string
organizationId
string
pipelineVersionId
string
properties
object
retryPolicy
object
sequenceOrder
integer<int32>
timeoutSeconds
integer<int32>
updatedOn
string<date-time>
uuid
string