Webex · Schema

AddressBookBulkExportDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string The id for the address book in the bulk export request.
name string A name for the address book in the bulk export request.
description string A short description indicating the context of the address book.
parentSite string The specific site id where the address book is accessible.
entryDetails array
View JSON Schema on GitHub

JSON Schema

webex-addressbookbulkexportdto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddressBookBulkExportDTO",
  "title": "AddressBookBulkExportDTO",
  "required": [
    "id",
    "name"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The id for the address book in the bulk export request.",
      "example": "HNI-Customers"
    },
    "name": {
      "type": "string",
      "description": "A name for the address book in the bulk export request.",
      "example": "HNI-Customers"
    },
    "description": {
      "type": "string",
      "description": "A short description indicating the context of the address book.",
      "example": "Phone number of all HNI customers"
    },
    "parentSite": {
      "type": "string",
      "description": "The specific site id where the address book is accessible.",
      "example": "c7b3665d-b386-4267-8397-1331f2a26018"
    },
    "entryDetails": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AddressBookEntryDetailsDTO"
      }
    }
  }
}