Class Filters

Constructors

constructor

Properties

client

Methods

changeFilterOwner createFilter deleteFavouriteForFilter deleteFilter getColumns getFavouriteFilters getFilter getFiltersPaginated getMyFilters resetColumns setColumns setFavouriteForFilter updateFilter

Constructors

constructor

Properties

Private client

client: Client

Methods

changeFilterOwner

createFilter

deleteFavouriteForFilter

  • deleteFavouriteForFilter<T>(parameters, callback): Promise<void>

  • Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

    Permissions required: Permission to access Jira.

    Type Parameters

    Parameters

    Returns Promise<void>

  • deleteFavouriteForFilter<T>(parameters, callback?): Promise<T>

  • Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

    Permissions required: Permission to access Jira.

    Type Parameters

    Parameters

    Returns Promise<T>

deleteFilter

getColumns

  • getColumns<T>(parameters, callback): Promise<void>

  • Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

    This operation can be accessed anonymously.

    Permissions required: None, however, column details are only returned for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getColumns<T>(parameters, callback?): Promise<T>

  • Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in List View with the Columns set to Filter.

    This operation can be accessed anonymously.

    Permissions required: None, however, column details are only returned for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    Parameters

    Returns Promise<T>

getFavouriteFilters

  • getFavouriteFilters<T>(parameters, callback): Promise<void>

  • Returns the visible favorite filters of the user.

    This operation can be accessed anonymously.

    Permissions required: A favorite filter is only visible to the user where the filter is:

    • Owned by the user.
    • Shared with a group that the user is a member of.
    • Shared with a private project that the user has Browse projects project permission for.
    • Shared with a public project.
    • Shared with the public.

    For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getFavouriteFilters<T>(parameters?, callback?): Promise<T>

  • Returns the visible favorite filters of the user.

    This operation can be accessed anonymously.

    Permissions required: A favorite filter is only visible to the user where the filter is:

    • Owned by the user.
    • Shared with a group that the user is a member of.
    • Shared with a private project that the user has Browse projects project permission for.
    • Shared with a public project.
    • Shared with the public.

    For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

    Type Parameters

    Parameters

    Returns Promise<T>

getFilter

getFiltersPaginated

  • getFiltersPaginated<T>(parameters, callback): Promise<void>

  • Returns a paginated list of filters. Use this operation to get:

    • Specific filters, by defining id only.
    • Filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

    This operation can be accessed anonymously.

    Permissions required: None, however, only the following filters that match the query parameters are returned:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getFiltersPaginated<T>(parameters?, callback?): Promise<T>

  • Returns a paginated list of filters. Use this operation to get:

    • Specific filters, by defining id only.
    • Filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

    This operation can be accessed anonymously.

    Permissions required: None, however, only the following filters that match the query parameters are returned:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    Parameters

    Returns Promise<T>

getMyFilters

  • getMyFilters<T>(parameters, callback): Promise<void>

  • Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

    Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

    • Owned by the user.
    • Shared with a group that the user is a member of.
    • Shared with a private project that the user has Browse projects project permission for.
    • Shared with a public project.
    • Shared with the public.

    For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

    Type Parameters

    Parameters

    Returns Promise<void>

  • getMyFilters<T>(parameters?, callback?): Promise<T>

  • Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.

    Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

    • Owned by the user.
    • Shared with a group that the user is a member of.
    • Shared with a private project that the user has Browse projects project permission for.
    • Shared with a public project.
    • Shared with the public.

    For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

    Type Parameters

    Parameters

    Returns Promise<T>

resetColumns

  • resetColumns<T>(parameters, callback): Promise<void>

  • Reset the user's column configuration for the filter to the default.

    Permissions required: Permission to access Jira, however, columns are only reset for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • resetColumns<T>(parameters, callback?): Promise<T>

  • Reset the user's column configuration for the filter to the default.

    Permissions required: Permission to access Jira, however, columns are only reset for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

setColumns

  • setColumns<T>(parameters, callback): Promise<void>

  • Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

    The parameters for this resource are expressed as HTML form data. For example, in curl:

    curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

    Permissions required: Permission to access Jira, however, columns are only set for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

  • setColumns<T>(parameters, callback?): Promise<T>

  • Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.

    The parameters for this resource are expressed as HTML form data. For example, in curl:

    curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns

    Permissions required: Permission to access Jira, however, columns are only set for:

    • Filters owned by the user.
    • Filters shared with a group that the user is a member of.
    • Filters shared with a private project that the user has Browse projects project permission for.
    • Filters shared with a public project.
    • Filters shared with the public.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>

setFavouriteForFilter

updateFilter

Settings

Member Visibility

Theme

On This Page

constructorclientchangeFilterOwnercreateFilterdeleteFavouriteForFilterdeleteFiltergetColumnsgetFavouriteFiltersgetFiltergetFiltersPaginatedgetMyFiltersresetColumnssetColumnssetFavouriteForFilterupdateFilter