Interface TasksApiTasksListRequest

Request parameters for tasksList operation in TasksApi.

TasksApiTasksListRequest

interface TasksApiTasksListRequest {
    assignee?: string;
    dimension?: TasksListDimensionEnum;
    filter?: string;
    mode?: string;
    name?: string;
    org?: string;
    orgId?: number;
    owner?: string;
    page?: number;
    pageSize?: number;
    projectId?: number;
    projectName?: string;
    search?: string;
    sort?: string;
    status?: TasksListStatusEnum;
    subset?: string;
    trackerLink?: string;
    validationMode?: TasksListValidationModeEnum;
    xOrganization?: string;
}

Properties

assignee?: string

A simple equality filter for the assignee field

TasksApiTasksList

A simple equality filter for the dimension field

TasksApiTasksList

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;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]. There are few examples for complex filtering tasks: - Get all tasks from 1,2,3 projects - { &quot;and&quot; : [{ &quot;in&quot; : [{ &quot;var&quot; : &quot;project_id&quot; }, [1, 2, 3]]}]} - Get all completed tasks from 1 project - { &quot;and&quot;: [{ &quot;==&quot;: [{ &quot;var&quot; : &quot;status&quot; }, &quot;completed&quot;]}, { &quot;==&quot; : [{ &quot;var&quot; : &quot;project_id&quot;}, 1]}]}

TasksApiTasksList

mode?: string

A simple equality filter for the mode field

TasksApiTasksList

name?: string

A simple equality filter for the name field

TasksApiTasksList

org?: string

Organization unique slug

TasksApiTasksList

orgId?: number

Organization identifier

TasksApiTasksList

owner?: string

A simple equality filter for the owner field

TasksApiTasksList

page?: number

A page number within the paginated result set.

TasksApiTasksList

pageSize?: number

Number of results to return per page.

TasksApiTasksList

projectId?: number

A simple equality filter for the project_id field

TasksApiTasksList

projectName?: string

A simple equality filter for the project_name field

TasksApiTasksList

search?: string

A search term. Available search_fields: (&#39;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;)

TasksApiTasksList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]

TasksApiTasksList

A simple equality filter for the status field

TasksApiTasksList

subset?: string

A simple equality filter for the subset field

TasksApiTasksList

trackerLink?: string

A simple equality filter for the tracker_link field

TasksApiTasksList

A simple equality filter for the validation_mode field

TasksApiTasksList

xOrganization?: string

Organization unique slug

TasksApiTasksList