Webex · Schema

SiteDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. It is required to define for the following operations - All bulk save operations
id	string	ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version	integer	The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name	string	Indicates the name of the site. Generally, it is the name of the geographical location. It is required only during a create or an update operation.
active	boolean	Indicates the status of the site whether it is active(when true) or not active(when false). It is required only during a create or an update operation.
multimediaProfileId	string	Indicates the multimedia profile for the site. It is required only during a create or an update operation.
description	string
systemDefault	boolean	Indicates whether the created resource is system created or not
createdTime	integer	Creation time(in epoch millis) of this resource.
lastUpdatedTime	integer	Time(in epoch millis) when this resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SiteDTO",
  "title": "SiteDTO",
  "required": [
    "active",
    "multimediaProfileId",
    "name"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "name": {
      "maxLength": 80,
      "minLength": 1,
      "pattern": "^[a-zA-Z\\d-_\\s]+$",
      "type": "string",
      "description": "Indicates the name of the site. Generally, it is the name of the geographical location. It is required only during a create or an update operation.",
      "example": "California"
    },
    "active": {
      "type": "boolean",
      "description": "Indicates the status of the site whether it is active(when true) or not active(when false). It is required only during a create or an update operation.",
      "example": true
    },
    "multimediaProfileId": {
      "type": "string",
      "description": "Indicates the multimedia profile for the site. It is required only during a create or an update operation.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string"
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  }
}