Update
Update a workflow.
Request
URI
POST
https://{api_host}/telco/api/workflows/workflow/{workflowId}
COPY
Path Parameters
string
workflowExecutionId
Required
The identifier of the workflow execution
Request Body
The updated workflow
workflowExecutionChange of type(s) application/json
Required
{
"startStepId": "string",
"pauseAtFailure": false,
"retainedTil": "string",
"debugStepIds": [
"string"
]
}string
startStepId
Optional
The identifier of the starting step
boolean
pauseAtFailure
Optional
Shall the execution pause at any failure
string As date-time As date-time
retainedTil
Optional
The time till which the workflow execution is retained
array of string
debugStepIds
Optional
The identifiers of the steps at which the execution shall pause
object
steps
Optional
The steps of the workflow
Responses
200
Successfully updated the workflow.
Returns workflowExecution of type(s) application/json
This response body class contains all of the following: workflowExecutionBase , InlineworkflowExecution1
{
"pauseAtFailure": false,
"retainedTil": "string",
"debugStepIds": [
"string"
],
"contextType": "string",
"workflow": {
"id": "string",
"createdAt": "string",
"creationUser": "string"
},
"id": "string",
"creationTime": "string",
"aborted": false,
"endTime": "string",
"creationUser": "string",
"stepExecutions": [
{
"stepSnapshot": {
"id": "string"
},
"state": "string",
"startTime": "string",
"aborted": false,
"endTime": "string",
"logs": [
{
"msg": "string",
"time": "string",
"level": "string"
}
]
}
],
"logs": [
{
"msg": "string",
"time": "string",
"level": "string"
}
]
}
400
Bad Request
Returns errorResponse of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Workflow not found
Operation doesn't return any data structure
500
Internal Server Error
Returns errorResponse of type(s) application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
On This Page
Workflow Operations
POST
Convert
PUT
Create
POST
Create By Multi Content
DELETE
Delete
GET
Get
GET
List
POST
Update