{ "opencollection": "1.0.0", "info": { "name": "Gateway Subscribers API", "version": "20190501" }, "items": [ { "info": { "name": "subscribers", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all subscribers in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/subscribers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ocid 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": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state.\nExample: `ACTIVE`\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'. 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 list of subscribers." }, { "info": { "name": "Creates a new subscriber.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/subscribers", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new subscriber." }, { "info": { "name": "Get subscriber.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." } ] }, "docs": "Gets a subscriber by identifier." }, { "info": { "name": "Update the subscriber.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the subscriber with the given identifier." }, { "info": { "name": "Delete a provisioned subscriber.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the subscriber with the given identifier." }, { "info": { "name": "Adds a lock to a Subscriber resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." } ] }, "docs": "Adds a lock to a Subscriber resource." }, { "info": { "name": "Change the subscriber compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the subscriber compartment." }, { "info": { "name": "Removes a lock to a Subscriber resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/subscribers/:subscriberId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "subscriberId", "value": "", "type": "path", "description": "The ocid of the subscriber." } ] }, "docs": "Removes a lock from a Subscriber resource." } ] } ], "bundled": true }