getWorkflowTransitionProperties
Get workflow transition properties
Details
- Method:
GET - Path:
/rest/api/3/workflow/transitions/{transitionId}/properties - Operation ID:
getWorkflowTransitionProperties
Parameters
{
"transitionId": {
"description": "The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"includeReservedKeys": {
"description": "Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*.",
"required": false,
"location": "query",
"type": "boolean"
},
"key": {
"description": "The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.",
"required": false,
"location": "query",
"type": "string"
},
"workflowName": {
"description": "The name of the workflow that the transition belongs to.",
"required": true,
"location": "query",
"type": "string"
},
"workflowMode": {
"description": "The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"live",
"draft"
]
}
}Response Schema
{
"additionalProperties": true,
"description": "Details about the server Jira is running on.",
"properties": {
"id": {
"description": "The ID of the transition property.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "The key of the transition property. Also known as the name of the transition property.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "The value of the transition property.",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getWorkflowTransitionProperties', {
# Add required parameters here
})