Open Context Protocol is live! 🚀 Read the launch post

updateSchemes

Update workflow scheme

Details

  • Method: POST
  • Path: /rest/api/3/workflowscheme/update
  • Operation ID: updateSchemes

Parameters

{
  "defaultWorkflowId": {
    "description": "The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to *Jira Workflow (jira)*.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "description": {
    "description": "The new description for this workflow scheme.",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "id": {
    "description": "The ID of this workflow scheme.",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "name": {
    "description": "The new name for this workflow scheme.",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "statusMappingsByIssueTypeOverride": {
    "description": "Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.",
    "required": false,
    "location": "body",
    "type": "array"
  },
  "statusMappingsByWorkflows": {
    "description": "The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`.",
    "required": false,
    "location": "body",
    "type": "array"
  },
  "version": {
    "description": "The current version details of this workflow scheme.",
    "required": true,
    "location": "body",
    "type": "object"
  },
  "workflowsForIssueTypes": {
    "description": "Mappings from workflows to issue types.",
    "required": false,
    "location": "body",
    "type": "array"
  }
}

Response Schema

{}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('updateSchemes', {
    # Add required parameters here
})