Interface JobsApiJobsRetrieveAnnotationsRequest

Request parameters for jobsRetrieveAnnotations operation in JobsApi.

Export

JobsApiJobsRetrieveAnnotationsRequest

interface JobsApiJobsRetrieveAnnotationsRequest {
    action?: "download";
    cloudStorageId?: number;
    filename?: string;
    format?: string;
    id: number;
    location?: JobsRetrieveAnnotationsLocationEnum;
    useDefaultLocation?: boolean;
}

Index

Properties

action? cloudStorageId? filename? format? id location? useDefaultLocation?

Properties

`Optional` `Readonly`action

action?: "download"

Used to start downloading process locally after annotation file has been created

Memberof

JobsApiJobsRetrieveAnnotations

`Optional` `Readonly`cloudStorageId

cloudStorageId?: number

Storage id

Memberof

JobsApiJobsRetrieveAnnotations

`Optional` `Readonly`filename

filename?: string

Desired output file name

Memberof

JobsApiJobsRetrieveAnnotations

`Optional` `Readonly`format

format?: string

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

Memberof

JobsApiJobsRetrieveAnnotations

`Readonly`id

id: number

A unique integer value identifying this job.

Memberof

JobsApiJobsRetrieveAnnotations

`Optional` `Readonly`location

location?: JobsRetrieveAnnotationsLocationEnum

Where need to save downloaded annotation

Memberof

JobsApiJobsRetrieveAnnotations

`Optional` `Readonly`useDefaultLocation

useDefaultLocation?: boolean

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

Memberof

JobsApiJobsRetrieveAnnotations