Jira.js - Jira Cloud API library
    Preparing search index...

    Interface CreateFilter

    Details about a filter.

    interface CreateFilter {
        approximateLastUsed?: string;
        description?: string;
        editPermissions?: Version3Models.SharePermission[];
        expand?: string;
        favourite?: boolean;
        favouritedCount?: number;
        id?: string;
        jql?: string;
        name: string;
        overrideSharePermissions?: boolean;
        owner?: Version3Models.User;
        searchUrl?: string;
        self?: string;
        sharedUsers?: Version3Models.UserList;
        sharePermissions?: Version3Models.SharePermission[];
        subscriptions?: Version3Models.FilterSubscriptionsList;
        viewUrl?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approximateLastUsed? description? editPermissions? expand? favourite? favouritedCount? id? jql? name overrideSharePermissions? owner? searchUrl? self? sharedUsers? sharePermissions? subscriptions? viewUrl?

    Properties

    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, timestamps aren't updated in real time and therefore may not be exactly accurate.

    description?: string

    A description of the filter.

    editPermissions?: Version3Models.SharePermission[]

    The groups and projects that can edit the filter.

    expand?: string

    Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

    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]. 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].

    favourite?: boolean

    Whether the filter is selected as a favorite.

    favouritedCount?: number

    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. Must be unique.

    overrideSharePermissions?: boolean

    EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.

    owner?: Version3Models.User
    searchUrl?: string

    A URL to view the filter results in Jira, using the Search for issues using JQL 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_.

    self?: string

    The URL of the filter.

    sharedUsers?: Version3Models.UserList
    sharePermissions?: Version3Models.SharePermission[]

    The groups and projects that the filter is shared with.

    subscriptions?: Version3Models.FilterSubscriptionsList
    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_.

    Settings

    Member Visibility

    On This Page

    Properties