Function TasksApiAxiosParamCreator

Returns {
    jobsPartialUpdateDataMeta: ((id, patchedDataMetaWriteRequest?, options?) => Promise<RequestArgs>);
    tasksCreate: ((taskWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
    tasksCreateAnnotations: ((id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, taskAnnotationsWriteRequest?, options?) => Promise<RequestArgs>);
    tasksCreateBackup: ((xOrganization?, cloudStorageId?, filename?, location?, org?, orgId?, rqId?, taskFileRequest?, options?) => Promise<RequestArgs>);
    tasksCreateData: ((id, uploadFinish?, uploadMultiple?, uploadStart?, dataRequest?, options?) => Promise<RequestArgs>);
    tasksDestroy: ((id, options?) => Promise<RequestArgs>);
    tasksDestroyAnnotations: ((id, options?) => Promise<RequestArgs>);
    tasksList: ((xOrganization?, assignee?, dimension?, filter?, mode?, name?, org?, orgId?, owner?, page?, pageSize?, projectId?, projectName?, search?, sort?, status?, subset?, trackerLink?, options?) => Promise<RequestArgs>);
    tasksPartialUpdate: ((id, patchedTaskWriteRequest?, options?) => Promise<RequestArgs>);
    tasksPartialUpdateAnnotations: ((action, id, patchedLabeledDataRequest?, options?) => Promise<RequestArgs>);
    tasksPartialUpdateDataMeta: ((id, patchedDataMetaWriteRequest?, options?) => Promise<RequestArgs>);
    tasksRetrieve: ((id, options?) => Promise<RequestArgs>);
    tasksRetrieveAnnotations: ((id, action?, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>);
    tasksRetrieveBackup: ((id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>);
    tasksRetrieveData: ((id, number?, quality?, type?, options?) => Promise<RequestArgs>);
    tasksRetrieveDataMeta: ((id, options?) => Promise<RequestArgs>);
    tasksRetrieveDataset: ((format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>);
    tasksRetrievePreview: ((id, options?) => Promise<RequestArgs>);
    tasksRetrieveStatus: ((id, options?) => Promise<RequestArgs>);
    tasksUpdateAnnotations: ((id, format?, rqId?, taskAnnotationsUpdateRequest?, options?) => Promise<RequestArgs>);
}

• jobsPartialUpdateDataMeta: ((id, patchedDataMetaWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedDataMetaWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this job.

      • Optional patchedDataMetaWriteRequest: PatchedDataMetaWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksCreate: ((taskWriteRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)

  • • (taskWriteRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>

    • Parameters

      • taskWriteRequest: TaskWriteRequest

      • Optional xOrganization: string

        Organization unique slug

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksCreateAnnotations: ((id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, taskAnnotationsWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, taskAnnotationsWriteRequest?, options?): Promise<RequestArgs>

    • 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

      • id: number

        A unique integer value identifying this task.

      • Optional cloudStorageId: number

        Storage id

      • Optional filename: string

        Annotation file name

      • Optional format: string

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

      • Optional location: TasksCreateAnnotationsLocationEnum

        where to import the annotation from

      • Optional useDefaultLocation: boolean

        Use the location that was configured in task to import annotations

      • Optional taskAnnotationsWriteRequest: null | AnnotationFileRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksCreateBackup: ((xOrganization?, cloudStorageId?, filename?, location?, org?, orgId?, rqId?, taskFileRequest?, options?) => Promise<RequestArgs>)

  • • (xOrganization?, cloudStorageId?, filename?, location?, org?, orgId?, rqId?, taskFileRequest?, options?): Promise<RequestArgs>

    • 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

      • Optional xOrganization: string

        Organization unique slug

      • Optional cloudStorageId: number

        Storage id

      • Optional filename: string

        Backup file name

      • Optional location: TasksCreateBackupLocationEnum

        Where to import the backup file from

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional rqId: string

        rq id

      • Optional taskFileRequest: TaskFileRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method recreates a task from an attached task backup file

      Throws

• tasksCreateData: ((id, uploadFinish?, uploadMultiple?, uploadStart?, dataRequest?, options?) => Promise<RequestArgs>)

  • • (id, uploadFinish?, uploadMultiple?, uploadStart?, dataRequest?, options?): Promise<RequestArgs>

    • 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

      • id: number

        A unique integer value identifying this task.

      • Optional uploadFinish: boolean

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

      • Optional uploadMultiple: boolean

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

      • Optional uploadStart: boolean

        Initializes data upload. Optionally, can include upload metadata in the request body.

      • Optional dataRequest: DataRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksDestroy: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksDestroyAnnotations: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes all annotations for a specific task

      Throws

• tasksList: ((xOrganization?, assignee?, dimension?, filter?, mode?, name?, org?, orgId?, owner?, page?, pageSize?, projectId?, projectName?, search?, sort?, status?, subset?, trackerLink?, options?) => Promise<RequestArgs>)

  • • (xOrganization?, assignee?, dimension?, filter?, mode?, name?, org?, orgId?, owner?, page?, pageSize?, projectId?, projectName?, search?, sort?, status?, subset?, trackerLink?, options?): Promise<RequestArgs>

    • Parameters

      • Optional xOrganization: string

        Organization unique slug

      • Optional assignee: string

        A simple equality filter for the assignee field

      • Optional dimension: TasksListDimensionEnum

        A simple equality filter for the dimension field

      • Optional filter: 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;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]}]}

      • Optional mode: string

        A simple equality filter for the mode field

      • Optional name: string

        A simple equality filter for the name field

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional owner: string

        A simple equality filter for the owner field

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional projectId: number

        A simple equality filter for the project_id field

      • Optional projectName: string

        A simple equality filter for the project_name field

      • Optional search: 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;)

      • Optional sort: 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;id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;]

      • Optional status: TasksListStatusEnum

        A simple equality filter for the status field

      • Optional subset: string

        A simple equality filter for the subset field

      • Optional trackerLink: string

        A simple equality filter for the tracker_link field

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Returns a paginated list of tasks

      Throws

• tasksPartialUpdate: ((id, patchedTaskWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedTaskWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional patchedTaskWriteRequest: PatchedTaskWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Methods does a partial update of chosen fields in a task

      Throws

• tasksPartialUpdateAnnotations: ((action, id, patchedLabeledDataRequest?, options?) => Promise<RequestArgs>)

  • • (action, id, patchedLabeledDataRequest?, options?): Promise<RequestArgs>

    • Parameters

      • action: TasksPartialUpdateAnnotationsActionEnum

      • id: number

        A unique integer value identifying this task.

      • Optional patchedLabeledDataRequest: PatchedLabeledDataRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method performs a partial update of annotations in a specific task

      Throws

• tasksPartialUpdateDataMeta: ((id, patchedDataMetaWriteRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedDataMetaWriteRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional patchedDataMetaWriteRequest: PatchedDataMetaWriteRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksRetrieve: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns details of a specific task

      Throws

• tasksRetrieveAnnotations: ((id, action?, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>)

  • • (id, action?, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional action: "download"

        Used to start downloading process after annotation file had been created

      • Optional cloudStorageId: number

        Storage id

      • Optional filename: string

        Desired output file name

      • Optional format: string

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

      • Optional location: TasksRetrieveAnnotationsLocationEnum

        Where need to save downloaded dataset

      • Optional useDefaultLocation: boolean

        Use the location that was configured in the task to export annotation

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method allows to download task annotations

      Throws

• tasksRetrieveBackup: ((id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>)

  • • (id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional action: "download"

        Used to start downloading process after backup file had been created

      • Optional cloudStorageId: number

        Storage id

      • Optional filename: string

        Backup file name

      • Optional location: TasksRetrieveBackupLocationEnum

        Where need to save downloaded backup

      • Optional useDefaultLocation: boolean

        Use the location that was configured in the task to export backup

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method backup a specified task

      Throws

• tasksRetrieveData: ((id, number?, quality?, type?, options?) => Promise<RequestArgs>)

  • • (id, number?, quality?, type?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional number: number

        A unique number value identifying chunk or frame

      • Optional quality: TasksRetrieveDataQualityEnum

        Specifies the quality level of the requested data

      • Optional type: TasksRetrieveDataTypeEnum

        Specifies the type of the requested data

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns data for a specific task

      Throws

• tasksRetrieveDataMeta: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksRetrieveDataset: ((format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<RequestArgs>)

  • • (format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?): Promise<RequestArgs>

    • 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.

      • Optional action: "download"

        Used to start downloading process after annotation file had been created

      • Optional cloudStorageId: number

        Storage id

      • Optional filename: string

        Desired output file name

      • Optional location: TasksRetrieveDatasetLocationEnum

        Where need to save downloaded dataset

      • Optional useDefaultLocation: boolean

        Use the location that was configured in task to export annotations

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Export task as a dataset in a specific format

      Throws

• tasksRetrievePreview: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns a preview image for the task

      Throws

• tasksRetrieveStatus: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this task.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

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

      Throws

• tasksUpdateAnnotations: ((id, format?, rqId?, taskAnnotationsUpdateRequest?, options?) => Promise<RequestArgs>)

  • • (id, format?, rqId?, taskAnnotationsUpdateRequest?, options?): Promise<RequestArgs>

    • 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

      • id: number

        A unique integer value identifying this task.

      • Optional format: string

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

      • Optional rqId: string

        rq id

      • Optional taskAnnotationsUpdateRequest: null | TaskAnnotationsUpdateRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method allows to upload task annotations or edit existing annotations

      Throws