// This is an automatically generated code sample.
// To make this code sample work in your Oracle Cloud tenancy,
// please replace the values for any parameters whose current values do not fit
// your use case (such as resource IDs, strings containing ‘EXAMPLE’ or ‘unique_id’, and
// boolean, number, and enum parameters with values not fitting your use case).
import * as datacatalog from "oci-datacatalog";
import common = require("oci-common");
// Create a default authentication provider that uses the DEFAULT
// profile in the configuration file.
// Refer to <see href="https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File>the public documentation</see> on how to prepare a configuration file.
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
(async () => {
try {
// Create a service client
const client = new datacatalog.DataCatalogClient({ authenticationDetailsProvider: provider });
// Create a request and dependent object(s).
const listEntitiesRequest: datacatalog.requests.ListEntitiesRequest = {
catalogId: "ocid1.test.oc1..<unique_ID>EXAMPLE-catalogId-Value",
dataAssetKey: "EXAMPLE-dataAssetKey-Value",
displayName: "EXAMPLE-displayName-Value",
businessName: "EXAMPLE-businessName-Value",
displayOrBusinessNameContains: "EXAMPLE-displayOrBusinessNameContains-Value",
typeKey: "EXAMPLE-typeKey-Value",
displayNameContains: "EXAMPLE-displayNameContains-Value",
lifecycleState: datacatalog.models.LifecycleState.Active,
timeCreated: new Date("Wed Aug 15 18:25:09 UTC 2018"),
timeUpdated: new Date("Mon Mar 26 23:15:27 UTC 2018"),
createdById: "ocid1.test.oc1..<unique_ID>EXAMPLE-createdById-Value",
updatedById: "ocid1.test.oc1..<unique_ID>EXAMPLE-updatedById-Value",
externalKey: "EXAMPLE-externalKey-Value",
patternKey: "EXAMPLE-patternKey-Value",
timeExternal: new Date("Mon Oct 25 11:34:31 UTC 2027"),
timeStatusUpdated: new Date("Mon Feb 03 17:40:28 UTC 2025"),
isLogical: false,
isPartition: true,
folderKey: "EXAMPLE-folderKey-Value",
path: "EXAMPLE-path-Value",
harvestStatus: datacatalog.models.HarvestStatus.Error,
lastJobKey: "EXAMPLE-lastJobKey-Value",
fields: [datacatalog.requests.ListEntitiesRequest.Fields.LifecycleState ],
sortBy: datacatalog.requests.ListEntitiesRequest.SortBy.Timecreated,
sortOrder: datacatalog.requests.ListEntitiesRequest.SortOrder.Asc,
limit: 718,
page: "EXAMPLE-page-Value",
opcRequestId: "Y75LZGYFLFRU3IZSW4WZ<unique_ID>",
isProcess: false,
};
// Send request to the Client.
const listEntitiesResponse = await client.listEntities(listEntitiesRequest);
}
catch (error) {
console.log("listEntities Failed with error " + error);
}
})();