Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListEntitiesRequest

example

Click here to see how to use ListEntitiesRequest.

Properties

Optional businessName

businessName: undefined | string

A filter to return only resources that match the entire business name given. The match is not case sensitive.

catalogId

catalogId: string

Unique catalog identifier.

Optional createdById

createdById: undefined | string

OCID of the user who created the resource.

dataAssetKey

dataAssetKey: string

Unique data asset key.

Optional displayName

displayName: undefined | string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Optional displayNameContains

displayNameContains: undefined | string

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

Optional displayOrBusinessNameContains

displayOrBusinessNameContains: undefined | string

A filter to return only resources that match display name or business name pattern given. The match is not case sensitive. For Example : /folders?displayOrBusinessNameContains=Cu.* The above would match all folders with display name or business name that starts with "Cu" or has the pattern "Cu" anywhere in between.

Optional externalKey

externalKey: undefined | string

Unique external identifier of this resource in the external source system.

Optional fields

fields: Array<Fields>

Specifies the fields to return in an entity summary response.

Optional folderKey

folderKey: undefined | string

Key of the associated folder.

Optional harvestStatus

harvestStatus: model.HarvestStatus

Harvest status of the harvestable resource as updated by the harvest process.

Optional isLogical

isLogical: undefined | false | true

Identifies if the object is a physical object (materialized) or virtual/logical object defined on other objects.

Optional isPartition

isPartition: undefined | false | true

Identifies if an object is a sub object (partition) of a physical or materialized parent object.

Optional lastJobKey

lastJobKey: undefined | string

Key of the last harvest process to update this resource.

Optional lifecycleState

lifecycleState: model.LifecycleState

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

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 path

path: undefined | string

Full path of the resource for resources that support paths.

Optional patternKey

patternKey: undefined | string

Unique pattern key.

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. DISPLAYORBUSINESSNAME considers businessName of a given object if set, else its displayName is used. Default sort order for TIMECREATED is descending and default sort order for DISPLAYNAME and DISPLAYORBUSINESSNAME is ascending. If no order is specified, TIMECREATED is the default.

Optional sortOrder

sortOrder: SortOrder

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

Optional timeCreated

timeCreated: Date

Time that the resource was created. An RFC3339 formatted datetime string.

Optional timeExternal

timeExternal: Date

Last modified timestamp of this object in the external system.

Optional timeStatusUpdated

timeStatusUpdated: Date

Time that the resource's status was last updated. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

Time that the resource was updated. An RFC3339 formatted datetime string.

Optional typeKey

typeKey: undefined | string

The key of the object type.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated the resource.