{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Reports API", "version": "1.0.0" }, "items": [ { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "List Reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports", "params": [ { "name": "reportId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE", "type": "query", "description": "List reports by ID." }, { "name": "service", "value": "Webex", "type": "query", "description": "List reports which use this service." }, { "name": "templateId", "value": "5", "type": "query", "description": "List reports with this report template ID." }, { "name": "from", "value": "2020-05-01", "type": "query", "description": "List reports that were created on or after this date." }, { "name": "to", "value": "2020-05-05", "type": "query", "description": "List reports that were created before this date." } ] }, "docs": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the" }, { "info": { "name": "Create a Report", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite service" }, { "info": { "name": "Get Report Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:reportId", "params": [ { "name": "reportId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE", "type": "path", "description": "The unique identifier for the report." } ] }, "docs": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extens" }, { "info": { "name": "Delete a Report", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/reports/:reportId", "params": [ { "name": "reportId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE", "type": "path", "description": "The unique identifier for the report." } ] }, "docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports." } ] } ], "bundled": true }