{ "opencollection": "1.0.0", "info": { "name": "Oracle Work Request API", "version": "1.0" }, "items": [ { "info": { "name": "workRequest", "type": "folder" }, "items": [ { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The ID of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only work requests with 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": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "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 may be provided. Default order for timeAccepted is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/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": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/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 a work request." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/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": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "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 may be provided. Default order for timestamp 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": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/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": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "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 may be provided. Default order for timestamp 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" }, { "info": { "name": "Reruns a failed work request based on a work request id.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId/actions/rerun", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reruns a failed work for the specified work request [OCID](/iaas/Content/General/Concepts/identifiers.htm). Rerunning restarts the work on failed targets.\n" } ] } ], "bundled": true }