Function TasksApiFactory

Returns {
    jobsPartialUpdateDataMeta(requestParameters, options?) => AxiosPromise<DataMetaRead>;
    tasksCreate(requestParameters, options?) => AxiosPromise<TaskRead>;
    tasksCreateAnnotations(requestParameters, options?) => AxiosPromise<void>;
    tasksCreateBackup(requestParameters?, options?) => AxiosPromise<void>;
    tasksCreateData(requestParameters, options?) => AxiosPromise<void>;
    tasksDestroy(requestParameters, options?) => AxiosPromise<void>;
    tasksDestroyAnnotations(requestParameters, options?) => AxiosPromise<void>;
    tasksList(requestParameters?, options?) => AxiosPromise<PaginatedTaskReadList>;
    tasksPartialUpdate(requestParameters, options?) => AxiosPromise<TaskRead>;
    tasksPartialUpdateAnnotations(requestParameters, options?) => AxiosPromise<LabeledData>;
    tasksPartialUpdateDataMeta(requestParameters, options?) => AxiosPromise<DataMetaRead>;
    tasksRetrieve(requestParameters, options?) => AxiosPromise<TaskRead>;
    tasksRetrieveAnnotations(requestParameters, options?) => AxiosPromise<AnnotationsRead>;
    tasksRetrieveBackup(requestParameters, options?) => AxiosPromise<void>;
    tasksRetrieveData(requestParameters, options?) => AxiosPromise<void>;
    tasksRetrieveDataMeta(requestParameters, options?) => AxiosPromise<DataMetaRead>;
    tasksRetrieveDataset(requestParameters, options?) => AxiosPromise<File>;
    tasksRetrievePreview(requestParameters, options?) => AxiosPromise<void>;
    tasksRetrieveStatus(requestParameters, options?) => AxiosPromise<RqStatus>;
    tasksUpdateAnnotations(requestParameters, options?) => AxiosPromise<void>;
}

• jobsPartialUpdateDataMeta:function

  • jobsPartialUpdateDataMeta(requestParameters, options?): AxiosPromise<DataMetaRead>

  • Parameters

    • requestParameters: TasksApiJobsPartialUpdateDataMetaRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Summary

    Method provides a meta information about media files which are related with the job

    Throws

• tasksCreate:function

  • tasksCreate(requestParameters, options?): AxiosPromise<TaskRead>

  • Parameters

    • requestParameters: TasksApiTasksCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Summary

    Method creates a new task in a database without any attached images and videos

    Throws

• tasksCreateAnnotations:function

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

  • The request POST /api/tasks/id/annotations will initiate file upload and will create the rq job on the server in which the process of annotations uploading from file will be carried out. Please, use the PUT /api/tasks/id/annotations endpoint for checking status of the process.

    Parameters

    • requestParameters: TasksApiTasksCreateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method allows to initialize the process of upload task annotations from a local or a cloud storage file

    Throws

• tasksCreateBackup:function

  • tasksCreateBackup(requestParameters?, options?): 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

    • requestParameters: TasksApiTasksCreateBackupRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method recreates a task from an attached task backup file

    Throws

• tasksCreateData:function

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

  • Allows to upload data 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://opencv.github.io/cvat/docs/manual/advanced/dataset_manifest/ After all data is sent, the operation status can be retrieved via the /status endpoint.

    Parameters

    • requestParameters: TasksApiTasksCreateDataRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method permanently attaches data (images, video, etc.) to a task

    Throws

• tasksDestroy:function

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

  • Parameters

    • requestParameters: TasksApiTasksDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a specific task, all attached jobs, annotations, and data

    Throws

• tasksDestroyAnnotations:function

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

  • Parameters

    • requestParameters: TasksApiTasksDestroyAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes all annotations for a specific task

    Throws

• tasksList:function

  • tasksList(requestParameters?, options?): AxiosPromise<PaginatedTaskReadList>

  • Parameters

    • requestParameters: TasksApiTasksListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedTaskReadList>

    Summary

    Returns a paginated list of tasks

    Throws

• tasksPartialUpdate:function

  • tasksPartialUpdate(requestParameters, options?): AxiosPromise<TaskRead>

  • Parameters

    • requestParameters: TasksApiTasksPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Summary

    Methods does a partial update of chosen fields in a task

    Throws

• tasksPartialUpdateAnnotations:function

  • tasksPartialUpdateAnnotations(requestParameters, options?): AxiosPromise<LabeledData>

  • Parameters

    • requestParameters: TasksApiTasksPartialUpdateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<LabeledData>

    Summary

    Method performs a partial update of annotations in a specific task

    Throws

• tasksPartialUpdateDataMeta:function

  • tasksPartialUpdateDataMeta(requestParameters, options?): AxiosPromise<DataMetaRead>

  • Parameters

    • requestParameters: TasksApiTasksPartialUpdateDataMetaRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Summary

    Method provides a meta information about media files which are related with the task

    Throws

• tasksRetrieve:function

  • tasksRetrieve(requestParameters, options?): AxiosPromise<TaskRead>

  • Parameters

    • requestParameters: TasksApiTasksRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Summary

    Method returns details of a specific task

    Throws

• tasksRetrieveAnnotations:function

  • tasksRetrieveAnnotations(requestParameters, options?): AxiosPromise<AnnotationsRead>

  • Parameters

    • requestParameters: TasksApiTasksRetrieveAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Summary

    Method allows to download task annotations

    Throws

• tasksRetrieveBackup:function

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

  • Parameters

    • requestParameters: TasksApiTasksRetrieveBackupRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method backup a specified task

    Throws

• tasksRetrieveData:function

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

  • Parameters

    • requestParameters: TasksApiTasksRetrieveDataRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method returns data for a specific task

    Throws

• tasksRetrieveDataMeta:function

  • tasksRetrieveDataMeta(requestParameters, options?): AxiosPromise<DataMetaRead>

  • Parameters

    • requestParameters: TasksApiTasksRetrieveDataMetaRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Summary

    Method provides a meta information about media files which are related with the task

    Throws

• tasksRetrieveDataset:function

  • tasksRetrieveDataset(requestParameters, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: TasksApiTasksRetrieveDatasetRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Export task as a dataset in a specific format

    Throws

• tasksRetrievePreview:function

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

  • Parameters

    • requestParameters: TasksApiTasksRetrievePreviewRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method returns a preview image for the task

    Throws

• tasksRetrieveStatus:function

  • tasksRetrieveStatus(requestParameters, options?): AxiosPromise<RqStatus>

  • Parameters

    • requestParameters: TasksApiTasksRetrieveStatusRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<RqStatus>

    Summary

    When task is being created the method returns information about a status of the creation process

    Throws

• tasksUpdateAnnotations:function

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

  • To check the status of the process of uploading a task annotations from a file: After initiating the annotations upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent PUT /api/tasks/id/annotations requests to track the status of the annotations upload.

    Parameters

    • requestParameters: TasksApiTasksUpdateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method allows to upload task annotations or edit existing annotations

    Throws