Interface LabelsApiLabelsListRequest

Request parameters for labelsList operation in LabelsApi.

LabelsApiLabelsListRequest

interface LabelsApiLabelsListRequest {
    color?: string;
    filter?: string;
    jobId?: number;
    name?: string;
    org?: string;
    orgId?: number;
    page?: number;
    pageSize?: number;
    parent?: string;
    parentId?: number;
    projectId?: number;
    search?: string;
    sort?: string;
    taskId?: number;
    type?: LabelsListTypeEnum;
    xOrganization?: string;
}

Properties

color?: string

A simple equality filter for the color field

LabelsApiLabelsList

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;name&#39;, &#39;parent&#39;, &#39;id&#39;, &#39;type&#39;, &#39;color&#39;, &#39;parent_id&#39;].

LabelsApiLabelsList

jobId?: number

A simple equality filter for job id

LabelsApiLabelsList

name?: string

A simple equality filter for the name field

LabelsApiLabelsList

org?: string

Organization unique slug

LabelsApiLabelsList

orgId?: number

Organization identifier

LabelsApiLabelsList

page?: number

A page number within the paginated result set.

LabelsApiLabelsList

pageSize?: number

Number of results to return per page.

LabelsApiLabelsList

parent?: string

A simple equality filter for the parent field

LabelsApiLabelsList

parentId?: number

A simple equality filter for the parent_id field

LabelsApiLabelsList

projectId?: number

A simple equality filter for project id

LabelsApiLabelsList

search?: string

A search term. Available search_fields: (&#39;name&#39;, &#39;parent&#39;)

LabelsApiLabelsList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;name&#39;, &#39;parent&#39;, &#39;id&#39;, &#39;type&#39;, &#39;color&#39;, &#39;parent_id&#39;]

LabelsApiLabelsList

taskId?: number

A simple equality filter for task id

LabelsApiLabelsList

A simple equality filter for the type field

LabelsApiLabelsList

xOrganization?: string

Organization unique slug

LabelsApiLabelsList