/** * * * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); /** * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/datasafe/ListProfileAnalytics.ts.html |here} to see how to use ListProfileAnalyticsRequest. */ export interface ListProfileAnalyticsRequest extends common.BaseRequest { /** * The OCID of the user assessment. */ "userAssessmentId": string; /** * A filter to return only resources that match the specified compartment OCID. */ "compartmentId": string; /** * 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. * */ "compartmentIdInSubtree"?: boolean; /** * 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. * */ "accessLevel"?: ListProfileAnalyticsRequest.AccessLevel; /** * A filter to return only items related to a specific target OCID. */ "targetId"?: string; /** * 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](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "limit"?: number; /** * 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](https://docs.oracle.com/iaas/en-us/iaas/Content/API/Concepts/usingapi.htm#nine). */ "page"?: string; /** * A filter to return only items that match the specified profile name. */ "profileName"?: string; /** * The field used for sorting. Only one sorting order (sortOrder) can be specified. * The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. * The DISPLAYNAME sort order is case sensitive. * */ "sortBy"?: ListProfileAnalyticsRequest.SortBy; /** * The sort order to use, either ascending (ASC) or descending (DESC). */ "sortOrder"?: ListProfileAnalyticsRequest.SortOrder; /** * Unique identifier for the request. */ "opcRequestId"?: string; } export declare namespace ListProfileAnalyticsRequest { enum AccessLevel { Restricted = "RESTRICTED", Accessible = "ACCESSIBLE" } enum SortBy { Timecreated = "TIMECREATED", Displayname = "DISPLAYNAME" } enum SortOrder { Asc = "ASC", Desc = "DESC" } }