Webex · Schema

ListReport

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique report ID that corresponds to a billing report.
billingPeriod string The year and month (`YYYY-MM`) for which the billing report was generated.
status string The status of the billing report. * `IN_PROGRESS` - Report generation is in progress. * `COMPLETED` - Report generation is complete. * `FAILED` - Report generation failed.
View JSON Schema on GitHub

JSON Schema

webex-listreport-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListReport",
  "title": "ListReport",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "'Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA'",
      "description": "A unique report ID that corresponds to a billing report."
    },
    "billingPeriod": {
      "type": "string",
      "example": "2021-05",
      "description": "The year and month (`YYYY-MM`) for which the billing report was generated."
    },
    "status": {
      "type": "string",
      "enum": [
        "IN_PROGRESS",
        "COMPLETED",
        "FAILED"
      ],
      "description": "The status of the billing report.\n * `IN_PROGRESS` - Report generation is in progress.\n * `COMPLETED` - Report generation is complete.\n * `FAILED` - Report generation failed.\n"
    }
  }
}