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

getProjectUsagesForWorkflow

Get projects using a given workflow

Details

  • Method: GET
  • Path: /rest/api/3/workflow/{workflowId}/projectUsages
  • Operation ID: getProjectUsagesForWorkflow

Parameters

{
  "workflowId": {
    "description": "The workflow ID",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "nextPageToken": {
    "description": "The cursor for pagination",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "maxResults": {
    "description": "The maximum number of results to return. Must be an integer between 1 and 200.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int32"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Projects using the workflow.",
  "properties": {
    "projects": {
      "additionalProperties": false,
      "description": "A page of projects.",
      "properties": {
        "nextPageToken": {
          "description": "Page token for the next page of project usages.",
          "type": "string"
        },
        "values": {
          "description": "The list of projects.",
          "items": {
            "additionalProperties": false,
            "description": "The project.",
            "properties": {
              "id": {
                "description": "The project ID.",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "workflowId": {
      "description": "The workflow ID.",
      "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('getProjectUsagesForWorkflow', {
    # Add required parameters here
})