{ "opencollection": "1.0.0", "info": { "name": "Announcements Service Announcement Subscription API", "version": "0.0.1" }, "items": [ { "info": { "name": "announcementSubscription", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of announcement subscriptions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180904/announcementSubscriptions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only announcement subscriptions that match the given lifecycle state." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "id", "value": "", "type": "query", "description": "The OCID of the announcement subscription." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether ascending ('ASC') or descending ('DESC')." }, { "name": "sortBy", "value": "", "type": "query", "description": "The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending.\n" } ] }, "docs": "Gets a list of all announcement subscriptions in the specified compartment.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests p" }, { "info": { "name": "Creates a new announcement subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180904/announcementSubscriptions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.\n" }, { "info": { "name": "Gets an announcement subscription.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." } ] }, "docs": "Gets the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy." }, { "info": { "name": "Updates an announcement subscription.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenan" }, { "info": { "name": "Deletes a provisioned announcement subscription.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." } ] }, "docs": "Deletes the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenan" }, { "info": { "name": "Moves an announcement subscription to a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to rej" }, { "info": { "name": "Creates a new filter group in an announcement subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId/filterGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new filter group in the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per se" }, { "info": { "name": "Updates a filter group in an announcement subscription.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId/filterGroups/:filterGroupName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." }, { "name": "filterGroupName", "value": "", "type": "path", "description": "The name of the filter group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a filter group in the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second" }, { "info": { "name": "Deletes a filter group in an announcement subscription.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20180904/announcementSubscriptions/:announcementSubscriptionId/filterGroups/:filterGroupName", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "announcementSubscriptionId", "value": "", "type": "path", "description": "The OCID of the announcement subscription." }, { "name": "filterGroupName", "value": "", "type": "path", "description": "The name of the filter group." } ] }, "docs": "Deletes a filter group in the specified announcement subscription.\n\nThis call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second" } ] } ], "bundled": true }