Function JobsApiFactory

Returns {
    jobsCreate(requestParameters, options?) => AxiosPromise<JobRead>;
    jobsCreateAnnotations(requestParameters, options?) => AxiosPromise<void>;
    jobsDestroy(requestParameters, options?) => AxiosPromise<void>;
    jobsDestroyAnnotations(requestParameters, options?) => AxiosPromise<void>;
    jobsList(requestParameters?, options?) => AxiosPromise<PaginatedJobReadList>;
    jobsPartialUpdate(requestParameters, options?) => AxiosPromise<JobRead>;
    jobsPartialUpdateAnnotations(requestParameters, options?) => AxiosPromise<void>;
    jobsRetrieve(requestParameters, options?) => AxiosPromise<JobRead>;
    jobsRetrieveAnnotations(requestParameters, options?) => AxiosPromise<AnnotationsRead>;
    jobsRetrieveData(requestParameters, options?) => AxiosPromise<File>;
    jobsRetrieveDataMeta(requestParameters, options?) => AxiosPromise<DataMetaRead>;
    jobsRetrieveDataset(requestParameters, options?) => AxiosPromise<File>;
    jobsRetrievePreview(requestParameters, options?) => AxiosPromise<void>;
    jobsUpdateAnnotations(requestParameters, options?) => AxiosPromise<void>;
}

• jobsCreate:function

  • jobsCreate(requestParameters, options?): AxiosPromise<JobRead>

  • Parameters

    • requestParameters: JobsApiJobsCreateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<JobRead>

    Summary

    Method creates a new job in the task

    Throws

• jobsCreateAnnotations:function

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

  • The request POST /api/jobs/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/jobs/id/annotations endpoint for checking status of the process.

    Parameters

    • requestParameters: JobsApiJobsCreateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method allows to initialize the process of the job annotation upload from a local file or a cloud storage

    Throws

• jobsDestroy:function

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

  • Please note, that not every job can be removed. Currently, it is only available for Ground Truth jobs.

    Parameters

    • requestParameters: JobsApiJobsDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a job and its related annotations

    Throws

• jobsDestroyAnnotations:function

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

  • Parameters

    • requestParameters: JobsApiJobsDestroyAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes all annotations for a specific job

    Throws

• jobsList:function

  • jobsList(requestParameters?, options?): AxiosPromise<PaginatedJobReadList>

  • Parameters

    • requestParameters: JobsApiJobsListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedJobReadList>

    Summary

    Method returns a paginated list of jobs

    Throws

• jobsPartialUpdate:function

  • jobsPartialUpdate(requestParameters, options?): AxiosPromise<JobRead>

  • Parameters

    • requestParameters: JobsApiJobsPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<JobRead>

    Summary

    Methods does a partial update of chosen fields in a job

    Throws

• jobsPartialUpdateAnnotations:function

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

  • Parameters

    • requestParameters: JobsApiJobsPartialUpdateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method performs a partial update of annotations in a specific job

    Throws

• jobsRetrieve:function

  • jobsRetrieve(requestParameters, options?): AxiosPromise<JobRead>

  • Parameters

    • requestParameters: JobsApiJobsRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<JobRead>

    Summary

    Method returns details of a job

    Throws

• jobsRetrieveAnnotations:function

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

  • Parameters

    • requestParameters: JobsApiJobsRetrieveAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Summary

    Method returns annotations for a specific job as a JSON document. If format is specified, a zip archive is returned.

    Throws

• jobsRetrieveData:function

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

  • Parameters

    • requestParameters: JobsApiJobsRetrieveDataRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Method returns data for a specific job

    Throws

• jobsRetrieveDataMeta:function

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

  • Parameters

    • requestParameters: JobsApiJobsRetrieveDataMetaRequest

      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

• jobsRetrieveDataset:function

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

  • Parameters

    • requestParameters: JobsApiJobsRetrieveDatasetRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<File>

    Summary

    Export job as a dataset in a specific format

    Throws

• jobsRetrievePreview:function

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

  • Parameters

    • requestParameters: JobsApiJobsRetrievePreviewRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method returns a preview image for the job

    Throws

• jobsUpdateAnnotations:function

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

  • To check the status of the process of uploading a job 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/jobs/id/annotations requests to track the status of the annotations upload.

    Parameters

    • requestParameters: JobsApiJobsUpdateAnnotationsRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method performs an update of all annotations in a specific job or used for uploading annotations from a file

    Throws