Skip to main content
Version: Current

Update Workflow Data

Overview​

Update Workflow Data for a workflow instance. Workflow Data was previously displayed as Model Data. The endpoint name submitModelData is unchanged for backward compatibility.

Endpoint​

POST /api/processinstance/submitModelData

Use the service origin described in Getting started. The path above already includes /api.

Authentication​

Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.

Request headers​

Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

Request body​

ParameterTypeRequirementDescription
processInstanceIdstringRequiredExecution ID returned by Create Process Instance.
DataobjectRequiredField keys and values matching the data definitions in the process.
workflowInstanceIdstringRequiredWorkflow instance ID within the process execution; distinct from the process instance ID.
{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"Data": {
"checkListInput": "ChatGPTChecklist.txt"
},
"workflowInstanceId": "39dbce1557154eeca68ac13c2360e9e5"
}

Request example​

The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.

curl --request POST \
--url 'https://command-center.example.com/api/processinstance/submitModelData' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"Data": {
"checkListInput": "ChatGPTChecklist.txt"
},
"workflowInstanceId": "39dbce1557154eeca68ac13c2360e9e5"
}'

Response​

Successful status: 200 OK.

The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.

{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"instDataId": 157,
"status": "Success"
}

Supply both process and workflow instance IDs. Data contains Workflow Data field keys and values; the designer name was previously Model Data.

Response fields​

The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.

FieldExample typeDescription
processInstanceIdstringID of the process execution.
instDataIdintegerIdentifier of the Workflow Data record.
statusstringResource or operation status shown in the example; the complete allowed set is not defined here.

Errors​

Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.