getFilter

{
  "id": {
    "description": "The ID of the filter to return.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "expand": {
    "description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:\n\n *  `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n *  `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.",
    "required": false,
    "location": "query",
    "type": "string"
  },
  "overrideSharePermissions": {
    "description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
    "required": false,
    "location": "query",
    "type": "boolean"
  }
}

{
  "additionalProperties": false,
  "description": "Details about a filter.",
  "properties": {
    "approximateLastUsed": {
      "description": "\\[Experimental\\] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "description": "A description of the filter.",
      "type": "string"
    },
    "editPermissions": {
      "description": "The groups and projects that can edit the filter.",
      "items": {
        "additionalProperties": false,
        "description": "Details of a share permission for the filter.",
        "properties": {
          "group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GroupName"
              }
            ],
            "description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
          },
          "id": {
            "description": "The unique identifier of the share permission.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "project": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Project"
              }
            ],
            "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`.  \nFor a request, specify the `id` for the project."
          },
          "role": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ProjectRole"
              }
            ],
            "description": "The project role that the filter is shared with.  \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
          },
          "type": {
            "description": "The type of share permission:\n\n *  `user` Shared with a user.\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
            "enum": [
              "user",
              "group",
              "project",
              "projectRole",
              "global",
              "loggedin",
              "authenticated",
              "project-unknown"
            ],
            "type": "string"
          },
          "user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserBean"
              }
            ],
            "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "favourite": {
      "description": "Whether the filter is selected as a favorite.",
      "type": "boolean"
    },
    "favouritedCount": {
      "description": "The count of how many users have selected this filter as a favorite, including the filter owner.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "The unique identifier for the filter.",
      "readOnly": true,
      "type": "string"
    },
    "jql": {
      "description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.",
      "type": "string"
    },
    "name": {
      "description": "The name of the filter. Must be unique.",
      "type": "string"
    },
    "owner": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.",
      "readOnly": true
    },
    "searchUrl": {
      "description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "self": {
      "description": "The URL of the filter.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "sharePermissions": {
      "description": "The groups and projects that the filter is shared with.",
      "items": {
        "additionalProperties": false,
        "description": "Details of a share permission for the filter.",
        "properties": {
          "group": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GroupName"
              }
            ],
            "description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
          },
          "id": {
            "description": "The unique identifier of the share permission.",
            "format": "int64",
            "readOnly": true,
            "type": "integer"
          },
          "project": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Project"
              }
            ],
            "description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`.  \nFor a request, specify the `id` for the project."
          },
          "role": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ProjectRole"
              }
            ],
            "description": "The project role that the filter is shared with.  \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
          },
          "type": {
            "description": "The type of share permission:\n\n *  `user` Shared with a user.\n *  `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n *  `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n *  `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n *  `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n *  `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n *  `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.",
            "enum": [
              "user",
              "group",
              "project",
              "projectRole",
              "global",
              "loggedin",
              "authenticated",
              "project-unknown"
            ],
            "type": "string"
          },
          "user": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UserBean"
              }
            ],
            "description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "sharedUsers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserList"
        }
      ],
      "description": "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.",
      "readOnly": true
    },
    "subscriptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilterSubscriptionsList"
        }
      ],
      "description": "A paginated list of the users that are subscribed to the filter.",
      "readOnly": true
    },
    "viewUrl": {
      "description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object",
  "xml": {
    "name": "filter"
  }
}

from ocp_agent import OCPAgent

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

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