Atlassian · Schema
FilterDetails
Details of a filter.
CodeCollaborationPlatformProductivitySoftware Development
Properties
| Name | Type | Description |
|---|---|---|
| approximateLastUsed | string | \[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, |
| description | string | The description of the filter. |
| editPermissions | array | The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter. |
| expand | string | Expand options that include additional filter details in the response. |
| favourite | boolean | Whether the filter is selected as a favorite by any users, not including the filter owner. |
| favouritedCount | integer | The count of how many users have selected this filter as a favorite, including the filter owner. |
| id | string | The unique identifier for the filter. |
| jql | string | The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. |
| name | string | The name of the filter. |
| owner | object | The user who owns the filter. Defaults to the creator of the filter, however, Jira administrators can change the owner of a shared filter in the admin settings. |
| searchUrl | string | 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, * |
| self | string | The URL of the filter. |
| sharePermissions | array | The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter. |
| subscriptions | array | The users that are subscribed to the filter. |
| viewUrl | string | 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*. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/FilterDetails",
"title": "FilterDetails",
"additionalProperties": false,
"description": "Details of 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": "The description of the filter.",
"type": "string"
},
"editPermissions": {
"description": "The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter.",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"type": "array"
},
"expand": {
"description": "Expand options that include additional filter details in the response.",
"readOnly": true,
"type": "string",
"xml": {
"attribute": true
}
},
"favourite": {
"description": "Whether the filter is selected as a favorite by any users, not including the filter owner.",
"readOnly": true,
"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*.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the filter.",
"type": "string"
},
"owner": {
"allOf": [
{
"$ref": "#/components/schemas/User"
}
],
"description": "The user who owns the filter. Defaults 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. This can be specified when updating a filter, but not when creating a filter.",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"type": "array"
},
"subscriptions": {
"description": "The users that are subscribed to the filter.",
"items": {
"$ref": "#/components/schemas/FilterSubscription"
},
"readOnly": true,
"type": "array"
},
"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"
}