workflowsUpdateStep
Update the configuration for a workflow extension step.
Details
- Method:
GET - Path:
/workflows.updateStep - Operation ID:
workflows_updateStep
Parameters
{
"token": {
"description": "Authentication token. Requires scope: `workflow.steps:execute`",
"required": true,
"location": "header",
"type": "string"
},
"workflow_step_edit_id": {
"description": "A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.",
"required": true,
"location": "query",
"type": "string"
},
"inputs": {
"description": "A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. **Please note**: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. [Read more about variables in workflow steps here](/workflows/steps#variables).",
"required": false,
"location": "query",
"type": "string"
},
"outputs": {
"description": "An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.",
"required": false,
"location": "query",
"type": "string"
},
"step_name": {
"description": "An optional field that can be used to override the step name that is shown in the Workflow Builder.",
"required": false,
"location": "query",
"type": "string"
},
"step_image_url": {
"description": "An optional field that can be used to override app image that is shown in the Workflow Builder.",
"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('workflowsUpdateStep', {
# Add required parameters here
})