Function GuidesApiFp

Returns {
    guidesCreate(annotationGuideWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>;
    guidesDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    guidesPartialUpdate(id, patchedAnnotationGuideWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>;
    guidesRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>;
}

• guidesCreate:function

  • guidesCreate(annotationGuideWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

  • Parameters

    • Optional annotationGuideWriteRequest: AnnotationGuideWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

    Summary

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

    Throws

• guidesDestroy:function

  • guidesDestroy(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this annotation guide.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method deletes a specific annotation guide and all attached assets

    Throws

• guidesPartialUpdate:function

  • guidesPartialUpdate(id, patchedAnnotationGuideWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this annotation guide.

    • Optional patchedAnnotationGuideWriteRequest: PatchedAnnotationGuideWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

    Summary

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

    Throws

• guidesRetrieve:function

  • guidesRetrieve(id, options?): Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this annotation guide.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<AnnotationGuideRead>)>

    Summary

    Method returns details of a specific annotation guide

    Throws