{ "opencollection": "1.0.0", "info": { "name": "Dashboards Dashboard Group API", "version": "20210731" }, "items": [ { "info": { "name": "dashboardGroup", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all dashboard groups in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210731/dashboardGroups", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-cross-region", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that returns dashboard groups that match the lifecycle state specified." }, { "name": "displayName", "value": "", "type": "query", "description": "A case-sensitive filter that returns resources that match the entire display name specified." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group." }, { "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 at which to start retrieving results. This value is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). \nDefault order for TIMECREATED is descending. \nDefault order for DISPLAYNAME is ascending. \nThe DISPLAYNAME sort order is case sensitive.\n" } ] }, "docs": "Returns a list of dashboard groups with a specific compartment ID.\n" }, { "info": { "name": "Creates a new DashboardGroup", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210731/dashboardGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-cross-region", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dashboard group using the details provided in request body.\n\n**Caution:** Resources for the Dashboard service are created in the tenacy's home region.\nAlthough it is possible to create dashboard group resource in regions other than the home region,\nyou won't be able to view those resources in the Console.\nTherefore, creating resources outside of the home region is not recommended.\n" }, { "info": { "name": "Get DashboardGroup", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20210731/dashboardGroups/:dashboardGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-cross-region", "value": "" } ], "params": [ { "name": "dashboardGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group." } ] }, "docs": "Gets the specified dashboard group's information. Uses the dashboard group's OCID to determine which dashboard to retrieve." }, { "info": { "name": "Update the DashboardGroup identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20210731/dashboardGroups/:dashboardGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-cross-region", "value": "" } ], "params": [ { "name": "dashboardGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to update." }, { "info": { "name": "Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20210731/dashboardGroups/:dashboardGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-cross-region", "value": "" } ], "params": [ { "name": "dashboardGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group." } ] }, "docs": "Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20210731/dashboardGroups/:dashboardGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dashboardGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a DashboardGroup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." } ] } ], "bundled": true }