Skip to main content
PUT
/
api
/
step-executions
/
{id}
Update StepExecution
curl --request PUT \
  --url https://platform.kodexa.ai/api/step-executions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "attemptNumber": 123,
  "changeSequence": 123,
  "completedAt": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "durationMs": 123,
  "errorDetails": {},
  "errorMessage": "<string>",
  "executionId": "<string>",
  "id": "<string>",
  "inputEvent": {},
  "logsUri": "<string>",
  "metrics": {},
  "organizationId": "<string>",
  "outputEvent": {},
  "sliceId": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "stepName": "<string>",
  "stepOrder": 123,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "attemptNumber": 123,
  "changeSequence": 123,
  "completedAt": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "durationMs": 123,
  "errorDetails": {},
  "errorMessage": "<string>",
  "executionId": "<string>",
  "id": "<string>",
  "inputEvent": {},
  "logsUri": "<string>",
  "metrics": {},
  "organizationId": "<string>",
  "outputEvent": {},
  "sliceId": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "stepName": "<string>",
  "stepOrder": 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
​
attemptNumber
integer<int32>
​
changeSequence
integer<int32>
​
completedAt
string<date-time> | null
​
createdOn
string<date-time>
​
durationMs
integer<int32> | null
​
errorDetails
object
​
errorMessage
string | null
​
executionId
string
​
id
string
​
inputEvent
object
​
logsUri
string | null
​
metrics
object
​
organizationId
string
​
outputEvent
object
​
sliceId
string | null
​
startedAt
string<date-time> | null
​
status
string
​
stepName
string
​
stepOrder
integer<int32>
​
updatedOn
string<date-time>
​
uuid
string

Response

Updated StepExecution

​
attemptNumber
integer<int32>
​
changeSequence
integer<int32>
​
completedAt
string<date-time> | null
​
createdOn
string<date-time>
​
durationMs
integer<int32> | null
​
errorDetails
object
​
errorMessage
string | null
​
executionId
string
​
id
string
​
inputEvent
object
​
logsUri
string | null
​
metrics
object
​
organizationId
string
​
outputEvent
object
​
sliceId
string | null
​
startedAt
string<date-time> | null
​
status
string
​
stepName
string
​
stepOrder
integer<int32>
​
updatedOn
string<date-time>
​
uuid
string