Interface JobsApiJobsListRequest

Request parameters for jobsList operation in JobsApi.

JobsApiJobsListRequest

interface JobsApiJobsListRequest {
    assignee?: string;
    dimension?: JobsListDimensionEnum;
    filter?: string;
    org?: string;
    orgId?: number;
    page?: number;
    pageSize?: number;
    parentJobId?: number;
    projectId?: number;
    projectName?: string;
    search?: string;
    sort?: string;
    stage?: JobsListStageEnum;
    state?: JobsListStateEnum;
    taskId?: number;
    taskName?: string;
    type?: JobsListTypeEnum;
    xOrganization?: string;
}

Properties

assignee?: string

A simple equality filter for the assignee field

JobsApiJobsList

A simple equality filter for the dimension field

JobsApiJobsList

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;, &#39;parent_job_id&#39;].

JobsApiJobsList

org?: string

Organization unique slug

JobsApiJobsList

orgId?: number

Organization identifier

JobsApiJobsList

page?: number

A page number within the paginated result set.

JobsApiJobsList

pageSize?: number

Number of results to return per page.

JobsApiJobsList

parentJobId?: number

A simple equality filter for the parent_job_id field

JobsApiJobsList

projectId?: number

A simple equality filter for the project_id field

JobsApiJobsList

projectName?: string

A simple equality filter for the project_name field

JobsApiJobsList

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;)

JobsApiJobsList

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;, &#39;parent_job_id&#39;]

JobsApiJobsList

A simple equality filter for the stage field

JobsApiJobsList

A simple equality filter for the state field

JobsApiJobsList

taskId?: number

A simple equality filter for the task_id field

JobsApiJobsList

taskName?: string

A simple equality filter for the task_name field

JobsApiJobsList

A simple equality filter for the type field

JobsApiJobsList

xOrganization?: string

Organization unique slug

JobsApiJobsList