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

getScreensForField

Get screens for a field

Details

  • Method: GET
  • Path: /rest/api/3/field/{fieldId}/screens
  • Operation ID: getScreensForField

Parameters

{
  "fieldId": {
    "description": "The ID of the field to return screens for.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "startAt": {
    "description": "The index of the first item to return in a page of results (page offset).",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "maxResults": {
    "description": "The maximum number of items to return per page.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int32"
  },
  "expand": {
    "description": "Use [expand](#expansion) to include additional information about screens in the response. This parameter accepts `tab` which returns details about the screen tabs the field is used in.",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "A page of items.",
  "properties": {
    "isLast": {
      "description": "Whether this is the last page.",
      "readOnly": true,
      "type": "boolean"
    },
    "maxResults": {
      "description": "The maximum number of items that could be returned.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "nextPage": {
      "description": "If there is another page of results, the URL of the next page.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "self": {
      "description": "The URL of the page.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first item returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "total": {
      "description": "The number of items returned.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "values": {
      "description": "The list of items.",
      "items": {
        "additionalProperties": false,
        "description": "A screen with tab details.",
        "properties": {
          "description": {
            "description": "The description of the screen.",
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "description": "The ID of the screen.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "name": {
            "description": "The name of the screen.",
            "readOnly": true,
            "type": "string"
          },
          "scope": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Scope"
              }
            ],
            "description": "The scope of the screen."
          },
          "tab": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ScreenableTab"
              }
            ],
            "description": "The tab for the screen."
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

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

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