Skip to main content

Submit a Task for Approval

Use this API to submit a specified task for approval.

Request URL: /openapi/v1/workflow/submitForApproval

HTTP method: POST

Request parameters

ParameterTypeRequiredDescriptionExample
workflowIdStringYesTask ID.st-dd46vm7divwx
reasonStringNoReason for submitting the task for approval.release
sourceStringNoCall source.api
toolIdStringNoTool identifier.tool-1
sourceClientStringNoCalling client.client-1
sourceSessionIdStringNoExternal session ID.session-1
skillVersionStringNoTool version.1.0.0
languageStringNoLanguage for response messages.enus

Response parameters

ParameterTypeDescriptionExample
successBooleanWhether the request was successful.true
requestIdStringOpenAPI request ID."<requestId>"
dataObjectEmpty on success.{}
messageStringError message.N/A

Successful response example

{
"success": true,
"requestId": "<requestId>",
"data": {}
}