Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAnnotationsRequest

example

Click here to see how to use ListAnnotationsRequest.

Properties

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

datasetId

datasetId: string

Filter the results by the OCID of the dataset.

Optional id

id: undefined | string

The unique OCID identifier.

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources whose lifecycleState matches the given lifecycleState.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Optional recordId

recordId: undefined | string

The OCID of the record annotated.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. If no value is specified timeCreated is used by default.

Optional sortOrder

sortOrder: model.SortOrders

The sort order to use, either 'asc' or 'desc'.

Optional timeCreatedGreaterThanOrEqualTo

timeCreatedGreaterThanOrEqualTo: Date

The date and time the resource was created, in the timestamp format defined by RFC3339.

Optional timeCreatedLessThanOrEqualTo

timeCreatedLessThanOrEqualTo: Date

The date and time the resource was created, in the timestamp format defined by RFC3339.

Optional updatedBy

updatedBy: undefined | string

The OCID of the principal which updated the annotation.