Interface TasksApiTasksRetrieveAnnotationsRequest

Request parameters for tasksRetrieveAnnotations operation in TasksApi.

Export

TasksApiTasksRetrieveAnnotationsRequest

Hierarchy

  • TasksApiTasksRetrieveAnnotationsRequest

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

TasksApiTasksRetrieveAnnotations

Optional Readonly cloudStorageId

cloudStorageId?: number

Storage id

Memberof

TasksApiTasksRetrieveAnnotations

Optional Readonly filename

filename?: string

Desired output file name

Memberof

TasksApiTasksRetrieveAnnotations

Optional Readonly format

format?: string

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

Memberof

TasksApiTasksRetrieveAnnotations

Readonly id

id: number

A unique integer value identifying this task.

Memberof

TasksApiTasksRetrieveAnnotations

Optional Readonly location

location?: TasksRetrieveAnnotationsLocationEnum

Where need to save downloaded dataset

Memberof

TasksApiTasksRetrieveAnnotations

Optional Readonly useDefaultLocation

useDefaultLocation?: boolean

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

Memberof

TasksApiTasksRetrieveAnnotations

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc