{ "opencollection": "1.0.0", "info": { "name": "Oracle Work Requests API", "version": "1.0" }, "items": [ { "info": { "name": "workRequests", "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 ocid of the compartment in which to list resources." }, { "name": "resourceId", "value": "", "type": "query", "description": "Filter work requests by the resource ocid." }, { "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'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Gets 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 ocid of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given identifier." }, { "info": { "name": "Cancel the work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ocid of the asynchronous request." } ] }, "docs": "Cancels the work request." }, { "info": { "name": "Lists 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 ocid 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": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n" } ] }, "docs": "Returns a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists 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 ocid 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": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n" } ] }, "docs": "Returns a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }