Class JobsApi

JobsApi - object-oriented interface

JobsApi

Hierarchy

  • BaseAPI
    • JobsApi

Constructors

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns JobsApi

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • The request POST /api/jobs/id/annotations initiates a background process to import annotations into a job. 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

    Returns Promise<AxiosResponse<void, any>>

    JobsApi

  • 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

    Returns Promise<AxiosResponse<RqId, any>>

    JobsApi

  • Related annotations will be deleted as well. Please note, that not every job can be removed. Currently, it is only available for Ground Truth jobs.

    Parameters

    • requestParameters: JobsApiJobsDestroyRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    JobsApi

  • If format is specified, a ZIP archive will be returned. Otherwise, the annotations will be returned as a JSON document. Deprecation warning: Utilizing this endpoint to export annotations as a dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_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

    Returns Promise<AxiosResponse<AnnotationsRead, any>>

    JobsApi

  • Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_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

    Returns Promise<AxiosResponse<File, any>>

    JobsApi

  • 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

    Returns Promise<AxiosResponse<void, any>>

    JobsApi

MMNEPVFCICPMFPCPTTAAATR