Interface JobsApiJobsListRequest

Request parameters for jobsList operation in JobsApi.

Export

JobsApiJobsListRequest

Hierarchy

  • JobsApiJobsListRequest

Properties

assignee? dimension? filter? org? orgId? page? pageSize? projectId? projectName? search? sort? stage? state? taskId? taskName? type? xOrganization?

Properties

Optional Readonly assignee

assignee?: string

A simple equality filter for the assignee field

Memberof

JobsApiJobsList

Optional Readonly dimension

dimension?: JobsListDimensionEnum

A simple equality filter for the dimension field

Memberof

JobsApiJobsList

Optional Readonly filter

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;].

Memberof

JobsApiJobsList

Optional Readonly org

org?: string

Organization unique slug

Memberof

JobsApiJobsList

Optional Readonly orgId

orgId?: number

Organization identifier

Memberof

JobsApiJobsList

Optional Readonly page

page?: number

A page number within the paginated result set.

Memberof

JobsApiJobsList

Optional Readonly pageSize

pageSize?: number

Number of results to return per page.

Memberof

JobsApiJobsList

Optional Readonly projectId

projectId?: number

A simple equality filter for the project_id field

Memberof

JobsApiJobsList

Optional Readonly projectName

projectName?: string

A simple equality filter for the project_name field

Memberof

JobsApiJobsList

Optional Readonly search

search?: string

A search term. Available search_fields: (&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;)

Memberof

JobsApiJobsList

Optional Readonly sort

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;]

Memberof

JobsApiJobsList

Optional Readonly stage

stage?: JobsListStageEnum

A simple equality filter for the stage field

Memberof

JobsApiJobsList

Optional Readonly state

state?: JobsListStateEnum

A simple equality filter for the state field

Memberof

JobsApiJobsList

Optional Readonly taskId

taskId?: number

A simple equality filter for the task_id field

Memberof

JobsApiJobsList

Optional Readonly taskName

taskName?: string

A simple equality filter for the task_name field

Memberof

JobsApiJobsList

Optional Readonly type

type?: JobsListTypeEnum

A simple equality filter for the type field

Memberof

JobsApiJobsList

Optional Readonly xOrganization

xOrganization?: string

Organization unique slug

Memberof

JobsApiJobsList

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc