Open Context Protocol is live! 🚀 Read the launch post
getWorkflowSchemeIssueType

getWorkflowSchemeIssueType

Get workflow for issue type in workflow scheme

Details

  • Method: GET
  • Path: /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
  • Operation ID: getWorkflowSchemeIssueType

Parameters

{
  "id": {
    "description": "The ID of the workflow scheme.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "issueType": {
    "description": "The ID of the issue type.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "returnDraftIfExists": {
    "description": "Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.",
    "required": false,
    "location": "query",
    "type": "boolean"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Details about the mapping between an issue type and a workflow.",
  "properties": {
    "issueType": {
      "description": "The ID of the issue type. Not required if updating the issue type-workflow mapping.",
      "type": "string"
    },
    "updateDraftIfNeeded": {
      "description": "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping.",
      "type": "boolean"
    },
    "workflow": {
      "description": "The name of the workflow.",
      "type": "string"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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