Open Context Protocol is live! 🚀 Read the launch post

getWorkflow

Get issue types for workflows in workflow scheme

Details

  • Method: GET
  • Path: /rest/api/3/workflowscheme/{id}/workflow
  • Operation ID: getWorkflow

Parameters

{
  "id": {
    "description": "The ID of the workflow scheme.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "workflowName": {
    "description": "The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.",
    "required": false,
    "location": "query",
    "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 issue types and a workflow.",
  "properties": {
    "defaultMapping": {
      "description": "Whether the workflow is the default workflow for the workflow scheme.",
      "type": "boolean"
    },
    "issueTypes": {
      "description": "The list of issue type IDs.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "updateDraftIfNeeded": {
      "description": "Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`.",
      "type": "boolean"
    },
    "workflow": {
      "description": "The name of the workflow. Optional if updating the workflow-issue types mapping.",
      "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('getWorkflow', {
    # Add required parameters here
})