{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud Bridge Inventory API", "version": "20220509" }, "items": [ { "info": { "name": "inventory", "type": "folder" }, "items": [ { "info": { "name": "Gets an aggregation of all assets in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/assetAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only assets whose lifecycleState matches the given lifecycleState." }, { "name": "sourceKey", "value": "", "type": "query", "description": "Source key from where the assets originate." }, { "name": "externalAssetKey", "value": "", "type": "query", "description": "External asset key." }, { "name": "assetType", "value": "", "type": "query", "description": "The type of asset." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "aggregationProperties", "value": "", "type": "query", "description": "An array of properties on which to aggregate." }, { "name": "groupBy", "value": "", "type": "query", "description": "The dimensions in which to group the aggregations." }, { "name": "inventoryId", "value": "", "type": "query", "description": "Unique Inventory identifier." } ] }, "docs": "Returns an aggregation of assets. Aggregation groups are sorted by groupBy property.\nDefault sort order is ascending, but can be overridden by the sortOrder parameter.\n" }, { "info": { "name": "Gets a list of all assets.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/assets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only assets whose lifecycleState matches the given lifecycleState." }, { "name": "sourceKey", "value": "", "type": "query", "description": "Source key from where the assets originate." }, { "name": "externalAssetKey", "value": "", "type": "query", "description": "External asset key." }, { "name": "assetType", "value": "", "type": "query", "description": "The type of asset." }, { "name": "assetId", "value": "", "type": "query", "description": "Unique asset identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "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.\n" }, { "name": "inventoryId", "value": "", "type": "query", "description": "Unique Inventory identifier." } ] }, "docs": "Returns a list of assets.\n" }, { "info": { "name": "Creates an asset.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/assets", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an asset." }, { "info": { "name": "Gets asset.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/assets/:assetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ] }, "docs": "Gets an asset by identifier." }, { "info": { "name": "Updates the asset identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220509/assets/:assetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the asset." }, { "info": { "name": "Deletes a provisioned asset.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/assets/:assetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ] }, "docs": "Deletes an asset resource by identifier." }, { "info": { "name": "Moves an asset resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/assets/:assetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an asset resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Change an asset's tag.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/assets/:assetId/actions/changeTags", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change an asset's tag." }, { "info": { "name": "Creates or updates all metrics related to the asset.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/assets/:assetId/actions/submitHistoricalMetrics", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates all metrics related to the asset." }, { "info": { "name": "Lists asset historical metrics.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/assets/:assetId/historicalMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Unique asset identifier." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "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.\n" } ] }, "docs": "List asset historical metrics." }, { "info": { "name": "Gets a list of all inventories in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/inventories", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "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.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return inventory if the lifecycleState matches the given lifecycleState." } ] }, "docs": "Returns a list of inventories.\n" }, { "info": { "name": "Creates an inventory.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/inventories", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an inventory." }, { "info": { "name": "Gets inventory.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/inventories/:inventoryId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "inventoryId", "value": "", "type": "path", "description": "Inventory OCID." } ] }, "docs": "Gets an inventory by identifier." }, { "info": { "name": "Updates the inventory identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220509/inventories/:inventoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "inventoryId", "value": "", "type": "path", "description": "Inventory OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an inventory." }, { "info": { "name": "Deletes a provisioned inventory.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/inventories/:inventoryId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "inventoryId", "value": "", "type": "path", "description": "Inventory OCID." } ] }, "docs": "Deletes an inventory resource by identifier." }, { "info": { "name": "Imports API for inventories.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/inventories/:inventoryId/actions/import", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "inventoryId", "value": "", "type": "path", "description": "Inventory OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import resources in inventory." } ] } ], "bundled": true }