Function GuidesApiFactory

Returns {
    guidesCreate(requestParameters?, options?) => AxiosPromise<AnnotationGuideRead>;
    guidesDestroy(requestParameters, options?) => AxiosPromise<void>;
    guidesPartialUpdate(requestParameters, options?) => AxiosPromise<AnnotationGuideRead>;
    guidesRetrieve(requestParameters, options?) => AxiosPromise<AnnotationGuideRead>;
}

• guidesCreate:function

  • guidesCreate(requestParameters?, options?): AxiosPromise<AnnotationGuideRead>

  • Parameters

    • requestParameters: GuidesApiGuidesCreateRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Summary

    Method creates a new annotation guide binded to a project or to a task

    Throws

• guidesDestroy:function

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

  • Parameters

    • requestParameters: GuidesApiGuidesDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a specific annotation guide and all attached assets

    Throws

• guidesPartialUpdate:function

  • guidesPartialUpdate(requestParameters, options?): AxiosPromise<AnnotationGuideRead>

  • Parameters

    • requestParameters: GuidesApiGuidesPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Summary

    Methods does a partial update of chosen fields in an annotation guide

    Throws

• guidesRetrieve:function

  • guidesRetrieve(requestParameters, options?): AxiosPromise<AnnotationGuideRead>

  • Parameters

    • requestParameters: GuidesApiGuidesRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationGuideRead>

    Summary

    Method returns details of a specific annotation guide

    Throws