Filter

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Filter",
  "title": "Filter",
  "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": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "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": {
        "$ref": "#/components/schemas/SharePermission"
      },
      "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"
  }
}