CAA Tenants are External Lync Systems Content-Type: application/vnd.plcm.plcm-caa-tenant-v2+xml. All attributes are used in ETag calculation except for entity-tag, atom-link, mcu-pool-queue-name, conference-template-name, and virtual-entry-queues.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| caaTenantIdentifier | string | Internal identifier. Provided to protect against a name update. | |
| name | Name | A meaningful name for the CAA Tenant. This field is mandatory. Max size 128 characters. | Mandatory |
| description | Description | A brief description of the CAA Tenant. Max size 128 characters. | |
| caaPrefix | CaaPrefix | The dialed prefix for use with this tenant. Prefixes must be unique, and at most one tenant may use a blank prefix, in which case, all dial strings in a dial rule that include the blank prefix will match, and no further dial rules will be tried. | |
| dialInSipUri | DialInSipUri | The SIP URI for the CAA Tenant. | Mandatory |
| conferenceTemplateKeyValue | int | The conference template key for use with this CAA Tenant. | |
| conferenceTemplateName | ConferenceTemplateName | The name of the conference template with this key. This is provided only for readability, and is neither required nor used when setting the CAA Tenant Conference Template. | |
| mcuPoolQueueUid | McuPoolQueueUid | The UID of the MCU Pool Order to use with this CAA Tenant | |
| mcuPoolQueueName | McuPoolQueueName | The name of the MCU Pool Order in use with this CAA Tenant. This is provided only for readability, and is neither required nor used when setting the CAA Tenant MCU Pool Order. | |
| mcuFirstCallerMcuAffinity | boolean | If the first caller's site contains MCUs in the designated MCU pool order, start the conference on one of them. | |
| virtualEntryQueues | Array of string | A list of Virtual Entry Queues that use this CaaTenant. This is provided only for readability, and is neither required nor used when updating or creating a CAA Tenant. | |
| passback | Passback | User defined value for that is opaque to the system | |
| overrideDefaultConferenceTemplateKeyValue | boolean | When true, conference-template-key-value must be specified in the request. When false, conference-template-key-value value will be determined by the system default. | |
| overrideDefaultMcuPoolQueueUid | boolean | When true, mcu-pool-queue-uid must be specified in the request. When false, mcu-pool-queue-uid value will be determined by the system default. | |
| overrideDefaultFirstCallerMcuAffinity | boolean | When true, mcu-first-caller-mcu-affinity must be specified in the request. When false, mcu-first-caller-mcu-affinity value will be determined by the system default. | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| Passback | string | Length of value must be >=1 Length of value must be <=512 |
| McuPoolQueueName | string | Length of value must be >=0 Length of value must be <=128 |
| McuPoolQueueUid | string | Length of value must be >=0 Length of value must be <=128 |
| ConferenceTemplateName | string | Length of value must be >=0 Length of value must be <=128 |
| DialInSipUri | string | Length of value must be >=0 Length of value must be <=128 |
| CaaPrefix | Length of value must be >=0 Length of value must be <=8 | |
| Description | string | Length of value must be >=0 Length of value must be <=128 |
| Name | string | Length of value must be >=1 Length of value must be <=128 |
| T0 | string | Pattern of value must match the regular expression [0-9]* |