Filters

A filter is a saved issue search. Jira users can search for issues using different criteria in basic or advanced search, and then save their results as a filter, becoming the filter’s owner. 
The owner can decide what to do with their filter—either make it private for personal use or share it with different entities, such as users, projects, or groups. If the filter is private, only the owner and Jira admin can view and modify it.
This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.
Create Filter
This method creates a new filter. The filter is shared according to the default share scope. The filter is not selected as a favorite, the method returns the following information:
package main
​
import (
	"context"
	"fmt"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"github.com/ctreminiom/go-atlassian/pkg/infra/models"
	"github.com/google/uuid"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	newFilterBody := models.FilterPayloadScheme{
		Name:        fmt.Sprintf("Filter #%v", uuid.New().String()),
		Description: "Filter's description",
		JQL:         "issuetype = Bug",
		Favorite:    false,
		SharePermissions: []*models.SharePermissionScheme{
			{
				Type: "project",
				Project: &models.ProjectScheme{
					ID: "10000",
				},
				Role:  nil,
				Group: nil,
			},
			{
				Type:  "group",
				Group: &models.GroupScheme{Name: "jira-administrators"},
			},
		},
	}
​
	filter, response, err := atlassian.Filter.Create(context.Background(), &newFilterBody)
	if err != nil {
		log.Fatal(err)
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Printf("The filter has been created: %v - %v", filter.ID, filter.Name)
}
​
Filter permissions on the UI interface
🧚‍♀️ Tips: You can extract the following struct tags
type FilterScheme struct {
	Self             string                    `json:"self,omitempty"`
	ID               string                    `json:"id,omitempty"`
	Name             string                    `json:"name,omitempty"`
	Owner            *UserScheme               `json:"owner,omitempty"`
	Jql              string                    `json:"jql,omitempty"`
	ViewURL          string                    `json:"viewUrl,omitempty"`
	SearchURL        string                    `json:"searchUrl,omitempty"`
	Favourite        bool                      `json:"favourite,omitempty"`
	FavouritedCount  int                       `json:"favouritedCount,omitempty"`
	SharePermissions []*SharePermissionScheme  `json:"sharePermissions,omitempty"`
	ShareUsers       *FilterUsersScheme        `json:"sharedUsers,omitempty"`
	Subscriptions    *FilterSubscriptionScheme `json:"subscriptions,omitempty"`
}
​
type FilterSubscriptionPageScheme struct {
	Size       int                         `json:"size,omitempty"`
	Items      []*FilterSubscriptionScheme `json:"items,omitempty"`
	MaxResults int                         `json:"max-results,omitempty"`
	StartIndex int                         `json:"start-index,omitempty"`
	EndIndex   int                         `json:"end-index,omitempty"`
}
​
type FilterSubscriptionScheme struct {
	ID    int          `json:"id,omitempty"`
	User  *UserScheme  `json:"user,omitempty"`
	Group *GroupScheme `json:"group,omitempty"`
}
​
type FilterUsersScheme struct {
	Size       int           `json:"size,omitempty"`
	Items      []*UserScheme `json:"items,omitempty"`
	MaxResults int           `json:"max-results,omitempty"`
	StartIndex int           `json:"start-index,omitempty"`
	EndIndex   int           `json:"end-index,omitempty"`
}
Get Favorites
This method returns the visible favorite filters of the user, the method returns the following information:
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	filters, response, err := atlassian.Filter.Favorite(context.Background())
	if err != nil {
		return
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Println("favorite filters", len(filters))
​
	for _, filter := range filters {
		log.Println(filter)
	}
​
}
​
Get My Filters
Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned, the method returns the following information:
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		log.Fatal(err)
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	myFilters, response, err := atlassian.Filter.My(context.Background(), false, []string{"sharedUsers", "subscriptions"})
	if err != nil {
		log.Fatal(err)
	}
​
	log.Println("Response HTTP Code", response.Code)
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Println("my filters", len(myFilters))
​
	for _, filter := range myFilters {
		log.Println(filter.ID)
​
		for _, shareUser := range filter.ShareUsers.Items {
			log.Println(shareUser.Name, shareUser.DisplayName)
		}
​
		for _, subscription := range filter.Subscriptions.Items {
			log.Println(subscription.ID)
		}
​
	}
​
}
Search Filters
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.
🔒 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.
package main
​
import (
	"context"
		"github.com/ctreminiom/go-atlassian/jira/v2"
	"github.com/ctreminiom/go-atlassian/pkg/infra/models"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	options := models.FilterSearchOptionScheme{
		Name:      "",
		AccountID: "",
		Group:     "",
		ProjectID: 0,
		IDs:       nil,
		OrderBy:   "description",
		Expand:    nil,
	}
​
	filters, response, err := atlassian.Filter.Search(context.Background(), &options, 0, 10)
	if err != nil {
		if response != nil {
			log.Println("HTTP Endpoint Used", response.Endpoint)
		}
		return
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Println("Filters found", len(filters.Values))
}
​
Get Filter
This method returns a filter using the ID as a parameter, the method returns the following information:
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	filter, response, err := atlassian.Filter.Get(context.Background(), 1, nil)
	if err != nil {
		log.Fatal(err)
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Println("Get Filter result", filter.Name, filter.Name)
}
​
🧚‍♀️ Tips: You can extract the following struct tags
type FilterScheme struct {
	Self             string                    `json:"self,omitempty"`
	ID               string                    `json:"id,omitempty"`
	Name             string                    `json:"name,omitempty"`
	Owner            *UserScheme               `json:"owner,omitempty"`
	Jql              string                    `json:"jql,omitempty"`
	ViewURL          string                    `json:"viewUrl,omitempty"`
	SearchURL        string                    `json:"searchUrl,omitempty"`
	Favourite        bool                      `json:"favourite,omitempty"`
	FavouritedCount  int                       `json:"favouritedCount,omitempty"`
	SharePermissions []*SharePermissionScheme  `json:"sharePermissions,omitempty"`
	ShareUsers       *FilterUsersScheme        `json:"sharedUsers,omitempty"`
	Subscriptions    *FilterSubscriptionScheme `json:"subscriptions,omitempty"`
}
​
type FilterSubscriptionPageScheme struct {
	Size       int                         `json:"size,omitempty"`
	Items      []*FilterSubscriptionScheme `json:"items,omitempty"`
	MaxResults int                         `json:"max-results,omitempty"`
	StartIndex int                         `json:"start-index,omitempty"`
	EndIndex   int                         `json:"end-index,omitempty"`
}
​
type FilterSubscriptionScheme struct {
	ID    int          `json:"id,omitempty"`
	User  *UserScheme  `json:"user,omitempty"`
	Group *GroupScheme `json:"group,omitempty"`
}
​
type FilterUsersScheme struct {
	Size       int           `json:"size,omitempty"`
	Items      []*UserScheme `json:"items,omitempty"`
	MaxResults int           `json:"max-results,omitempty"`
	StartIndex int           `json:"start-index,omitempty"`
	EndIndex   int           `json:"end-index,omitempty"`
}
Update Filter
This method updates a filter. Use this operation to update a filter's name, description, JQL, or sharing, the method returns the following information:
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"github.com/ctreminiom/go-atlassian/pkg/infra/models"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	payload := models.FilterPayloadScheme{
		JQL: "issuetype = Story",
	}
​
	filter, response, err := atlassian.Filter.Update(context.Background(), 1, &payload)
	if err != nil {
		return
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
	log.Println("new JQL filter value", filter.Jql)
}
​
Delete Filter
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	response, err := atlassian.Filter.Delete(context.Background(), 1)
	if err != nil {
		return
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
}
Change filter owner
The Jira Cloud platform REST API
Official Documentation
Changes the owner of the filter.
package main
​
import (
	"context"
	"github.com/ctreminiom/go-atlassian/jira/v2"
	"log"
	"os"
)
​
func main() {
​
	var (
		host  = os.Getenv("HOST")
		mail  = os.Getenv("MAIL")
		token = os.Getenv("TOKEN")
	)
​
	atlassian, err := v2.New(nil, host)
	if err != nil {
		return
	}
​
	atlassian.Auth.SetBasicAuth(mail, token)
​
	response, err := atlassian.Filter.Change(context.Background(), 1, "asda03333")
	if err != nil {
		return
	}
​
	log.Println("HTTP Endpoint Used", response.Endpoint)
}gg
Jira Software Cloud - Previous
Dashboards
Sharing
Last modified 4mo ago
Export as PDF
Copy link
On this page
Create Filter
Get Favorites
Get My Filters
Search Filters
Get Filter
Update Filter
Delete Filter
Change filter owner