getAllWorkflows
Get all workflows
Details
- Method:
GET - Path:
/rest/api/3/workflow - Operation ID:
getAllWorkflows
Parameters
{
"workflowName": {
"description": "The name of the workflow to be returned. Only one workflow can be specified.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"items": {
"additionalProperties": false,
"description": "Details about a workflow.",
"properties": {
"default": {
"type": "boolean"
},
"description": {
"description": "The description of the workflow.",
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"description": "The datetime the workflow was last modified.",
"readOnly": true,
"type": "string"
},
"lastModifiedUser": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"lastModifiedUserAccountId": {
"description": "The account ID of the user that last modified the workflow.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the workflow.",
"readOnly": true,
"type": "string"
},
"scope": {
"allOf": [
{
"$ref": "#/components/schemas/Scope"
}
],
"description": "The scope where this workflow applies",
"readOnly": true
},
"steps": {
"description": "The number of steps included in the workflow.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getAllWorkflows', {
# Add required parameters here
})