Function VariableApiFactory

Returns {
    variableControllerCreate(
        variableCreateDTO?: VariableCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>;
    variableControllerDelete(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    variableControllerFindOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>;
    variableControllerSearch(
        variableSearchInputDTO?: VariableSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputArrayDTOAPI>;
    variableControllerUpdate(
        id: string,
        variableUpdateDTO?: VariableUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>;
}

• variableControllerCreate: function

  • variableControllerCreate(
        variableCreateDTO?: VariableCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>

    Required permissions: MANAGE_VARIABLES
    OperationId: VariableControllerCreate

    Parameters

    • OptionalvariableCreateDTO: VariableCreateDTO

      VariableCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VariableOutputDTOAPI>

    Throws

• variableControllerDelete: function

  • variableControllerDelete(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_VARIABLES
    OperationId: VariableControllerDelete

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• variableControllerFindOne: function

  • variableControllerFindOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>

    Required permissions: READ_VARIABLES
    OperationId: VariableControllerFindOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VariableOutputDTOAPI>

    Throws

• variableControllerSearch: function

  • variableControllerSearch(
        variableSearchInputDTO?: VariableSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputArrayDTOAPI>

    Search variables Required permissions: READ_VARIABLES
    OperationId: VariableControllerSearch

    Parameters

    • OptionalvariableSearchInputDTO: VariableSearchInputDTO

      VariableSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VariableOutputArrayDTOAPI>

    Throws

• variableControllerUpdate: function

  • variableControllerUpdate(
        id: string,
        variableUpdateDTO?: VariableUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VariableOutputDTOAPI>

    Required permissions: MANAGE_VARIABLES
    OperationId: VariableControllerUpdate

    Parameters

    • id: string
    • OptionalvariableUpdateDTO: VariableUpdateDTO

      VariableUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<VariableOutputDTOAPI>

    Throws