Interface ProjectsApiProjectsRetrieveAnnotationsRequest

Request parameters for projectsRetrieveAnnotations operation in ProjectsApi.

Export

ProjectsApiProjectsRetrieveAnnotationsRequest

Hierarchy

  • ProjectsApiProjectsRetrieveAnnotationsRequest

Properties

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

Properties

Optional Readonly action

action?: "download"

Used to start downloading process after annotation file had been created

Memberof

ProjectsApiProjectsRetrieveAnnotations

Optional Readonly cloudStorageId

cloudStorageId?: number

Storage id

Memberof

ProjectsApiProjectsRetrieveAnnotations

Optional Readonly filename

filename?: string

Desired output file name

Memberof

ProjectsApiProjectsRetrieveAnnotations

Readonly format

format: string

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

Memberof

ProjectsApiProjectsRetrieveAnnotations

Readonly id

id: number

A unique integer value identifying this project.

Memberof

ProjectsApiProjectsRetrieveAnnotations

Optional Readonly location

location?: ProjectsRetrieveAnnotationsLocationEnum

Where need to save downloaded dataset

Memberof

ProjectsApiProjectsRetrieveAnnotations

Optional Readonly useDefaultLocation

useDefaultLocation?: boolean

Use the location that was configured in project to export annotation

Memberof

ProjectsApiProjectsRetrieveAnnotations

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc