{ "opencollection": "1.0.0", "info": { "name": "RoverCloudService Rover Entitlement API", "version": "20201210" }, "items": [ { "info": { "name": "roverEntitlement", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all RoverEntitlements in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20201210/roverEntitlements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "filtering by Rover Device Entitlement id" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID 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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "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 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 default.\n" } ] }, "docs": "Returns a list of RoverEntitlements." }, { "info": { "name": "Create the Rover Device Entitlement", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20201210/roverEntitlements", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted." }, { "info": { "name": "Describes the Rover Device Entitlement in detail", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20201210/roverEntitlements/:roverEntitlementId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "roverEntitlementId", "value": "", "type": "path", "description": "ID of the rover node or cluster entitlement" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to list resources." } ] }, "docs": "Describes the Rover Device Entitlement in detail" }, { "info": { "name": "Update the Rover Entitlement identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20201210/roverEntitlements/:roverEntitlementId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "roverEntitlementId", "value": "", "type": "path", "description": "ID of the rover node or cluster entitlement" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the RoverEntitlement" }, { "info": { "name": "Deletes a rover entitlement", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20201210/roverEntitlements/:roverEntitlementId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "roverEntitlementId", "value": "", "type": "path", "description": "ID of the rover node or cluster entitlement" } ] }, "docs": "Deletes a rover entitlement" }, { "info": { "name": "Move an entitlement into a different compartment. When provided, if-Match is matched against ETag values of the resource.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20201210/roverEntitlements/:roverEntitlementId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "roverEntitlementId", "value": "", "type": "path", "description": "ID of the rover node or cluster entitlement" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an entitlement into a different compartment." } ] } ], "bundled": true }