Module: job_filter

Enumeration: TimeType

TODAY	1	Current day the filter is applied
THIS_WEEK	2	Current week the filter is applied (Sun - Sat)
FROM_TO	3	Specific date range

Struct: TimeRange

Key	Field	Type	Description	Requiredness	Default value
1	fromTime	i64	Inclusive >=	optional
2	toTime	i64	Exclusive < >	optional

Struct: JobTimeRange

Key	Field	Type	Description	Requiredness	Default value
1	timeType	TimeType		default
2	timeRange	TimeRange		optional

Struct: CommonFilterOpts

Key	Field	Type	Description	Requiredness	Default value
1	teamId	string	If unset, queries across all teams the user belongs to	optional
2	title	string	Substring text search on title	optional
3	states	list<job.JobState>	State match: issues do not have PLANNED state	optional
4	startedTime	JobTimeRange	Start time range	optional
5	completedTime	JobTimeRange	Completion time range	optional
6	sourceTemplateIds	list<string>	Templates created from	optional
7	allSourceTemplateIds	bool	Must have all sourceTemplateIds	optional
8	attributes	list<abac.AbacAttribute>	Filter based on attributes	optional

Struct: JobFilterJobOpts

Key	Field	Type	Description	Requiredness	Default value
1	opts	CommonFilterOpts		default
2	plannerId	string	Job planner user id	optional
3	jobMetadata	list<metadata.MetadataEntry>	Job metadata	optional
4	templateMetadata	list<metadata.MetadataEntry>	Template metadata on the job	optional

Struct: JobFilterIssueOpts

Key	Field	Type	Description	Requiredness	Default value
1	opts	CommonFilterOpts		default
2	creatorId	string	Issue creator id	optional
3	priorities	list<i32>	Issue priorities	optional
4	srcJobIds	list<string>	Source job ids issues are tied to	optional

Union: JobFilterOpts

Key	Field	Type	Description	Requiredness	Default value
1	jobOpts	JobFilterJobOpts		default
2	issueOpts	JobFilterIssueOpts		default

Struct: JobFilter

Key	Field	Type	Description	Requiredness	Default value
1	id	string	Unique filter id	default
2	name	string	Name for this filter	default
3	opts	JobFilterOpts	Filter options based on job type (Normal or Issue)	default
4	order	list<job.JobOrder>	Filter result order	default
5	position	i32	Position within the saved filter list for the user	default
6	updatedAt	i64	Last updated timestamp, only populated for fetch and ignored on update	optional

Struct: JobFilterQueryOpts

Key	Field	Type	Description	Requiredness	Default value
1	selectOpts	job.JobSelectOpts	See JobSelectOpts for job field selection	default
2	tzLocation	string	Client IANA time zone location, e.g. "America/Los_Angeles", defaults to "UTC"	optional
3	tzOffset	i64	Client time zone offset, in seconds east of UTC; only used when tzLocation is unset	optional
4	title	string	Further filter search results by job title/unique id	optional
10	pageReq	common.PageReq	See PageReq for page selection	optional
11	order	list<job.JobOrder>		optional

Function: JobFilterService.index

map<job.JobType, list<JobFilter>> index(set<job.JobType> jobTypes)
    throws common.SystemException

Return job filters for the current user, mapped by job types (job or issue)

Function: JobFilterService.get

JobFilter get(string filterId)
    throws common.SystemException

Get a single job filter based on id

Function: JobFilterService.add

list<JobFilter> add(JobFilter filter)
    throws common.SystemException

Add a new job filter for the current user filter.position = -1 appends to the end of the current list Returns the updated list of job filters NOTE: Each user can have a max of 15 filters per job type

Function: JobFilterService.update

list<JobFilter> update(JobFilter filter)
    throws common.SystemException

Update a job filter for the current user filter.position = -1 appends to the end of the current list Returns the updated list of job filters

Function: JobFilterService.remove

list<JobFilter> remove(string filterId)
    throws common.SystemException

Remove a new job filter for the current user Returns the updated list of job filters

Function: JobFilterService.query

job.JobQueryResult query(string filterId,
                         JobFilterQueryOpts queryOpts)
    throws common.SystemException

Query for jobs based on the saved job filter (by options and order) Returns job query result containing filtered jobs