getRequiredWorkflowSchemeMappings
Get required status mappings for workflow scheme update
Details
- Method:
POST - Path:
/rest/api/3/workflowscheme/update/mappings - Operation ID:
getRequiredWorkflowSchemeMappings
Parameters
{
"defaultWorkflowId": {
"description": "The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to *Jira Workflow (jira)*.",
"required": false,
"location": "body",
"type": "string"
},
"id": {
"description": "The ID of the workflow scheme.",
"required": true,
"location": "body",
"type": "string"
},
"workflowsForIssueTypes": {
"description": "The new workflow to issue type mappings for this workflow scheme.",
"required": true,
"location": "body",
"type": "array"
}
}Response Schema
{
"additionalProperties": false,
"properties": {
"statusMappingsByIssueTypes": {
"description": "The list of required status mappings by issue type.",
"items": {
"additionalProperties": false,
"description": "The list of required status mappings by issue type.",
"properties": {
"issueTypeId": {
"description": "The ID of the issue type.",
"type": "string"
},
"statusIds": {
"description": "The status IDs requiring mapping.",
"items": {
"description": "The status IDs requiring mapping.",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"statusMappingsByWorkflows": {
"description": "The list of required status mappings by workflow.",
"items": {
"additionalProperties": false,
"description": "The list of required status mappings by workflow.",
"properties": {
"sourceWorkflowId": {
"description": "The ID of the source workflow.",
"type": "string"
},
"statusIds": {
"description": "The status IDs requiring mapping.",
"items": {
"description": "The status IDs requiring mapping.",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"targetWorkflowId": {
"description": "The ID of the target workflow.",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"statuses": {
"description": "The details of the statuses in the associated workflows.",
"items": {
"additionalProperties": false,
"description": "The details of the statuses in the associated workflows.",
"properties": {
"category": {
"description": "The category of the status.",
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string"
},
"id": {
"description": "The ID of the status.",
"type": "string"
},
"name": {
"description": "The name of the status.",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
},
"statusesPerWorkflow": {
"description": "The statuses associated with each workflow.",
"items": {
"additionalProperties": false,
"description": "The statuses associated with each workflow.",
"properties": {
"initialStatusId": {
"description": "The ID of the initial status for the workflow.",
"type": "string"
},
"statuses": {
"description": "The status IDs associated with the workflow.",
"items": {
"description": "The status IDs associated with the workflow.",
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"workflowId": {
"description": "The ID of the workflow.",
"type": "string"
}
},
"type": "object"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getRequiredWorkflowSchemeMappings', {
# Add required parameters here
})