{ "opencollection": "1.0.0", "info": { "name": "Visual Builder Studio Vbs Instance API", "version": "20180828" }, "items": [ { "info": { "name": "vbsInstance", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all VbsInstances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/vbsInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "id", "value": "", "type": "query", "description": "unique VbsInstance identifier" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "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 VbsInstances.\n" }, { "info": { "name": "Creates a new VbsInstance", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/vbsInstances", "headers": [ { "name": "idcs-access-token", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new VbsInstance.\n" }, { "info": { "name": "Get VbsInstance", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/vbsInstances/:vbsInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbsInstanceId", "value": "", "type": "path", "description": "unique VbsInstance identifier" } ] }, "docs": "Gets a VbsInstance by identifier" }, { "info": { "name": "Update the VbsInstance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20180828/vbsInstances/:vbsInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbsInstanceId", "value": "", "type": "path", "description": "unique VbsInstance identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the VbsInstance" }, { "info": { "name": "Delete a provisioned VbsInstance", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20180828/vbsInstances/:vbsInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbsInstanceId", "value": "", "type": "path", "description": "unique VbsInstance identifier" } ] }, "docs": "Deletes a VbsInstance resource by identifier" }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180828/vbsInstances/:vbsInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbsInstanceId", "value": "", "type": "path", "description": "unique VbsInstance identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a VbsInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180828/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": "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/20180828/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/20180828/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 timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "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/20180828/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 timeAccepted is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }