getWorkflowTransitionRuleConfigurations
Get workflow transition rule configurations
Details
- Method:
GET - Path:
/rest/api/3/workflow/rule/config - Operation ID:
getWorkflowTransitionRuleConfigurations
Parameters
{
"startAt": {
"description": "The index of the first item to return in a page of results (page offset).",
"required": false,
"location": "query",
"type": "integer",
"format": "int64"
},
"maxResults": {
"description": "The maximum number of items to return per page.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
},
"types": {
"description": "The types of the transition rules to return.",
"required": true,
"location": "query",
"type": "array"
},
"keys": {
"description": "The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return.",
"required": false,
"location": "query",
"type": "array"
},
"workflowNames": {
"description": "The list of workflow names to filter by.",
"required": false,
"location": "query",
"type": "array"
},
"withTags": {
"description": "The list of `tags` to filter by.",
"required": false,
"location": "query",
"type": "array"
},
"draft": {
"description": "Whether draft or published workflows are returned. If not provided, both workflow types are returned.",
"required": false,
"location": "query",
"type": "boolean"
},
"expand": {
"description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts `transition`, which, for each rule, returns information about the transition the rule is assigned to.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"description": "A page of items.",
"properties": {
"isLast": {
"description": "Whether this is the last page.",
"readOnly": true,
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of items that could be returned.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nextPage": {
"description": "If there is another page of results, the URL of the next page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"startAt": {
"description": "The index of the first item returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of items returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"values": {
"description": "The list of items.",
"items": {
"additionalProperties": false,
"description": "A workflow with transition rules.",
"properties": {
"conditions": {
"description": "The list of conditions within the workflow.",
"items": {
"additionalProperties": false,
"description": "A workflow transition rule.",
"properties": {
"configuration": {
"additionalProperties": false,
"description": "A rule configuration.",
"properties": {
"disabled": {
"default": false,
"description": "Whether the rule is disabled.",
"type": "boolean"
},
"tag": {
"description": "A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).",
"maxLength": 255,
"type": "string"
},
"value": {
"description": "Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"id": {
"description": "The ID of the transition rule.",
"type": "string"
},
"key": {
"description": "The key of the rule, as defined in the Connect or the Forge app descriptor.",
"readOnly": true,
"type": "string"
},
"transition": {
"allOf": [
{
"$ref": "#/components/schemas/WorkflowTransition"
}
],
"readOnly": true
}
},
"required": [
"configuration",
"id",
"key"
],
"type": "object"
},
"type": "array"
},
"postFunctions": {
"description": "The list of post functions within the workflow.",
"items": {
"additionalProperties": false,
"description": "A workflow transition rule.",
"properties": {
"configuration": {
"additionalProperties": false,
"description": "A rule configuration.",
"properties": {
"disabled": {
"default": false,
"description": "Whether the rule is disabled.",
"type": "boolean"
},
"tag": {
"description": "A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).",
"maxLength": 255,
"type": "string"
},
"value": {
"description": "Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"id": {
"description": "The ID of the transition rule.",
"type": "string"
},
"key": {
"description": "The key of the rule, as defined in the Connect or the Forge app descriptor.",
"readOnly": true,
"type": "string"
},
"transition": {
"allOf": [
{
"$ref": "#/components/schemas/WorkflowTransition"
}
],
"readOnly": true
}
},
"required": [
"configuration",
"id",
"key"
],
"type": "object"
},
"type": "array"
},
"validators": {
"description": "The list of validators within the workflow.",
"items": {
"additionalProperties": false,
"description": "A workflow transition rule.",
"properties": {
"configuration": {
"additionalProperties": false,
"description": "A rule configuration.",
"properties": {
"disabled": {
"default": false,
"description": "Whether the rule is disabled.",
"type": "boolean"
},
"tag": {
"description": "A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).",
"maxLength": 255,
"type": "string"
},
"value": {
"description": "Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page.",
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"id": {
"description": "The ID of the transition rule.",
"type": "string"
},
"key": {
"description": "The key of the rule, as defined in the Connect or the Forge app descriptor.",
"readOnly": true,
"type": "string"
},
"transition": {
"allOf": [
{
"$ref": "#/components/schemas/WorkflowTransition"
}
],
"readOnly": true
}
},
"required": [
"configuration",
"id",
"key"
],
"type": "object"
},
"type": "array"
},
"workflowId": {
"additionalProperties": false,
"description": "Properties that identify a workflow.",
"properties": {
"draft": {
"description": "Whether the workflow is in the draft state.",
"type": "boolean"
},
"name": {
"description": "The name of the workflow.",
"type": "string"
}
},
"required": [
"draft",
"name"
],
"type": "object"
}
},
"required": [
"workflowId"
],
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getWorkflowTransitionRuleConfigurations', {
# Add required parameters here
})