openapi: 3.2.0 info: description: "Use the Management Dashboards API for dashboard and saved search metadata preservation and to perform tasks such as creating a dashboard, creating a saved search, and obtaining a list of dashboards and saved searches in a compartment. For more information, see [Management Dashboards](https://docs.oracle.com/iaas/management-dashboard/home.htm).\n \n" title: ManagementDashboard Dashx APIS API version: '20200901' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/fea4d39ef97c7aeb871452bb4fa8d63e826225824a01e5a7acacf6ba3cd9866a.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the ManagementDashboard API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/fea4d39ef97c7aeb871452bb4fa8d63e826225824a01e5a7acacf6ba3cd9866a.yaml what: the harvested document for ManagementDashboard API servers: - url: http://127.0.0.1/20200901 - url: https://127.0.0.1/20200901 tags: - name: dashxApis paths: /managementDashboards: get: description: Gets the list of dashboards in a compartment with pagination. Returned properties are the summary. operationId: ListManagementDashboards parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: List of dashboards in the compartment is returned. Returned properties are the summary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboardCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of dashboards in a compartment with pagination. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' post: description: "Creates a new dashboard. Limit for number of saved searches in a dashboard is 20. \nHere's an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: \n`oci management-dashboard dashboard get --management-dashboard-id \"ocid1.managementdashboard.oc1..dashboardId1\" --query data > Create.json.` \nYou can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard dashboard create` command.\n" operationId: CreateManagementDashboard parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Dashboard is created. Created dashboard metadata is returned. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboard' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new dashboard. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateManagementDashboardDetails' description: JSON metadata for creating a new dashboard. required: true /managementDashboards/actions/exportDashboard/{exportDashboardId}: get: description: "Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. \nHere's an example of how you can use CLI to export a dashboard: \n`$oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json`\n" operationId: ExportDashboard parameters: - $ref: '#/components/parameters/ExportDashboardIdPathParams' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ExportTagsQueryParam' responses: 200: description: Array of dashboards and their saved searches. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboardExportDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Exports dashboards and their saved searches. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboardImportDetails' /managementDashboards/actions/importDashboard: post: description: "Imports an array of dashboards and their saved searches. \nHere's an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: \n`oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > Import.json`. \nNote that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. \nHere's an example of how you can use CLI to import:\n`oci management-dashboard dashboard import --from-json file://Import.json`\n" operationId: ImportDashboard parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OverrideSameNameQueryParam' - $ref: '#/components/parameters/OverrideDashboardCompartmentOcidQueryParam' - $ref: '#/components/parameters/OverrideSavedSearchCompartmentOcidQueryParam' responses: 200: description: Dashboards and their saved searches are imported. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Imports dashboards and their saved searches. If the dashboard or the saved search already exists then it is updated. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboardImportDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManagementDashboardImportDetails' description: JSON metadata for importing dashboards and their saved searches. required: true /managementDashboards/{managementDashboardId}: delete: description: Deletes a Dashboard by ID. operationId: DeleteManagementDashboard parameters: - $ref: '#/components/parameters/ManagementDashboardIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Dashboard is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a dashboard by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' get: description: Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property. operationId: GetManagementDashboard parameters: - $ref: '#/components/parameters/ManagementDashboardIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Dashboard and its saved searches are returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboard' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a dashboard and its saved searches by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' put: description: 'Updates an existing dashboard identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20. ' operationId: UpdateManagementDashboard parameters: - $ref: '#/components/parameters/ManagementDashboardIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Dashboard is updated. Updated dashboard metadata is returned. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboard' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates an existing dashboard. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagementDashboardDetails' description: JSON metadata for changed dashboard properties. required: true /managementDashboards/{managementDashboardId}/actions/changeCompartment: post: description: 'Moves the dashboard from the existing compartment to a new compartment. ' operationId: ChangeManagementDashboardsCompartment parameters: - $ref: '#/components/parameters/ManagementDashboardIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Dashboard is moved to the new compartment. Moved dashboard metadata is returned. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboard' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the dashboard to a new compartment. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeManagementDashboardsCompartmentDetails' description: ID of the dashboard that is being moved. required: true /managementSavedSearches: get: description: Gets the list of saved searches in a compartment with pagination. Returned properties are the summary. operationId: ListManagementSavedSearches parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: List of saved searches in the compartment is returned. Returned properties are the summary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearchCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of saved searches in a compartment with pagination. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' post: description: "Creates a new saved search. \nHere's an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: \n`oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json`. \nYou can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard saved-search create` command. \n" operationId: CreateManagementSavedSearch parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Saved search is created. Created saved search metadata is returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new saved search. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateManagementSavedSearchDetails' description: JSON metadata for the saved search. required: true /managementSavedSearches/{managementSavedSearchId}: delete: description: Deletes a saved search by ID. operationId: DeleteManagementSavedSearch parameters: - $ref: '#/components/parameters/SavedSearchIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Saved search is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a saved search by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' get: description: Gets a saved search by ID. operationId: GetManagementSavedSearch parameters: - $ref: '#/components/parameters/SavedSearchIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Saved search is returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a saved search by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' put: description: 'Updates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. ' operationId: UpdateManagementSavedSearch parameters: - $ref: '#/components/parameters/SavedSearchIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Saved search is updated. Updated saved search metadata is returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates an existing saved search. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagementSavedSearchDetails' description: JSON metadata for changed saved search properties. required: true /managementSavedSearches/{managementSavedSearchId}/actions/changeCompartment: post: description: 'Moves the saved search from the existing compartment to a new compartment. ' operationId: ChangeManagementSavedSearchesCompartment parameters: - $ref: '#/components/parameters/SavedSearchIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Saved search is moved to the new compartment. Moved saved search metadata is returned. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves the saved search to a new compartment. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeManagementSavedSearchesCompartmentDetails' description: ID of the saved search that is being moved. required: true /oobManagementDashboards: get: description: Gets the list of out-of-the-box dashboards with pagination. Returned properties are the summary. operationId: ListOobManagementDashboards parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of out-of-the-box is returned. Returned properties are the summary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboardCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of OOB dashboards tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' /oobManagementDashboards/{managementDashboardId}: get: description: Gets an out-of-the-box dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property. operationId: GetOobManagementDashboard parameters: - $ref: '#/components/parameters/ManagementDashboardIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Out-of-the-box dashboard and its saved searches are returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementDashboard' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets an OOB dashboard and its saved searches by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementDashboard' /oobManagementSavedSearches: get: description: Gets the list of out-of-the-box saved searches in a compartment with pagination. Returned properties are the summary. operationId: ListOobManagementSavedSearches parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: List of out-of-the-box saved searches is returned. Returned properties are the summary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearchCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the list of out-of-the-box saved searches in a compartment with pagination. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' /oobManagementSavedSearches/{managementSavedSearchId}: get: description: Gets an out-of-the-box saved search by ID. operationId: GetOobManagementSavedSearch parameters: - $ref: '#/components/parameters/SavedSearchIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Out-of-the-box saved search is returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagementSavedSearch' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets an out-of-the-box saved search by ID. tags: - dashxApis x-related-resource: '#/definitions/ManagementSavedSearch' components: parameters: PaginationTokenQueryParam: description: The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page x-default-description: This is an optional parameter used in pagination. schema: type: string maxLength: 1024 minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is the default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ManagementDashboardIdPathParam: description: A unique dashboard identifier. in: path name: managementDashboardId required: true schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string OverrideSavedSearchCompartmentOcidQueryParam: description: 'If this attribute is set, the saved search resources are created or updated in the compartment specified by OCID. If this attribute is not set, the compartment specified in the JSON metadata is used. ' in: query name: overrideSavedSearchCompartmentOcid x-default-description: The compartment specified in the JSON metadata is used. schema: type: string OverrideSameNameQueryParam: description: 'By default, if a resource with the same OCID exists in the target compartment, it is updated during the import process, otherwise, a new resource is created. However, if this attribute is set to true, then during the import process if a resource with the same displayName exists in the compartment, then it is updated even if the OCIDs are different. This is useful when importing the same resource multiple times. If the compartment and displayName remain the same, the resource is only updated and multiple copies of a resource are not created. ' in: query name: overrideSameName x-default-description: Default is false. Update operation is used only if a resource with same OCID exists in the same compartment. schema: type: string ExportDashboardIdPathParams: description: List of dashboardIds in plain text. The syntax is '{"dashboardIds":["dashboardId1", "dashboardId2", ...]}'. Escaping is needed when using in OCI CLI. For example, "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" . in: path name: exportDashboardId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit x-default-description: This is an optional parameter and if not specified all records would be fetched. schema: type: integer default: 100 maximum: 1000 minimum: 1 ExportTagsQueryParam: description: "Indicates whether tags must be included when exporting dashboards and saved searches. If this attribute is set to true, then both defined and free-form tags are included in the response. The default is false and tag fields are empty objects in the response.\nIf set to true, NotAuthorizedException is returned if you do not have the permission to access tags, even if you have the permission to access dashboards and saved searches. \n" in: query name: exportTags x-default-description: By default tags are not included in the export response. Set to true to include tag content. If user does not have permission, NotAuthorizedException will be returned. schema: type: string OverrideDashboardCompartmentOcidQueryParam: description: 'If this attribute is set, the dashboard resources are created or updated in the compartment specified by OCID. If this attribute is not set, the compartment specified in the JSON metadata is used. ' in: query name: overrideDashboardCompartmentOcid x-default-description: The compartment specified in the JSON metadata is used. schema: type: string SortOrderQueryParam: description: The sort order to use, either 'asc' or 'desc'. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: By default displayName filter need not be provided and would result in listing of dashboards or saved searches irrespective of displayName. schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string SavedSearchIdPathParam: description: A unique saved search identifier. in: path name: managementSavedSearchId required: true schema: type: string CompartmentIdInSubtreeQueryParam: description: A parameter that returns all the accessible resources in the tenant. This applies only when the compartmentId denotes the root compartment and this parameter is set to true. in: query name: compartmentIdInSubtree schema: type: string default: 'false' schemas: ManagementDashboardTileDetails: description: "Properties of the dashboard tile representing a saved search. \nTiles are laid out in a twelve column grid system with (0,0) at upper left corner.\n" properties: column: description: Tile's column number. type: integer dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array description: description: Description of the tile. type: string displayName: description: Display name of the saved search. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. type: object height: description: The number of rows the tile occupies. type: integer nls: description: JSON that contains internationalization options. type: object parametersMap: description: Specifies the saved search parameters values type: object row: description: Tile's row number. type: integer savedSearchId: description: ID of the saved search. type: string state: description: Current state of the saved search. enum: - DELETED - UNAUTHORIZED - DEFAULT type: string uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object width: description: The number of columns the tile occupies. type: integer required: - displayName - savedSearchId - row - column - height - width - nls - uiConfig - dataConfig - state - drilldownConfig type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ManagementSavedSearchSummary: description: Summary of the properties of a saved search. properties: compartmentId: description: OCID of the compartment in which the saved search resides. type: string createdBy: description: The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the saved search. type: string displayName: description: Display name of the saved search. type: string featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the saved search. type: string isOobSavedSearch: description: Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. type: boolean lifecycleState: description: OCI lifecycle status. This is automatically managed by the system. enum: - ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStates' metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the saved search. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the saved search. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the saved search. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time the saved search was created. format: date-time type: string timeUpdated: description: Date and time the saved search was updated. format: date-time type: string type: description: Determines how the saved search is displayed in a dashboard. enum: - SEARCH_SHOW_IN_DASHBOARD - SEARCH_DONT_SHOW_IN_DASHBOARD - WIDGET_SHOW_IN_DASHBOARD - WIDGET_DONT_SHOW_IN_DASHBOARD - FILTER_SHOW_IN_DASHBOARD - FILTER_DONT_SHOW_IN_DASHBOARD type: string x-obmcs-top-level-enum: '#/definitions/SavedSearchTypes' uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object updatedBy: description: The principle id of the user that updated this saved search type: string widgetTemplate: description: The UI template that the saved search uses to render itself. type: string widgetVM: description: The View Model that the saved search uses to render itself. type: string required: - id - displayName - isOobSavedSearch - description - compartmentId - providerId - providerVersion - providerName - nls - type - uiConfig - dataConfig - createdBy - updatedBy - timeCreated - timeUpdated - screenImage - metadataVersion - widgetTemplate - widgetVM - lifecycleState type: object CreateManagementDashboardDetails: description: Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards. properties: compartmentId: description: OCID of the compartment in which the dashboard resides. type: string dashboardId: description: ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards. type: string dataConfig: description: Array of JSON that contain data source options. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the dashboard. type: string displayName: description: Display name of the dashboard. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isFavorite: description: Determines whether the dashboard is set as favorite. type: boolean isOobDashboard: description: Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. type: boolean isShowDescription: description: Determines whether the description of the dashboard is displayed. type: boolean isShowInHome: description: Determines whether the dashboard will be displayed in Dashboard Home. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the dashboard. items: type: object type: array providerId: description: ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the dashboard. type: string tiles: description: Array of dashboard tiles. items: $ref: '#/components/schemas/ManagementDashboardTileDetails' type: array type: description: Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. type: string uiConfig: description: JSON that contains user interface options. type: object required: - providerId - providerName - providerVersion - tiles - displayName - description - compartmentId - isOobDashboard - isShowInHome - metadataVersion - isShowDescription - screenImage - nls - uiConfig - dataConfig - type - isFavorite type: object ManagementDashboardExportDetails: description: Array of dashboards to export. Response from export must be directly acceptable to import (compartmentIds may have to be changed). properties: dashboards: description: Array of dashboards. items: $ref: '#/components/schemas/ManagementDashboardForImportExportDetails' type: array required: - dashboards type: object CreateManagementSavedSearchDetails: description: Properties of a saved search. properties: compartmentId: description: OCID of the compartment in which the saved search resides. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the saved search. type: string displayName: description: Display name of the saved search. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search. type: string isOobSavedSearch: description: Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the saved search. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the saved search. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the saved search. type: string type: description: Determines how the saved search is displayed in a dashboard. enum: - SEARCH_SHOW_IN_DASHBOARD - SEARCH_DONT_SHOW_IN_DASHBOARD - WIDGET_SHOW_IN_DASHBOARD - WIDGET_DONT_SHOW_IN_DASHBOARD - FILTER_SHOW_IN_DASHBOARD - FILTER_DONT_SHOW_IN_DASHBOARD type: string x-obmcs-top-level-enum: '#/definitions/SavedSearchTypes' uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object widgetTemplate: description: The UI template that the saved search uses to render itself. type: string widgetVM: description: The View Model that the saved search uses to render itself. type: string required: - displayName - isOobSavedSearch - description - providerId - providerVersion - providerName - compartmentId - nls - type - uiConfig - dataConfig - screenImage - metadataVersion - widgetTemplate - widgetVM type: object UpdateManagementSavedSearchDetails: description: Properties of a saved search. Saved search ID must not be provided. properties: compartmentId: description: OCID of the compartment in which the saved search resides. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the saved search. type: string displayName: description: Display name of the saved search. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isOobSavedSearch: description: Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the saved search. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the saved search. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the saved search. type: string type: description: Determines how the saved search is displayed in a dashboard. enum: - SEARCH_SHOW_IN_DASHBOARD - SEARCH_DONT_SHOW_IN_DASHBOARD - WIDGET_SHOW_IN_DASHBOARD - WIDGET_DONT_SHOW_IN_DASHBOARD - FILTER_SHOW_IN_DASHBOARD - FILTER_DONT_SHOW_IN_DASHBOARD type: string x-obmcs-top-level-enum: '#/definitions/SavedSearchTypes' uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object widgetTemplate: description: The UI template that the saved search uses to render itself. type: string widgetVM: description: The View Model that the saved search uses to render itself. type: string type: object ManagementSavedSearchCollection: description: List of saved searches. properties: items: description: Array of saved search summaries. items: $ref: '#/components/schemas/ManagementSavedSearchSummary' type: array required: - items type: object ManagementDashboardSummary: description: Summary of the properties of a dashboard. properties: compartmentId: description: OCID of the compartment in which the dashboard resides. type: string createdBy: description: User who created the dashboard. type: string dashboardId: description: ID of the dashboard. Same as id. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the dashboard. type: string displayName: description: Display name of the dashboard. type: string featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the dashboard. Same as dashboardId. type: string isOobDashboard: description: Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. type: boolean lifecycleState: description: Current lifecycle state of the dashboard. enum: - ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStates' metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object providerId: description: ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the dashboard. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time the dashboard was created. format: date-time type: string timeUpdated: description: Date and time the dashboard was updated. format: date-time type: string type: description: Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. type: string updatedBy: description: User who updated the dashboard. type: string required: - dashboardId - id - displayName - description - compartmentId - providerId - providerName - providerVersion - isOobDashboard - createdBy - timeCreated - updatedBy - timeUpdated - metadataVersion - screenImage - nls - type - lifecycleState - freeformTags - definedTags type: object ChangeManagementSavedSearchesCompartmentDetails: description: Compartment to which the saved search is being moved. properties: compartmentId: description: OCID of the compartment to which the saved search is being moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ManagementSavedSearch: description: Properties of a saved search. properties: compartmentId: description: OCID of the compartment in which the saved search resides. type: string createdBy: description: The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the saved search. type: string displayName: description: Display name of the saved search. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the saved search. type: string isOobSavedSearch: description: Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. type: boolean lifecycleState: description: OCI lifecycle status. This is automatically managed by the system. enum: - ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStates' metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the saved search. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. type: string providerName: description: Name of the service (for example, Logging Analytics) that owns the saved search. type: string providerVersion: description: Version of the service that owns this saved search. type: string screenImage: description: Screen image of the saved search. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: Date and time the saved search was created. format: date-time type: string timeUpdated: description: Date and time the saved search was updated. format: date-time type: string type: description: Determines how the saved search is displayed in a dashboard. enum: - SEARCH_SHOW_IN_DASHBOARD - SEARCH_DONT_SHOW_IN_DASHBOARD - WIDGET_SHOW_IN_DASHBOARD - WIDGET_DONT_SHOW_IN_DASHBOARD - FILTER_SHOW_IN_DASHBOARD - FILTER_DONT_SHOW_IN_DASHBOARD type: string x-obmcs-top-level-enum: '#/definitions/SavedSearchTypes' uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object updatedBy: description: The principle id of the user that updated this saved search. type: string widgetTemplate: description: The UI template that the saved search uses to render itself. type: string widgetVM: description: The View Model that the saved search uses to render itself. type: string required: - id - displayName - isOobSavedSearch - description - providerId - providerVersion - providerName - compartmentId - nls - type - uiConfig - dataConfig - createdBy - updatedBy - timeCreated - timeUpdated - screenImage - metadataVersion - widgetTemplate - widgetVM - lifecycleState type: object ManagementDashboardForImportExportDetails: description: Properties of a dashboard, including dashboard ID and saved searches, for import purposes. properties: compartmentId: description: OCID of the compartment in which the dashboard resides. type: string dashboardId: description: ID of the dashboard. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the dashboard. type: string displayName: description: Display name of the dashboard. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isFavorite: description: Determines whether the dashboard is set as favorite. type: boolean isOobDashboard: description: Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. type: boolean isShowDescription: description: Determines whether the description of the dashboard is displayed. type: boolean isShowInHome: description: Determines whether the dashboard will be displayed in Dashboard Home. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the dashboard. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string savedSearches: description: Array of saved searches in the dashboard. items: $ref: '#/components/schemas/ManagementSavedSearchForImportDetails' type: array screenImage: description: Screen image of the dashboard. type: string tiles: description: Array of dashboard tiles. items: $ref: '#/components/schemas/ManagementDashboardTileDetails' type: array type: description: Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. type: string uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object required: - dashboardId - providerId - providerName - providerVersion - tiles - displayName - description - compartmentId - isOobDashboard - isShowInHome - metadataVersion - isShowDescription - screenImage - nls - uiConfig - dataConfig - type - isFavorite - savedSearches type: object ManagementDashboardImportDetails: description: Array of dashboards to import. properties: dashboards: description: Array of dashboards. items: $ref: '#/components/schemas/ManagementDashboardForImportExportDetails' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - dashboards type: object ManagementDashboard: description: Properties of a dashboard, including dashboard ID. properties: compartmentId: description: OCID of the compartment in which the dashboard resides. type: string createdBy: description: User who created the dashboard. type: string dashboardId: description: ID of the dashboard. Same as id. type: string dataConfig: description: Array of JSON that contain data source options. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the dashboard. type: string displayName: description: Display name of the dashboard. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the dashboard. Same as dashboardId. type: string isFavorite: description: Determines whether the dashboard is set as favorite. type: boolean isOobDashboard: description: Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. type: boolean isShowDescription: description: Determines whether the description of the dashboard is displayed. type: boolean isShowInHome: description: Determines whether the dashboard will be displayed in Dashboard Home. type: boolean lifecycleState: description: State of dashboard. enum: - ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStates' metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the dashboard. items: type: object type: array providerId: description: ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. type: string providerName: description: Name of the service (for example, Logging Analytics) that owns the dashboard. type: string providerVersion: description: Version of the service that owns the dashboard. type: string savedSearches: description: Array of saved searches in the dashboard. items: $ref: '#/components/schemas/ManagementSavedSearch' type: array screenImage: description: Screen image of the dashboard. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tiles: description: Array of dashboard tiles. items: $ref: '#/components/schemas/ManagementDashboardTileDetails' type: array timeCreated: description: Date and time the dashboard was created. format: date-time type: string timeUpdated: description: Date and time the dashboard was updated. format: date-time type: string type: description: Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. type: string uiConfig: description: JSON that contains user interface options. type: object updatedBy: description: User who updated the dashboard. type: string required: - dashboardId - id - providerId - providerName - providerVersion - tiles - displayName - description - compartmentId - isOobDashboard - isShowInHome - createdBy - timeCreated - updatedBy - timeUpdated - metadataVersion - isShowDescription - screenImage - nls - uiConfig - dataConfig - type - isFavorite - savedSearches - lifecycleState type: object ManagementDashboardCollection: description: List of dashboards. properties: items: description: Array of dashboard summaries. items: $ref: '#/components/schemas/ManagementDashboardSummary' type: array required: - items type: object ChangeManagementDashboardsCompartmentDetails: description: Compartment to which the dashboard is being moved. properties: compartmentId: description: OCID of the compartment to which the dashboard is being moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateManagementDashboardDetails: description: Properties of a dashboard. Dashboard ID must not be provided. properties: compartmentId: description: OCID of the compartment in which the dashboard resides. type: string dataConfig: description: Array of JSON that contain data source options. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the dashboard. type: string displayName: description: Display name of the dashboard. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isFavorite: description: Determines whether the dashboard is set as favorite. type: boolean isOobDashboard: description: Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. type: boolean isShowDescription: description: Determines whether the description of the dashboard is displayed. type: boolean isShowInHome: description: Determines whether the dashboard will be displayed in Dashboard Home. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the dashboard. items: type: object type: array providerId: description: ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the dashboard. type: string tiles: description: Array of dashboard tiles. items: $ref: '#/components/schemas/ManagementDashboardTileDetails' type: array type: description: Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. type: string uiConfig: description: JSON that contains user interface options. type: object type: object ManagementSavedSearchForImportDetails: description: Properties of a saved search. properties: compartmentId: description: OCID of the compartment in which the saved search resides. type: string dataConfig: description: It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. items: type: object type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of the saved search. type: string displayName: description: Display name of the saved search. type: string drilldownConfig: description: Drill-down configuration to define the destination of a drill-down action. items: type: object type: array featuresConfig: description: Contains configuration for enabling features. type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: ID of the saved search. type: string isOobSavedSearch: description: Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. type: boolean metadataVersion: description: The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. type: string nls: description: JSON that contains internationalization options. type: object parametersConfig: description: Defines parameters for the saved search. items: type: object type: array providerId: description: ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. type: string providerName: description: The user friendly name of the service (for example, Logging Analytics) that owns the saved search. type: string providerVersion: description: The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. type: string screenImage: description: Screen image of the saved search. type: string type: description: Determines how the saved search is displayed in a dashboard. enum: - SEARCH_SHOW_IN_DASHBOARD - SEARCH_DONT_SHOW_IN_DASHBOARD - WIDGET_SHOW_IN_DASHBOARD - WIDGET_DONT_SHOW_IN_DASHBOARD - FILTER_SHOW_IN_DASHBOARD - FILTER_DONT_SHOW_IN_DASHBOARD type: string x-obmcs-top-level-enum: '#/definitions/SavedSearchTypes' uiConfig: description: It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. type: object widgetTemplate: description: The UI template that the saved search uses to render itself. type: string widgetVM: description: The View Model that the saved search uses to render itself. type: string required: - id - displayName - isOobSavedSearch - description - providerId - providerVersion - providerName - compartmentId - nls - type - uiConfig - dataConfig - screenImage - metadataVersion - widgetTemplate - widgetVM type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.dashx