Interface JobsApiJobsRetrieveDatasetRequest

Request parameters for jobsRetrieveDataset operation in JobsApi.

Export

JobsApiJobsRetrieveDatasetRequest

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

Properties

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

Properties

Optional Readonlyaction

action?: "download"

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

Memberof

JobsApiJobsRetrieveDataset

Optional ReadonlycloudStorageId

cloudStorageId?: number

Storage id

Memberof

JobsApiJobsRetrieveDataset

Optional Readonlyfilename

filename?: string

Desired output file name

Memberof

JobsApiJobsRetrieveDataset

Readonlyformat

format: string

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

Memberof

JobsApiJobsRetrieveDataset

Readonlyid

id: number

A unique integer value identifying this job.

Memberof

JobsApiJobsRetrieveDataset

Optional Readonlylocation

location?: JobsRetrieveDatasetLocationEnum

Where need to save downloaded dataset

Memberof

JobsApiJobsRetrieveDataset

Optional ReadonlyuseDefaultLocation

useDefaultLocation?: boolean

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

Memberof

JobsApiJobsRetrieveDataset

Settings

Member Visibility

On This Page

Properties