{ "opencollection": "1.0.0", "info": { "name": "License Manager API", "version": "20220430" }, "items": [ { "info": { "name": "LicenseManager", "type": "folder" }, "items": [ { "info": { "name": "Retrieves Configuration for a compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/configuration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" } ] }, "docs": "Retrieves configuration for a compartment." }, { "info": { "name": "Updates setting for the compartment", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220430/configuration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration for the compartment." }, { "info": { "name": "Retrieves the overview for a given compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/licenseMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates if the given compartment is the root compartment." } ] }, "docs": "Retrieves the license metrics for a given compartment." }, { "info": { "name": "Retrieves all license records for given productLicenseId", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/licenseRecords", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "productLicenseId", "value": "", "type": "query", "description": "Unique product license identifier." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `expirationDate`\n\n* **expirationDate:** Sorts by expiration date of the license record.\n" } ] }, "docs": "Retrieves all license records for a given product license ID." }, { "info": { "name": "Creates a new license record for the given product license ID.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220430/licenseRecords", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "productLicenseId", "value": "", "type": "query", "description": "Unique product license identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new license record for the given product license ID." }, { "info": { "name": "Retrieves license record details by the license record ID in a given compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/licenseRecords/:licenseRecordId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "licenseRecordId", "value": "", "type": "path", "description": "Unique license record identifier." } ] }, "docs": "Retrieves license record details by the license record ID in a given compartment." }, { "info": { "name": "Updates a license record entity details", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220430/licenseRecords/:licenseRecordId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "licenseRecordId", "value": "", "type": "path", "description": "Unique license record identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates license record entity details." }, { "info": { "name": "Removes a License record", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20220430/licenseRecords/:licenseRecordId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "licenseRecordId", "value": "", "type": "path", "description": "Unique license record identifier." } ] }, "docs": "Removes a license record." }, { "info": { "name": "Bulk upload License Records for the given compartment", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220430/licenses/actions/bulkUpload", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk upload the product licenses and license records for a given compartment." }, { "info": { "name": "Provides bulk upload file template", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/licenses/actions/bulkUploadTemplate", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Provides the bulk upload file template." }, { "info": { "name": "Retrieves the product license consumers for a particular productLicenseId", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/productLicenseConsumers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "productLicenseId", "value": "", "type": "query", "description": "Unique product license identifier." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates if the given compartment is the root compartment." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `licenseUnitsRequired`\n\n* **licenseUnitsRequired:** Sorts by licenseUnitsRequired of the Resource.\n" } ] }, "docs": "Retrieves the product license consumers for a particular product license ID." }, { "info": { "name": "Retrieves all the ProductLicense from given compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/productLicenses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates if the given compartment is the root compartment." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `totalLicenseUnitsConsumed`\n\n* **totalLicenseUnitsConsumed:** Sorts by totalLicenseUnitsConsumed of ProductLicense.\n" } ] }, "docs": "Retrieves all the product licenses from a given compartment." }, { "info": { "name": "Creates a new productLicense", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20220430/productLicenses", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new product license." }, { "info": { "name": "Retrieves productLicense details by productLicenseId in a given compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/productLicenses/:productLicenseId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "productLicenseId", "value": "", "type": "path", "description": "Unique product license identifier." } ] }, "docs": "Retrieves product license details by product license ID in a given compartment." }, { "info": { "name": "Updates the Images list of a productLicense", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20220430/productLicenses/:productLicenseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "productLicenseId", "value": "", "type": "path", "description": "Unique product license identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of images for a product license." }, { "info": { "name": "Removes a ProductLicense", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20220430/productLicenses/:productLicenseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "productLicenseId", "value": "", "type": "path", "description": "Unique product license identifier." } ] }, "docs": "Removes a product license." }, { "info": { "name": "Retrieves the top utilized productLicenses for a given compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/topUtilizedProductLicenses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates if the given compartment is the root compartment." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `totalLicenseUnitsConsumed`\n\n* **totalLicenseUnitsConsumed:** Sorts by totalLicenseUnitsConsumed of ProductLicense.\n" } ] }, "docs": "Retrieves the top utilized product licenses for a given compartment." }, { "info": { "name": "Retrieves the top utilized resources for a given compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20220430/topUtilizedResources", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "compartmentId", "value": "", "type": "query", "description": "The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) used for the license record, product license, and configuration.\n" }, { "name": "isCompartmentIdInSubtree", "value": "", "type": "query", "description": "Indicates if the given compartment is the root compartment." }, { "name": "resourceUnitType", "value": "", "type": "query", "description": "A filter to return only resources whose unit matches the given resource unit." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether `ASC` or `DESC`." }, { "name": "sortBy", "value": "", "type": "query", "description": "Specifies the attribute with which to sort the rules.\n\nDefault: `totalUnits`\n\n* **totalUnits:** Sorts by totalUnits consumed by resource.\n" } ] }, "docs": "Retrieves the top utilized resources for a given compartment." } ] } ], "bundled": true }