{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Data Sources API", "version": "1.0.0" }, "items": [ { "info": { "name": "Data Sources", "type": "folder" }, "items": [ { "info": { "name": "Register a Data Source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dataSources", "body": { "type": "json", "data": "{}" } }, "docs": "Register your data source to the Webex BYODS system. Authentication must happen via a Service App with the scope `spark-admin:datasource_write`.\nThe schema IDs determine what data types are sent from Webex to the DAP and the expected responses. The schemas can be inspected on developer.webex.com." }, { "info": { "name": "Retrieve All Data Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/" }, "docs": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`." }, { "info": { "name": "Retrieve Data Source Schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/schemas" }, "docs": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented." }, { "info": { "name": "Retrieve Details of a Specific Data Source Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "78efc775-dccb-45ca-9acf-989a4a59f788", "type": "path", "description": "The unique identifier for the schema." } ] }, "docs": "Retrieve details of a specific data source schema by schema id. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented." }, { "info": { "name": "Retrieve Data Source Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the dataSource." } ] }, "docs": "Show details for a data source, by dataSource id.\nTo see details for a data source, use the Service App token with the `spark-admin:datasource_read` scope." }, { "info": { "name": "Update a Data Source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Data Source. The updateable fields are the `audience,` `subject,` `nonce,` `url` and `tokenLifetimeMinutes.`\nYou can update the `status` from `active` to `disabled` only when providing an `errorMessage` that may be shown to the customer admin in Control Hub. \nTokens must be regularly updated before their expiration to maintain system uptime." }, { "info": { "name": "Delete a Data Source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the dataSource." } ] }, "docs": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI." } ] } ], "bundled": true }