workflowsStepCompleted
Indicate that an app’s step in a workflow completed execution.
Details
- Method:
GET - Path:
/workflows.stepCompleted - Operation ID:
workflows_stepCompleted
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `workflow.steps:execute`",
"required": true,
"location": "header",
"type": "string"
},
"workflow_step_execute_id": {
"description": "Context identifier that maps to the correct workflow step execution.",
"required": true,
"location": "query",
"type": "string"
},
"outputs": {
"description": "Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": true,
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"properties": {
"ok": {
"enum": [
true
],
"title": "default success response",
"type": "boolean"
}
},
"required": [
"ok"
],
"title": "Default success template",
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('slack')
# Call this tool
result = await agent.call_tool('workflowsStepCompleted', {
# Add required parameters here
})