{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud Bridge Common API", "version": "20220509" }, "items": [ { "info": { "name": "common", "type": "folder" }, "items": [ { "info": { "name": "Lists work requests.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only resources for which the lifecycleState matches the given OperationStatus." }, { "name": "resourceId", "value": "", "type": "query", "description": "The ID of the resource affected by the work request." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "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 can be provided. By default, the order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Gets the work request status.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets details of the work request with the given ID." }, { "info": { "name": "Cancels work request.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancels the work request with the given ID." }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. By default, the order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of errors for the work request with the given ID.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "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": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided. By default, the order for timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." } ] }, "docs": "Returns a (paginated) list of logs for the work request with the given ID.\n" } ] } ], "bundled": true }