{ "opencollection": "1.0.0", "info": { "name": "Control Plane Blockchain Platform API", "version": "20191010" }, "items": [ { "info": { "name": "blockchainPlatform", "type": "folder" }, "items": [ { "info": { "name": "List Blockchain Platforms", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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.\nExample: `My new resource`\n" }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "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 TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state.\nThe state value is case-insensitive.\n" } ] }, "docs": "Returns a list Blockchain Platform Instances in a compartment" }, { "info": { "name": "Creates a new Blockchain Platform", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Blockchain Platform.\n" }, { "info": { "name": "Get Blockchain Platform", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ] }, "docs": "Gets information about a Blockchain Platform identified by the specific id" }, { "info": { "name": "Update a Blockchain Platform", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a particular of a Blockchain Platform" }, { "info": { "name": "Delete a Blockchain Platform", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ] }, "docs": "Delete a particular of a Blockchain Platform" }, { "info": { "name": "Change Blockchain Platform Compartment", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change Blockchain Platform Compartment" }, { "info": { "name": "Scale Blockchain Platform", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/actions/scale", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scale Blockchain Platform" }, { "info": { "name": "Preview Scale Blockchain Platform", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/actions/scale/preview", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview Scale Blockchain Platform" }, { "info": { "name": "Start a Blockchain Platform", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ] }, "docs": "Start a Blockchain Platform" }, { "info": { "name": "Stop a Blockchain Platform", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ] }, "docs": "Stop a Blockchain Platform" }, { "info": { "name": "List Blockchain Platform OSNs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/osns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nExample: `My new resource`\n" }, { "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": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "List Blockchain Platform OSNs" }, { "info": { "name": "Create Blockchain Platform OSN", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/osns", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Blockchain Platform Osn" }, { "info": { "name": "Get Blockchain Platform OSN", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/osns/:osnId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "osnId", "value": "", "type": "path", "description": "OSN identifier." } ] }, "docs": "Gets information about an OSN identified by the specific id" }, { "info": { "name": "Update Blockchain Platform OSN", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/osns/:osnId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "osnId", "value": "", "type": "path", "description": "OSN identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Blockchain Platform OSN" }, { "info": { "name": "Delete a Blockchain Platform Osn", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/osns/:osnId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "osnId", "value": "", "type": "path", "description": "OSN identifier." } ] }, "docs": "Delete a particular OSN of a Blockchain Platform" }, { "info": { "name": "List Blockchain Platform Peers", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/peers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nExample: `My new resource`\n" }, { "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": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "List Blockchain Platform Peers" }, { "info": { "name": "Create Blockchain Platform Peer", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/peers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Blockchain Platform Peer" }, { "info": { "name": "Get Blockchain Platform peer", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/peers/:peerId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "peerId", "value": "", "type": "path", "description": "Peer identifier." } ] }, "docs": "Gets information about a peer identified by the specific id" }, { "info": { "name": "Update a Blockchain Platform Peer", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/peers/:peerId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "peerId", "value": "", "type": "path", "description": "Peer identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Blockchain Platform Peer" }, { "info": { "name": "Delete a Blockchain Platform Peer", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20191010/blockchainPlatforms/:blockchainPlatformId/peers/:peerId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "blockchainPlatformId", "value": "", "type": "path", "description": "Unique service identifier." }, { "name": "peerId", "value": "", "type": "path", "description": "Peer identifier." } ] }, "docs": "Delete a particular peer of a Blockchain Platform" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/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": "blockchainPlatformId", "value": "", "type": "query", "description": "Unique service identifier." }, { "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 TIMESTARTED is descending. Default order for WORKREQUESTID is ascending. If no value is specified TIMESTARTED is default.\n" }, { "name": "page", "value": "", "type": "query", "description": "The page at which to start retrieving results." }, { "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/20191010/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": "DELETE Work Request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20191010/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Attempts to cancel the work request with the given ID." }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20191010/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 at which to start retrieving results." }, { "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/20191010/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 at which to start retrieving results." }, { "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 }