{ "opencollection": "1.0.0", "info": { "name": "Notifications Notification Control Plane API", "version": "20181201" }, "items": [ { "info": { "name": "notificationControlPlane", "type": "folder" }, "items": [ { "info": { "name": "ListPublisherMapGroups", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the publisher map groups in the specified compartment.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "CreatePublisherMapGroup", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "oci-splat-generated-ocids", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a publisher map group.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "GetPublisherMapGroup", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups/:publisherMapGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "publisherMapGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map group to retrieve.\n" } ] }, "docs": "Gets the specified publisher map group's configuration information.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "UpdatePublisherMapGroup", "type": "http" }, "http": { "method": "PUT", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups/:publisherMapGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "oci-splat-store-request-token", "value": "" } ], "params": [ { "name": "publisherMapGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map group to update.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified PublisherMapGroup's configuration.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "DeletePublisherMapGroup", "type": "http" }, "http": { "method": "DELETE", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups/:publisherMapGroupId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map group to delete.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified publisher map group.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "Adds a lock to a PublisherMapGroup resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups/:publisherMapGroupId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map group.\n" } ] }, "docs": "Adds a lock to a PublisherMapGroup resource." }, { "info": { "name": "Removes a lock to a PublisherMapGroup resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMapGroups/:publisherMapGroupId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map group.\n" } ] }, "docs": "Removes a lock from a PublisherMapGroup resource." }, { "info": { "name": "ListPublisherMaps", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the publisher maps in the specified compartment.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "CreatePublisherMap", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "oci-splat-generated-ocids", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a publisher map.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "GetPublisherMap", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps/:publisherMapId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "publisherMapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map to retrieve.\n" } ] }, "docs": "Gets the specified publisher map's configuration information.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "UpdatePublisherMap", "type": "http" }, "http": { "method": "PUT", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps/:publisherMapId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "oci-splat-store-request-token", "value": "" } ], "params": [ { "name": "publisherMapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map to update.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified PublisherMap's configuration.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "DeletePublisherMap", "type": "http" }, "http": { "method": "DELETE", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps/:publisherMapId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map to delete.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified publisher map.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "Adds a lock to a PublisherMap resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps/:publisherMapId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map.\n" } ] }, "docs": "Adds a lock to a PublisherMap resource." }, { "info": { "name": "Removes a lock to a PublisherMap resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/publisherMaps/:publisherMapId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publisherMapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the publisher map.\n" } ] }, "docs": "Removes a lock from a PublisherMap resource." }, { "info": { "name": "ListTopics", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/topics", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, { "name": "id", "value": "", "type": "query", "description": "A filter to only return resources that match the given id exactly.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to only return resources that match the given name exactly.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one field can be selected for sorting.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use (ascending or descending).\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter returned list by specified lifecycle state. This parameter is case-insensitive.\n" } ] }, "docs": "Lists topics in the specified compartment.\nFor instructions, see\n[Listing Topics](/iaas/Content/Notification/Tasks/list-topic.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n" }, { "info": { "name": "CreateTopic", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/topics", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" }, { "name": "oci-splat-generated-ocids", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a topic in the specified compartment.\nFor instructions, see\n[Creating a Topic](/iaas/Content/Notification/Tasks/create-topic.htm).\n\nFor the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.\nFor information about access control and compartments, see [Overview of the IAM Service](/Content/Identity/Concepts/overview.htm).\n\nYou must specify a display name for the topic.\n\nAll Oracle Cloud Infrastructure resources, including topics, ge" }, { "info": { "name": "GetTopic", "type": "http" }, "http": { "method": "GET", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n" } ] }, "docs": "Gets the specified topic's configuration information.\nFor instructions, see\n[Getting a Topic's Details](/iaas/Content/Notification/Tasks/get-topic.htm).\n" }, { "info": { "name": "UpdateTopic", "type": "http" }, "http": { "method": "PUT", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" }, { "name": "oci-splat-store-request-token", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified topic's configuration.\nFor instructions, see\n[Updating a Topic](/iaas/Content/Notification/Tasks/update-topic.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "DeleteTopic", "type": "http" }, "http": { "method": "DELETE", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the specified topic.\nFor instructions, see\n[Deleting a Topic](/iaas/Content/Notification/Tasks/delete-topic.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "Adds a lock to a Topic resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a topic." } ] }, "docs": "Adds a lock to a Topic resource." }, { "info": { "name": "ChangeTopicCompartment", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-oci-nap-corpnetwork", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.\n" }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a topic into a different compartment within the same tenancy.\nFor instructions, see\n[Moving a Topic](/iaas/Content/Notification/Tasks/change-compartment-topic.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n" }, { "info": { "name": "Removes a lock to a Topic resource.", "type": "http" }, "http": { "method": "POST", "url": "https://notification.{region}.oraclecloud.com/20181201/topics/:topicId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "topicId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of a topic." } ] }, "docs": "Removes a lock from a Topic resource." } ] } ], "bundled": true }