Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListReportsRequest

example

Click here to see how to use ListReportsRequest.

Properties

Optional accessLevel

accessLevel: AccessLevel

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentId

compartmentId: string

A filter to return only resources that match the specified compartment OCID.

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

Optional displayName

displayName: undefined | string

The name of the report definition to query.

Optional lifecycleState

lifecycleState: model.ReportLifecycleState

An optional filter to return only resources that match the specified lifecycle state.

Optional limit

limit: undefined | number

For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

Optional opcRequestId

opcRequestId: undefined | string

Unique identifier for the request.

Optional page

page: undefined | string

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Optional reportDefinitionId

reportDefinitionId: undefined | string

The ID of the report definition to filter the list of reports

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. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending (ASC) or descending (DESC).

Optional type

type: model.ReportType

An optional filter to return only resources that match the specified type.