Variable HandleApiConst

Type declaration

• apiV2HandlesOptions:function

  • apiV2HandlesOptions(options?): AxiosPromise<void>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Responds with the HTTP methods allowed for the endpoint.

    Throws

• getHandle:function

  • getHandle(requestParameters, options?): AxiosPromise<HandleDtoResponse>

  • Required JWT roles for access: administrator.

    Parameters

    • requestParameters: HandleApiGetHandleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<HandleDtoResponse>

    Summary

    Retrieves all values of a handle by its PID.

    Throws

• updateHandle:function

  • updateHandle(requestParameters, options?): AxiosPromise<void>

  • Required JWT roles for access: administrator.

    Parameters

    • requestParameters: HandleApiUpdateHandleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Updates a handle.

    Throws