Function JobsApiFp

Returns {
    jobsCreate(jobWriteRequest, options?) => Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>;
    jobsCreateAnnotations(id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, annotationFileRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    jobsDestroy(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    jobsDestroyAnnotations(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    jobsList(xOrganization?, assignee?, dimension?, filter?, org?, orgId?, page?, pageSize?, projectId?, projectName?, search?, sort?, stage?, state?, taskId?, taskName?, type?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedJobReadList>)>;
    jobsPartialUpdate(id, patchedJobWriteRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>;
    jobsPartialUpdateAnnotations(action, id, patchedLabeledDataRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    jobsRetrieve(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>;
    jobsRetrieveAnnotations(id, action?, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, options?) => Promise<((axios?, basePath?) => AxiosPromise<AnnotationsRead>)>;
    jobsRetrieveData(id, number?, quality?, type?, options?) => Promise<((axios?, basePath?) => AxiosPromise<File>)>;
    jobsRetrieveDataMeta(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<DataMetaRead>)>;
    jobsRetrieveDataset(format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?) => Promise<((axios?, basePath?) => AxiosPromise<File>)>;
    jobsRetrievePreview(id, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    jobsUpdateAnnotations(id, cloudStorageId?, filename?, format?, location?, rqId?, useDefaultLocation?, jobAnnotationsUpdateRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• jobsCreate:function

  • jobsCreate(jobWriteRequest, options?): Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

  • Parameters

    • jobWriteRequest: JobWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

    Summary

    Method creates a new job in the task

    Throws

• jobsCreateAnnotations:function

  • jobsCreateAnnotations(id, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, annotationFileRequest?, options?): Promise<((axios?, basePath?) => 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

    • id: number

      A unique integer value identifying this job.

    • 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: JobsCreateAnnotationsLocationEnum

      where to import the annotation from

    • Optional useDefaultLocation: boolean

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

    • Optional annotationFileRequest: AnnotationFileRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => 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(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

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

    Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method deletes a job and its related annotations

    Throws

• jobsDestroyAnnotations:function

  • jobsDestroyAnnotations(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method deletes all annotations for a specific job

    Throws

• jobsList:function

  • jobsList(xOrganization?, assignee?, dimension?, filter?, org?, orgId?, page?, pageSize?, projectId?, projectName?, search?, sort?, stage?, state?, taskId?, taskName?, type?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedJobReadList>)>

  • Parameters

    • Optional xOrganization: string

      Organization unique slug

    • Optional assignee: string

      A simple equality filter for the assignee field

    • Optional dimension: JobsListDimensionEnum

      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;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;].

    • Optional org: string

      Organization unique slug

    • Optional orgId: number

      Organization identifier

    • 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;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;)

    • Optional sort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;task_name&#39;, &#39;project_name&#39;, &#39;assignee&#39;, &#39;state&#39;, &#39;stage&#39;, &#39;id&#39;, &#39;task_id&#39;, &#39;project_id&#39;, &#39;updated_date&#39;, &#39;dimension&#39;, &#39;type&#39;]

    • Optional stage: JobsListStageEnum

      A simple equality filter for the stage field

    • Optional state: JobsListStateEnum

      A simple equality filter for the state field

    • Optional taskId: number

      A simple equality filter for the task_id field

    • Optional taskName: string

      A simple equality filter for the task_name field

    • Optional type: JobsListTypeEnum

      A simple equality filter for the type field

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedJobReadList>)>

    Summary

    Method returns a paginated list of jobs

    Throws

• jobsPartialUpdate:function

  • jobsPartialUpdate(id, patchedJobWriteRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional patchedJobWriteRequest: PatchedJobWriteRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

    Summary

    Methods does a partial update of chosen fields in a job

    Throws

• jobsPartialUpdateAnnotations:function

  • jobsPartialUpdateAnnotations(action, id, patchedLabeledDataRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • action: JobsPartialUpdateAnnotationsActionEnum

    • id: number

      A unique integer value identifying this job.

    • Optional patchedLabeledDataRequest: PatchedLabeledDataRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method performs a partial update of annotations in a specific job

    Throws

• jobsRetrieve:function

  • jobsRetrieve(id, options?): Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<JobRead>)>

    Summary

    Method returns details of a job

    Throws

• jobsRetrieveAnnotations:function

  • jobsRetrieveAnnotations(id, action?, cloudStorageId?, filename?, format?, location?, useDefaultLocation?, options?): Promise<((axios?, basePath?) => AxiosPromise<AnnotationsRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • 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: JobsRetrieveAnnotationsLocationEnum

      Where need to save downloaded annotation

    • 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<((axios?, basePath?) => 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(id, number?, quality?, type?, options?): Promise<((axios?, basePath?) => AxiosPromise<File>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional number: number

      A unique number value identifying chunk or frame

    • Optional quality: JobsRetrieveDataQualityEnum

      Specifies the quality level of the requested data

    • Optional type: JobsRetrieveDataTypeEnum

      Specifies the type of the requested data

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns data for a specific job

    Throws

• jobsRetrieveDataMeta:function

  • jobsRetrieveDataMeta(id, options?): Promise<((axios?, basePath?) => AxiosPromise<DataMetaRead>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

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

    Throws

• jobsRetrieveDataset:function

  • jobsRetrieveDataset(format, id, action?, cloudStorageId?, filename?, location?, useDefaultLocation?, options?): Promise<((axios?, basePath?) => AxiosPromise<File>)>

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

    • 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: JobsRetrieveDatasetLocationEnum

      Where need to save downloaded dataset

    • Optional useDefaultLocation: boolean

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

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Export job as a dataset in a specific format

    Throws

• jobsRetrievePreview:function

  • jobsRetrievePreview(id, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Parameters

    • id: number

      A unique integer value identifying this job.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

    Method returns a preview image for the job

    Throws

• jobsUpdateAnnotations:function

  • jobsUpdateAnnotations(id, cloudStorageId?, filename?, format?, location?, rqId?, useDefaultLocation?, jobAnnotationsUpdateRequest?, options?): Promise<((axios?, basePath?) => 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

    • id: number

      A unique integer value identifying this job.

    • 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: JobsUpdateAnnotationsLocationEnum

      where to import the annotation from

    • Optional rqId: string

      rq id

    • Optional useDefaultLocation: boolean

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

    • Optional jobAnnotationsUpdateRequest: JobAnnotationsUpdateRequest

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

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

    Summary

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

    Throws