Function ConsensusApiFp

Returns {
    consensusCreateMerge(
        rqId?: string,
        consensusMergeCreateRequest?: ConsensusMergeCreateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    consensusListSettings(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        sort?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedConsensusSettingsList>,
    >;
    consensusPartialUpdateSettings(
        id: number,
        patchedConsensusSettingsRequest?: PatchedConsensusSettingsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConsensusSettings>,
    >;
    consensusRetrieveSettings(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConsensusSettings>,
    >;
}

• consensusCreateMerge:function

  • consensusCreateMerge(
        rqId?: string,
        consensusMergeCreateRequest?: ConsensusMergeCreateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • OptionalrqId: string

      The consensus merge request id. Can be specified to check operation status.
    • OptionalconsensusMergeCreateRequest: ConsensusMergeCreateRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• consensusListSettings:function

  • consensusListSettings(
        xOrganization?: string,
        filter?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        sort?: string,
        taskId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedConsensusSettingsList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • 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;id&#39;, &#39;task_id&#39;].
    • 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.
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;id&#39;]
    • OptionaltaskId: number

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

      Override http request option.

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

    Throws

• consensusPartialUpdateSettings:function

  • consensusPartialUpdateSettings(
        id: number,
        patchedConsensusSettingsRequest?: PatchedConsensusSettingsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ConsensusSettings>,
    >

    Parameters

    • id: number

      An id of a consensus settings instance
    • OptionalpatchedConsensusSettingsRequest: PatchedConsensusSettingsRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• consensusRetrieveSettings:function

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

    Parameters

    • id: number

      An id of a consensus settings instance
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws