Interface ProjectsApiProjectsRetrieveDatasetRequest

Request parameters for projectsRetrieveDataset operation in ProjectsApi.

Export

ProjectsApiProjectsRetrieveDatasetRequest

interface ProjectsApiProjectsRetrieveDatasetRequest {
    action?: ProjectsRetrieveDatasetActionEnum;
    cloudStorageId?: number;
    filename?: string;
    format?: string;
    id: number;
    location?: ProjectsRetrieveDatasetLocationEnum;
    rqId?: string;
    useDefaultLocation?: boolean;
}

Properties

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

Properties

Optional Readonlyaction

action?: ProjectsRetrieveDatasetActionEnum

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

Memberof

ProjectsApiProjectsRetrieveDataset

Optional ReadonlycloudStorageId

cloudStorageId?: number

Storage id

Memberof

ProjectsApiProjectsRetrieveDataset

Optional Readonlyfilename

filename?: string

Desired output file name

Memberof

ProjectsApiProjectsRetrieveDataset

Optional Readonlyformat

format?: string

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

Memberof

ProjectsApiProjectsRetrieveDataset

Readonlyid

id: number

A unique integer value identifying this project.

Memberof

ProjectsApiProjectsRetrieveDataset

Optional Readonlylocation

location?: ProjectsRetrieveDatasetLocationEnum

Where need to save downloaded dataset

Memberof

ProjectsApiProjectsRetrieveDataset

Optional ReadonlyrqId

rqId?: string

rq id

Memberof

ProjectsApiProjectsRetrieveDataset

Optional ReadonlyuseDefaultLocation

useDefaultLocation?: boolean

Use the location that was configured in project to import dataset

Memberof

ProjectsApiProjectsRetrieveDataset

Settings

Member Visibility

On This Page

Properties