Function TasksApiFp

Returns {
    tasksCreate(
        taskWriteRequest: TaskWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRead>,
    >;
    tasksCreateAnnotations(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: TasksCreateAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        taskAnnotationsWriteRequest?: null | AnnotationFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksCreateBackup(
        xOrganization?: string,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateBackupLocationEnum,
        org?: string,
        orgId?: number,
        rqId?: string,
        taskFileRequest?: TaskFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksCreateBackupExport(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateBackupExportLocationEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>,
    >;
    tasksCreateData(
        id: number,
        uploadFinish?: boolean,
        uploadMultiple?: boolean,
        uploadStart?: boolean,
        dataRequest?: DataRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DataResponse>,
    >;
    tasksCreateDatasetExport(
        format: string,
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateDatasetExportLocationEnum,
        saveImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>,
    >;
    tasksDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksDestroyAnnotations(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksList(
        xOrganization?: string,
        assignee?: string,
        dimension?: TasksListDimensionEnum,
        filter?: string,
        mode?: string,
        name?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        projectName?: string,
        search?: string,
        sort?: string,
        status?: TasksListStatusEnum,
        subset?: string,
        trackerLink?: string,
        validationMode?: TasksListValidationModeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedTaskReadList>,
    >;
    tasksPartialUpdate(
        id: number,
        patchedTaskWriteRequest?: PatchedTaskWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRead>,
    >;
    tasksPartialUpdateAnnotations(
        action: TasksPartialUpdateAnnotationsActionEnum,
        id: number,
        patchedLabeledDataRequest?: PatchedLabeledDataRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LabeledData>,
    >;
    tasksPartialUpdateDataMeta(
        id: number,
        patchedDataMetaWriteRequest?: PatchedDataMetaWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DataMetaRead>,
    >;
    tasksPartialUpdateValidationLayout(
        id: number,
        patchedTaskValidationLayoutWriteRequest?: PatchedTaskValidationLayoutWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TaskValidationLayoutRead>,
    >;
    tasksRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRead>,
    >;
    tasksRetrieveAnnotations(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: TasksRetrieveAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationsRead>,
    >;
    tasksRetrieveBackup(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: TasksRetrieveBackupLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksRetrieveData(
        id: number,
        number?: number,
        quality?: TasksRetrieveDataQualityEnum,
        type?: TasksRetrieveDataTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksRetrieveDataMeta(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<DataMetaRead>,
    >;
    tasksRetrieveDataset(
        format: string,
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: TasksRetrieveDatasetLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
    >;
    tasksRetrievePreview(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    tasksRetrieveStatus(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqStatus>,
    >;
    tasksRetrieveValidationLayout(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TaskValidationLayoutRead>,
    >;
    tasksUpdateAnnotations(
        id: number,
        format?: string,
        rqId?: string,
        taskAnnotationsUpdateRequest?: null | TaskAnnotationsUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• tasksCreate:function

  • tasksCreate(
        taskWriteRequest: TaskWriteRequest,
        xOrganization?: string,
        org?: string,
        orgId?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRead>,
    >

    The new task will not have any attached images or videos. To attach them, use the /api/tasks//data endpoint.

    Parameters

    • taskWriteRequest: TaskWriteRequest
    • OptionalxOrganization: string

      Organization unique slug
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksCreateAnnotations:function

  • tasksCreateAnnotations(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: TasksCreateAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        taskAnnotationsWriteRequest?: null | AnnotationFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    The request POST /api/tasks/id/annotations initiates a background process to import annotations into a task. Please, use the GET /api/requests/<rq_id> endpoint for checking status of the process. The rq_id parameter can be found in the response on initiating request.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Annotation file name
    • Optionalformat: string

      Input format name You can get the list of supported formats at: /server/annotation/formats
    • Optionallocation: TasksCreateAnnotationsLocationEnum

      where to import the annotation from
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in task to import annotations
    • OptionaltaskAnnotationsWriteRequest: null | AnnotationFileRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksCreateBackup:function

  • tasksCreateBackup(
        xOrganization?: string,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateBackupLocationEnum,
        org?: string,
        orgId?: number,
        rqId?: string,
        taskFileRequest?: TaskFileRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    The backup import process is as follows: The first request POST /api/tasks/backup will initiate file upload and will create the rq job on the server in which the process of a task creating from an uploaded backup will be carried out. After initiating the backup upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent requests to track the status of the task creation. Once the task has been successfully created, the server will return the id of the newly created task.

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: TasksCreateBackupLocationEnum

      Where to import the backup file from
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • OptionalrqId: string

      rq id
    • OptionaltaskFileRequest: TaskFileRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksCreateBackupExport:function

  • tasksCreateBackupExport(
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateBackupExportLocationEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>>

    The request POST /api/<projects|tasks>/id/backup/export will initialize a background process to backup a resource. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: TasksCreateBackupExportLocationEnum

      Where need to save downloaded backup
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksCreateData:function

  • tasksCreateData(
        id: number,
        uploadFinish?: boolean,
        uploadMultiple?: boolean,
        uploadStart?: boolean,
        dataRequest?: DataRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataResponse>,
    >

    Allows to upload data (images, video, etc.) to a task. Supports the TUS open file uploading protocol (https://tus.io/). Supports the following protocols: 1. A single Data request and 2.1. An Upload-Start request 2.2.a. Regular TUS protocol requests (Upload-Length + Chunks) 2.2.b. Upload-Multiple requests 2.3. An Upload-Finish request Requests: - Data - POST, no extra headers or 'Upload-Start' + 'Upload-Finish' headers. Contains data in the body. - Upload-Start - POST, has an 'Upload-Start' header. No body is expected. - Upload-Length - POST, has an 'Upload-Length' header (see the TUS specification) - Chunk - HEAD/PATCH (see the TUS specification). Sent to /data/ endpoints. - Upload-Finish - POST, has an 'Upload-Finish' header. Can contain data in the body. - Upload-Multiple - POST, has an 'Upload-Multiple' header. Contains data in the body. The 'Upload-Finish' request allows to specify the uploaded files should be ordered. This may be needed if the files can be sent unordered. To state that the input files are sent ordered, pass an empty list of files in the 'upload_file_order' field. If the files are sent unordered, the ordered file list is expected in the 'upload_file_order' field. It must be a list of string file paths, relative to the dataset root. Example: files = [ "cats/cat_1.jpg", "dogs/dog2.jpg", "image_3.png", ... ] Independently of the file declaration field used ('client_files', 'server_files', etc.), when the 'predefined' sorting method is selected, the uploaded files will be ordered according to the '.jsonl' manifest file, if it is found in the list of files. For archives (e.g. '.zip'), a manifest file ('*.jsonl') is required when using the 'predefined' file ordering. Such file must be provided next to the archive in the list of files. Read more about manifest files here: https://docs.cvat.ai/docs/manual/advanced/dataset_manifest/ After all data is sent, the operation status can be retrieved via the GET /api/requests/<rq_id>, where rq_id is request ID returned for this request. Once data is attached to a task, it cannot be detached or replaced.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionaluploadFinish: boolean

      Finishes data upload. Can be combined with Upload-Start header to create task data with one request
    • OptionaluploadMultiple: boolean

      Indicates that data with this request are single or multiple files that should be attached to a task
    • OptionaluploadStart: boolean

      Initializes data upload. Optionally, can include upload metadata in the request body.
    • OptionaldataRequest: DataRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksCreateDatasetExport:function

  • tasksCreateDatasetExport(
        format: string,
        id: number,
        cloudStorageId?: number,
        filename?: string,
        location?: TasksCreateDatasetExportLocationEnum,
        saveImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RqId>>

    The request POST /api/<projects|tasks|jobs>/id/dataset/export will initialize a background process to export a dataset. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • id: number

      A unique integer value identifying this task.
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: TasksCreateDatasetExportLocationEnum

      Where need to save downloaded dataset
    • OptionalsaveImages: boolean

      Include images or not
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksDestroy:function

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

    All attached jobs, annotations and data will be deleted as well.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksDestroyAnnotations:function

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

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksList:function

  • tasksList(
        xOrganization?: string,
        assignee?: string,
        dimension?: TasksListDimensionEnum,
        filter?: string,
        mode?: string,
        name?: string,
        org?: string,
        orgId?: number,
        owner?: string,
        page?: number,
        pageSize?: number,
        projectId?: number,
        projectName?: string,
        search?: string,
        sort?: string,
        status?: TasksListStatusEnum,
        subset?: string,
        trackerLink?: string,
        validationMode?: TasksListValidationModeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedTaskReadList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalassignee: string

      A simple equality filter for the assignee field
    • Optionaldimension: TasksListDimensionEnum

      A simple equality filter for the dimension field
    • 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;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]. There are few examples for complex filtering tasks: - Get all tasks from 1,2,3 projects - { &quot;and&quot; : [{ &quot;in&quot; : [{ &quot;var&quot; : &quot;project_id&quot; }, [1, 2, 3]]}]} - Get all completed tasks from 1 project - { &quot;and&quot;: [{ &quot;==&quot;: [{ &quot;var&quot; : &quot;status&quot; }, &quot;completed&quot;]}, { &quot;==&quot; : [{ &quot;var&quot; : &quot;project_id&quot;}, 1]}]}
    • Optionalmode: string

      A simple equality filter for the mode field
    • Optionalname: string

      A simple equality filter for the name field
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalowner: string

      A simple equality filter for the owner field
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • OptionalprojectId: number

      A simple equality filter for the project_id field
    • OptionalprojectName: string

      A simple equality filter for the project_name field
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;)
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;project_name&#39;, &#39;name&#39;, &#39;owner&#39;, &#39;status&#39;, &#39;assignee&#39;, &#39;subset&#39;, &#39;mode&#39;, &#39;dimension&#39;, &#39;tracker_link&#39;, &#39;validation_mode&#39;, &#39;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]
    • Optionalstatus: TasksListStatusEnum

      A simple equality filter for the status field
    • Optionalsubset: string

      A simple equality filter for the subset field
    • OptionaltrackerLink: string

      A simple equality filter for the tracker_link field
    • OptionalvalidationMode: TasksListValidationModeEnum

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

      Override http request option.

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

    Throws

• tasksPartialUpdate:function

  • tasksPartialUpdate(
        id: number,
        patchedTaskWriteRequest?: PatchedTaskWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionalpatchedTaskWriteRequest: PatchedTaskWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksPartialUpdateAnnotations:function

  • tasksPartialUpdateAnnotations(
        action: TasksPartialUpdateAnnotationsActionEnum,
        id: number,
        patchedLabeledDataRequest?: PatchedLabeledDataRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<LabeledData>,
    >

    Parameters

    • action: TasksPartialUpdateAnnotationsActionEnum
    • id: number

      A unique integer value identifying this task.
    • OptionalpatchedLabeledDataRequest: PatchedLabeledDataRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksPartialUpdateDataMeta:function

  • tasksPartialUpdateDataMeta(
        id: number,
        patchedDataMetaWriteRequest?: PatchedDataMetaWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataMetaRead>,
    >

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionalpatchedDataMetaWriteRequest: PatchedDataMetaWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksPartialUpdateValidationLayout:function

  • tasksPartialUpdateValidationLayout(
        id: number,
        patchedTaskValidationLayoutWriteRequest?: PatchedTaskValidationLayoutWriteRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<TaskValidationLayoutRead>,
    >

    WARNING: this operation is not protected from race conditions. It's up to the user to ensure no parallel calls to this operation happen. It affects image access, including exports with images, backups, chunk downloading etc.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • OptionalpatchedTaskValidationLayoutWriteRequest: PatchedTaskValidationLayoutWriteRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieve:function

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

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveAnnotations:function

  • tasksRetrieveAnnotations(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        format?: string,
        location?: TasksRetrieveAnnotationsLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AnnotationsRead>,
    >

    Deprecation warning: Utilizing this endpoint ot export annotations as a dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/dataset/export?save_images=False to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionalaction: "download"

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionalformat: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • Optionallocation: TasksRetrieveAnnotationsLocationEnum

      Where need to save downloaded dataset
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the task to export annotation
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveBackup:function

  • tasksRetrieveBackup(
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: TasksRetrieveBackupLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/backup/export to initiate backup process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request'

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionalaction: "download"

      Used to start downloading process after backup file had been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Backup file name
    • Optionallocation: TasksRetrieveBackupLocationEnum

      Where need to save downloaded backup
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in the task to export backup
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveData:function

  • tasksRetrieveData(
        id: number,
        number?: number,
        quality?: TasksRetrieveDataQualityEnum,
        type?: TasksRetrieveDataTypeEnum,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionalnumber: number

      A unique number value identifying chunk or frame
    • Optionalquality: TasksRetrieveDataQualityEnum

      Specifies the quality level of the requested data
    • Optionaltype: TasksRetrieveDataTypeEnum

      Specifies the type of the requested data
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveDataMeta:function

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

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveDataset:function

  • tasksRetrieveDataset(
        format: string,
        id: number,
        action?: "download",
        cloudStorageId?: number,
        filename?: string,
        location?: TasksRetrieveDatasetLocationEnum,
        useDefaultLocation?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

    Deprecation warning: Utilizing this endpoint to export task dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/dataset/export?save_images=True to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • format: string

      Desired output format name You can get the list of supported formats at: /server/annotation/formats
    • id: number

      A unique integer value identifying this task.
    • Optionalaction: "download"

      Used to start downloading process locally after annotation file has been created
    • OptionalcloudStorageId: number

      Storage id
    • Optionalfilename: string

      Desired output file name
    • Optionallocation: TasksRetrieveDatasetLocationEnum

      Where need to save downloaded dataset
    • OptionaluseDefaultLocation: boolean

      Use the location that was configured in task to export annotations
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrievePreview:function

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

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksRetrieveStatus:function

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

    This method is deprecated and will be removed in one of the next releases. To check status of task creation, use new common API for managing background operations: GET /api/requests/?action=create&task_id=<task_id>

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Deprecated

    Throws

• tasksRetrieveValidationLayout:function

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

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• tasksUpdateAnnotations:function

  • tasksUpdateAnnotations(
        id: number,
        format?: string,
        rqId?: string,
        taskAnnotationsUpdateRequest?: null | TaskAnnotationsUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Utilizing this endpoint to check status of the import process is deprecated in favor of the new requests API: GET /api/requests/<rq_id>, where rq_id parameter is returned in the response on initializing request.

    Parameters

    • id: number

      A unique integer value identifying this task.
    • Optionalformat: string

      Input format name You can get the list of supported formats at: /server/annotation/formats
    • OptionalrqId: string

      rq id
    • OptionaltaskAnnotationsUpdateRequest: null | TaskAnnotationsUpdateRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws