{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Subscriptions API", "version": "1.0.0" }, "items": [ { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V1 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization." }, { "info": { "name": "Register Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope." }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope." }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "List Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/event-types", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve all available event types for an organization. Requires `cjp:config_read` scope." }, { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V2 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization." }, { "info": { "name": "Register Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope." }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope." }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "List Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/event-types", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization." } ] }, "docs": "Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires `cjp:config_read` scope. " } ] } ], "bundled": true }