{ "opencollection": "1.0.0", "info": { "name": "Oracle Content Management Oce Instance API", "version": "20190912" }, "items": [ { "info": { "name": "oceInstance", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all OceInstances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190912/oceInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The ID of the tenancy in which to list resources." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n" }, { "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" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter results on lifecycleState." } ] }, "docs": "Returns a list of OceInstances.\n" }, { "info": { "name": "Creates a new OceInstance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190912/oceInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new OceInstance.\n" }, { "info": { "name": "Get OceInstance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190912/oceInstances/:oceInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "oceInstanceId", "value": "", "type": "path", "description": "unique OceInstance identifier" } ] }, "docs": "Gets a OceInstance by identifier" }, { "info": { "name": "Update the OceInstance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190912/oceInstances/:oceInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "oceInstanceId", "value": "", "type": "path", "description": "unique OceInstance identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the OceInstance" }, { "info": { "name": "Delete a provisioned OceInstance", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190912/oceInstances/:oceInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "oceInstanceId", "value": "", "type": "path", "description": "unique OceInstance identifier" } ] }, "docs": "Deletes a OceInstance resource by identifier" }, { "info": { "name": "Moves a OceInstance into a different compartment. When provided, If-Match is checked against ETag values of the OceInstance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190912/oceInstances/:oceInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "oceInstanceId", "value": "", "type": "path", "description": "unique OceInstance identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a OceInstance into a different compartment" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190912/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": "resourceId", "value": "", "type": "query", "description": "The resource Identifier for which to list resources." }, { "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." } ] }, "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/20190912/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190912/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." } ] }, "docs": "Return 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/20190912/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." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }