Status update for an Execution Workflow

1min
POST
Path Parameters
workflowInstanceId
string
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Body Parameters
body
ExecutionWorkflowStatus
*
Description
Update status of execution workflow
status
string<STARTED | CLOSED>
*
timestamp
number
*
dispatchId
string
*
jobId
string
*
attemptId
number
*
closeJob
boolean
data
object
*
meta
object
*
code
string
*
updatedBy
UpdatedBy
*
_event_meta
Meta
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
Responses
202
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/workflows/{workflowInstanceId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "status": "",
  "timestamp": 0,
  "dispatchId": "",
  "jobId": "",
  "attemptId": 0,
  "data": {},
  "meta": {},
  "code": "",
  "updatedBy": {},
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/workflows/{workflowInstanceId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "status": "",
  "timestamp": 0,
  "dispatchId": "",
  "jobId": "",
  "attemptId": 0,
  "data": {},
  "meta": {},
  "code": "",
  "updatedBy": {},
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
Responses
202
400
401
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿
Updated 03 Aug 2023
Did this page help you?
Bulk Status update for an Execution Workflow
Status update for an Execution Worklow using workflow id