{
  "opencollection": "1.0.0",
  "info": {
    "name": "ManagementDashboard Dashx APIS API",
    "version": "20200901"
  },
  "items": [
    {
      "info": {
        "name": "dashxApis",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets the list of dashboards in a compartment with pagination.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/managementDashboards",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              },
              {
                "name": "compartmentIdInSubtree",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Gets the list of dashboards in a compartment with pagination.  Returned properties are the summary."
        },
        {
          "info": {
            "name": "Creates a new dashboard.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20200901/managementDashboards",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 r"
        },
        {
          "info": {
            "name": "Exports dashboards and their saved searches.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/managementDashboards/actions/exportDashboard/:exportDashboardId",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "exportDashboardId",
                "value": "",
                "type": "path",
                "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\\\"]}\" ."
              },
              {
                "name": "exportTags",
                "value": "",
                "type": "query",
                "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"
              }
            ]
          },
          "docs": "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"
        },
        {
          "info": {
            "name": "Imports dashboards and their saved searches.  If the dashboard or the saved search already exists then it is updated.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20200901/managementDashboards/actions/importDashboard",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "overrideSameName",
                "value": "",
                "type": "query",
                "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.\nHowever, 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.\n"
              },
              {
                "name": "overrideDashboardCompartmentOcid",
                "value": "",
                "type": "query",
                "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.\n"
              },
              {
                "name": "overrideSavedSearchCompartmentOcid",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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 resourc"
        },
        {
          "info": {
            "name": "Gets a dashboard and its saved searches by ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/managementDashboards/:managementDashboardId",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementDashboardId",
                "value": "",
                "type": "path",
                "description": "A unique dashboard identifier."
              }
            ]
          },
          "docs": "Gets a dashboard and its saved searches by ID.  Deleted or unauthorized saved searches are marked by tile's state property."
        },
        {
          "info": {
            "name": "Updates an existing dashboard.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20200901/managementDashboards/:managementDashboardId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementDashboardId",
                "value": "",
                "type": "path",
                "description": "A unique dashboard identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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.\n"
        },
        {
          "info": {
            "name": "Deletes a dashboard by ID.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20200901/managementDashboards/:managementDashboardId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementDashboardId",
                "value": "",
                "type": "path",
                "description": "A unique dashboard identifier."
              }
            ]
          },
          "docs": "Deletes a Dashboard by ID."
        },
        {
          "info": {
            "name": "Moves the dashboard to a new compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20200901/managementDashboards/:managementDashboardId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementDashboardId",
                "value": "",
                "type": "path",
                "description": "A unique dashboard identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves the dashboard from the existing compartment to a new compartment.\n"
        },
        {
          "info": {
            "name": "Gets the list of saved searches in a compartment with pagination.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/managementSavedSearches",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              },
              {
                "name": "compartmentIdInSubtree",
                "value": "",
                "type": "query",
                "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."
              }
            ]
          },
          "docs": "Gets the list of saved searches in a compartment with pagination.  Returned properties are the summary."
        },
        {
          "info": {
            "name": "Creates a new saved search.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20200901/managementSavedSearches",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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-"
        },
        {
          "info": {
            "name": "Gets a saved search by ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/managementSavedSearches/:managementSavedSearchId",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementSavedSearchId",
                "value": "",
                "type": "path",
                "description": "A unique saved search identifier."
              }
            ]
          },
          "docs": "Gets a saved search by ID."
        },
        {
          "info": {
            "name": "Updates an existing saved search.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20200901/managementSavedSearches/:managementSavedSearchId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementSavedSearchId",
                "value": "",
                "type": "path",
                "description": "A unique saved search identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing saved search identified by ID path parameter.  CompartmentId can be modified only by the changeCompartment API.\n"
        },
        {
          "info": {
            "name": "Deletes a saved search by ID.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20200901/managementSavedSearches/:managementSavedSearchId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementSavedSearchId",
                "value": "",
                "type": "path",
                "description": "A unique saved search identifier."
              }
            ]
          },
          "docs": "Deletes a saved search by ID."
        },
        {
          "info": {
            "name": "Moves the saved search to a new compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20200901/managementSavedSearches/:managementSavedSearchId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementSavedSearchId",
                "value": "",
                "type": "path",
                "description": "A unique saved search identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves the saved search from the existing compartment to a new compartment.\n"
        },
        {
          "info": {
            "name": "Gets the list of OOB dashboards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/oobManagementDashboards",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "Gets the list of out-of-the-box dashboards with pagination. Returned properties are the summary."
        },
        {
          "info": {
            "name": "Gets an OOB dashboard and its saved searches by ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/oobManagementDashboards/:managementDashboardId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementDashboardId",
                "value": "",
                "type": "path",
                "description": "A unique dashboard identifier."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Gets the list of out-of-the-box saved searches in a compartment with pagination.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/oobManagementSavedSearches",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The ID of the compartment in which to list resources."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the entire display name given."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either 'asc' or 'desc'."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "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.\n"
              }
            ]
          },
          "docs": "Gets the list of out-of-the-box saved searches in a compartment with pagination.  Returned properties are the summary."
        },
        {
          "info": {
            "name": "Gets an out-of-the-box saved search by ID.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20200901/oobManagementSavedSearches/:managementSavedSearchId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "managementSavedSearchId",
                "value": "",
                "type": "path",
                "description": "A unique saved search identifier."
              }
            ]
          },
          "docs": "Gets an out-of-the-box saved search by ID."
        }
      ]
    }
  ],
  "bundled": true
}