getDefaultWorkflow
Get default workflow
Details
- Method:
GET - Path:
/rest/api/3/workflowscheme/{id}/default - Operation ID:
getDefaultWorkflow
Parameters
{
"id": {
"description": "The ID of the workflow scheme.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"returnDraftIfExists": {
"description": "Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.",
"required": false,
"location": "query",
"type": "boolean"
}
}Response Schema
{
"additionalProperties": false,
"description": "Details about the default workflow.",
"properties": {
"updateDraftIfNeeded": {
"description": "Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`.",
"type": "boolean"
},
"workflow": {
"description": "The name of the workflow to set as the default workflow.",
"type": "string"
}
},
"required": [
"workflow"
],
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getDefaultWorkflow', {
# Add required parameters here
})