Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListCategoriesRequest

example

Click here to see how to use ListCategoriesRequest.

Properties

Optional childTenancyIds

childTenancyIds: Array<string>

A list of child tenancies for which the respective data will be returned. Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.

If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.

It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.

When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

compartmentId

compartmentId: string

The OCID of the compartment.

compartmentIdInSubtree

compartmentIdInSubtree: boolean

When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of {@code accessLevel}.

Can only be set to true when performing ListCompartments on the tenancy (root compartment).

Optional includeOrganization

includeOrganization: undefined | false | true

When set to true, the data for all child tenancies including the parent is returned. That is, if there is an organization with parent P and children A and B, to return the data for the parent P, child A and child B, this parameter value should be set to true.

Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A.

When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

Optional lifecycleState

lifecycleState: model.LifecycleState

A filter that returns results that match the lifecycle state specified.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated "List" call.

Optional name

name: undefined | string

Optional. A filter that returns results that match the name specified.

Optional opcRequestId

opcRequestId: undefined | string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Optional page

page: undefined | string

The value of the {@code opc-next-page} response header from the previous "List" call.

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. You can provide one sort order ({@code sortOrder}). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).