Function LabelsApiFp

Returns {
    labelsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    labelsList(
        xOrganization?: string,
        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,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedLabelList>,
    >;
    labelsPartialUpdate(
        id: number,
        patchedLabelRequest?: PatchedLabelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>,
    >;
    labelsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>,
    >;
}

• labelsDestroy:function

  • labelsDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    To delete a sublabel, please use the PATCH method of the parent label.

    Parameters

    • id: number

      A unique integer value identifying this label.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• labelsList:function

  • labelsList(
        xOrganization?: string,
        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,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedLabelList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalcolor: string

      A simple equality filter for the color field
    • Optionalfilter: 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;].
    • OptionaljobId: number

      A simple equality filter for job id
    • Optionalname: string

      A simple equality filter for the name field
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalparent: string

      A simple equality filter for the parent field
    • OptionalparentId: number

      A simple equality filter for the parent_id field
    • OptionalprojectId: number

      A simple equality filter for project id
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;name&#39;, &#39;parent&#39;)
    • Optionalsort: 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;]
    • OptionaltaskId: number

      A simple equality filter for task id
    • Optionaltype: LabelsListTypeEnum

      A simple equality filter for the type field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedLabelList>,
    >

    Throws

• labelsPartialUpdate:function

  • labelsPartialUpdate(
        id: number,
        patchedLabelRequest?: PatchedLabelRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>,
    >

    To modify a sublabel, please use the PATCH method of the parent label.

    Parameters

    • id: number

      A unique integer value identifying this label.
    • OptionalpatchedLabelRequest: PatchedLabelRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>

    Throws

• labelsRetrieve:function

  • labelsRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>,
    >

    Parameters

    • id: number

      A unique integer value identifying this label.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Label>>

    Throws