Function RequestsApiFp

Returns {
    requestsCreateCancel(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    requestsList(
        action?: RequestsListActionEnum,
        filter?: string,
        format?: string,
        jobId?: number,
        org?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        sort?: string,
        status?: RequestsListStatusEnum,
        subresource?: RequestsListSubresourceEnum,
        target?: RequestsListTargetEnum,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedRequestList>,
    >;
    requestsRetrieve(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Request>,
    >;
}

• requestsCreateCancel:function

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

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• requestsList:function

  • requestsList(
        action?: RequestsListActionEnum,
        filter?: string,
        format?: string,
        jobId?: number,
        org?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        sort?: string,
        status?: RequestsListStatusEnum,
        subresource?: RequestsListSubresourceEnum,
        target?: RequestsListTargetEnum,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedRequestList>,
    >

    Parameters

    • Optionalaction: RequestsListActionEnum

      A simple equality filter for the action field
    • Optionalfilter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;status&#39;, &#39;project_id&#39;, &#39;task_id&#39;, &#39;job_id&#39;, &#39;action&#39;, &#39;target&#39;, &#39;subresource&#39;, &#39;format&#39;].
    • Optionalformat: string

      A simple equality filter for the format field
    • OptionaljobId: number

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

      A simple equality filter for the org field
    • Optionalpage: number

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

      Number of results to return per page.
    • OptionalprojectId: number

      A simple equality filter for the project_id field
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;created_date&#39;, &#39;status&#39;, &#39;action&#39;]
    • Optionalstatus: RequestsListStatusEnum

      A simple equality filter for the status field
    • Optionalsubresource: RequestsListSubresourceEnum

      A simple equality filter for the subresource field
    • Optionaltarget: RequestsListTargetEnum

      A simple equality filter for the target field
    • OptionaltaskId: number

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

      Override http request option.

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

    Throws

• requestsRetrieve:function

  • requestsRetrieve(
        id: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Request>,
    >

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws