[Index]
Model ref.: device/cuc/ConnectionLocation
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"KeypadMapId": {
"minItems": 0,
"type": "integer",
"description": " The keypad map used by this location. The keypad map specifies the numeric keys to which the letters Q and Z are assigned to on the phone. This is specified during Cisco Unity Connection setup.",
"name": "KeypadMapId",
"title": "Keypad Map Id"
},
"SmtpUnknownRecipientAction": {
"minItems": 0,
"type": "integer",
"description": " Action to take for an SMTP message with an unknown recipient.",
"name": "SmtpUnknownRecipientAction",
"title": "Smtp Unknown Recipient Action"
},
"AllowCrossBoxTransfer": {
"minItems": 0,
"type": "boolean",
"description": " Allow cross-box transfer from the local server to this location.",
"name": "AllowCrossBoxTransfer",
"title": "Allow Cross Box Transfer"
},
"SkinnyLocalCACertificateFileName": {
"minItems": 0,
"type": "string",
"description": " The file name that should be assigned to the SkinnyLocalCACertificate to install the certificate on the Cisco Unified Communications Manager server(s). Installing the certificate on the CCM servers causes CCM to trust any Skinny device certificates signed by it, which is what we need to establish TLS Skinny connections to the CCM servers in the cluster. ",
"name": "SkinnyLocalCACertificateFileName",
"title": "Skinny Local CA Certificate File Name"
},
"ReplicationSet": {
"minItems": 0,
"type": "integer",
"description": " Identifies the replication set we are currently sending to this remote node.",
"name": "ReplicationSet",
"title": "Replication Set"
},
"VoiceName": {
"minItems": 0,
"type": "string",
"description": "The name of the WAV file containing the recorded voice name for the location The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName",
"title": "Voice Name"
},
"TransferDialString": {
"minItems": 0,
"type": "string",
"description": " The phone number that a local Cisco Unity Connection VMS server dials to transfer a call to this Cisco Unity Connection VMS server. ",
"name": "TransferDialString",
"title": "Transfer Dial String"
},
"LocalPhonePrefix": {
"minItems": 0,
"type": "string",
"description": " The number that is used to construct addresses for Cisco Unity Connection subscribers who send messages to individuals who use the voice messaging system that corresponds to this delivery location.\n\nOn outgoing messages from Cisco Unity Connection subscribes to subscribers at this VPIM location, the prefix is added to the beginning of the sender mailbox number to form the From address. \n\nOn incoming messages to Cisco Unity Connection subscribers from subscribers at this VPIM location, the prefix is removed from the beginning of the recipient mailbox number to form the To address.",
"name": "LocalPhonePrefix",
"title": "Local Phone Prefix"
},
"IncludeLocations": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether locations are included in searches. If set on the LocationVMS, the conversation will include locations in the search results.",
"name": "IncludeLocations",
"title": "Include Locations"
},
"SystemVersion": {
"minItems": 0,
"type": "string",
"description": " Tracks the version of software running on nodes in a digital network. Used to help construct synchronization messages compatible with the software running on the remote nodes.",
"name": "SystemVersion",
"title": "System Version"
},
"DestinationType": {
"minItems": 0,
"type": "integer",
"description": " For delivery locations, the destination type for that location, e.g. Connection, Unity, VPIM, Bridge.",
"name": "DestinationType",
"title": "Destination Type"
},
"DefaultPartitionObjectId": {
"target_title": "Name",
"description": "The unique identifier of the default Partition for this LocationVms. Setup populates this value when it creates the default Partition for the system.",
"title": "Default Partition",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/Partition/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/Partition",
"type": "string",
"name": "DefaultPartitionObjectId"
},
"LastUSNAck": {
"minItems": 0,
"type": "integer",
"description": " Keeps track of the USN of the last change acknowledged by this node.",
"name": "LastUSNAck",
"title": "Last USN Ack"
},
"EncryptionKey": {
"minItems": 0,
"type": "string",
"description": " Holds the pointer to the encryption key for this network node.",
"name": "EncryptionKey",
"title": "Encryption Key"
},
"Status": {
"minItems": 0,
"type": "integer",
"description": " This is used to stop two processes from deleting a location at the same time.",
"name": "Status",
"title": "Status"
},
"DefaultWaveFormatObjectId": {
"target_title": "ServerName",
"description": "The unique identifier of the WaveFormat object that specifies the wave format in which recorded messages are stored if the requested format is not available on the system.",
"title": "Default Wave Format",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/TBD/choices/?choice_title=ServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/TBD",
"type": "string",
"name": "DefaultWaveFormatObjectId"
},
"SmtpDomain": {
"minItems": 0,
"type": "string",
"description": " The domain portion (right-half) of an internet-addressable address (for example, london.cisco.com). This is used to form a user's, contact's, and distribution list's SMTP address (tbl_Alias.SmtpAddress).",
"name": "SmtpDomain",
"title": "Smtp Domain"
},
"DtmfName": {
"minItems": 0,
"type": "string",
"description": " The series of digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the display name of the location. These digits are used for searching the location by name via the phone.",
"name": "DtmfName",
"title": "Dtmf Name"
},
"CrossBoxDialString": {
"minItems": 0,
"type": "string",
"description": " For cross-box operations, the dial string that should be used to reach this location.",
"name": "CrossBoxDialString",
"title": "Cross Box Dial String"
},
"DefaultLanguage": {
"minItems": 0,
"type": "integer",
"description": " Default language for subscribers and call handlers.",
"name": "DefaultLanguage",
"title": "Default Language"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"format": "uri",
"minItems": 0,
"title": "Voice Name URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MaxContacts": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of contacts that can be created for this location.",
"name": "MaxContacts",
"title": "Max Contacts"
},
"DefaultWaveFormatURI": {
"name": "DefaultWaveFormatURI",
"format": "uri",
"minItems": 0,
"title": "Default Wave Format URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CrossBoxMaxRings": {
"minItems": 0,
"type": "integer",
"description": " For cross-box operations, the maximum number of rings that should be used to reach this location.",
"name": "CrossBoxMaxRings",
"title": "Cross Box Max Rings"
},
"PushState": {
"minItems": 0,
"type": "integer",
"description": " Indicates the current state of push replication from the local node to the node associated with this row in the table.",
"name": "PushState",
"title": "Push State"
},
"IsPrimary": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this location object is the \"primary\" location, which cannot be deleted. (Used to prevent deletion of factory defaults.)",
"name": "IsPrimary",
"title": "Is Primary"
},
"SmtpSmartHost": {
"minItems": 0,
"type": "string",
"description": " IP address or host name of SMTP smart host. ",
"name": "SmtpSmartHost",
"title": "Smtp Smart Host"
},
"DefaultPartitionURI": {
"name": "DefaultPartitionURI",
"format": "uri",
"minItems": 0,
"title": "Default Partition URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferTimeout": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in milliseconds) the local Cisco Unity Connection VMS server will wait for a response from this Cisco Unity Connection VMS server after this Cisco Unity Connection VMS server has answered the call. If this VMS server does not respond within the specified time period, a prompt is played that says that the Cisco Unity Connection VMS server could not be reached, and the call is transferred to the opening greeting of the local Cisco Unity Connection VMS server.",
"name": "TransferTimeout",
"title": "Transfer Timeout"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a Location object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"LastUSNSent": {
"minItems": 0,
"type": "integer",
"description": " Keeps track of the USN of the last change sent to the node.",
"name": "LastUSNSent",
"title": "Last USN Sent"
},
"PushDirectory": {
"minItems": 0,
"type": "boolean",
"description": " Indicates whether we are pushing the directory of the local node to the remote node identified by this record.",
"name": "PushDirectory",
"title": "Push Directory"
},
"PullState": {
"minItems": 0,
"type": "integer",
"description": " Indicates the current state of pull replication from the remote node associated with this row in the table to the local node.",
"name": "PullState",
"title": "Pull State"
},
"UseSmartSmtpHost": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the Unity Connection SMTP server forwards messages to the SMTP Smart Host for delivery.",
"name": "UseSmartSmtpHost",
"title": "Use Smart Smtp Host"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeZone": {
"minItems": 0,
"type": "integer",
"description": " The TimeZone associated with this VMS.",
"name": "TimeZone",
"title": "Time Zone"
},
"SkinnyLocalCACertificate": {
"minItems": 0,
"type": "string",
"description": " The X.509 certificate formatted as a PEM format string (base-64 encoded).",
"name": "SkinnyLocalCACertificate",
"title": "Skinny Local CA Certificate"
},
"SynchronizationUserURI": {
"name": "SynchronizationUserURI",
"format": "uri",
"minItems": 0,
"title": "Synchronization User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ReplicationSetIncoming": {
"minItems": 0,
"type": "integer",
"description": " Identifies the replication set we are currently receiving from this remote node.",
"name": "ReplicationSetIncoming",
"title": "Replication Set Incoming"
},
"HostAddress": {
"minItems": 0,
"type": "string",
"name": "HostAddress",
"title": "Host Address"
},
"TransferNumberOfRings": {
"minItems": 0,
"type": "integer",
"description": " The number of rings the local Cisco Unity Connection VMS server waits for this Cisco Unity Connection VMS server to answer. If this Cisco Unity Connection VMS server does not answer after the specified number of rings, a prompt is played that says that the Cisco Unity Connection VMS server could not be reached, and the call is transferred to the opening greeting of the local Cisco Unity Connection VMS server.",
"name": "TransferNumberOfRings",
"title": "Transfer Number Of Rings"
},
"CrossBoxResponseTimeout": {
"minItems": 0,
"type": "integer",
"description": " For cross-box operations, the delay in seconds to wait for a response from this location after sending the DTMF sequence.",
"name": "CrossBoxResponseTimeout",
"title": "Cross Box Response Timeout"
},
"DefaultTTSLanguage": {
"minItems": 0,
"type": "integer",
"description": " Default language to use for TTS playback.",
"name": "DefaultTTSLanguage",
"title": "Default TTS Language"
},
"PullDirectory": {
"minItems": 0,
"type": "boolean",
"description": " Indicates whether we are pulling the directory of the remote node identified by this record to the local node.",
"name": "PullDirectory",
"title": "Pull Directory"
},
"SkinnyLocalCAPrivateKey": {
"minItems": 0,
"type": "string",
"description": " The RSA private key matching the public key in SkinnyDeviceCertificate in PEM format (base-64 encoded string).",
"name": "SkinnyLocalCAPrivateKey",
"title": "Skinny Local CA Private Key"
},
"AllowCrossBoxLogin": {
"minItems": 0,
"type": "boolean",
"description": " Allow cross-box login from the local server to this location.",
"name": "AllowCrossBoxLogin",
"title": "Allow Cross Box Login"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"format": "uri",
"minItems": 0,
"title": "Voice File URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LastUSNReceived": {
"minItems": 0,
"type": "integer",
"description": " Keeps track of the USN of the last change received from the node.",
"name": "LastUSNReceived",
"title": "Last USN Received"
},
"DefaultSearchSpaceObjectId": {
"target_title": "Name",
"description": "The unique identifier of the default SearchSpace for this LocationVms. Setup populates this value when it creates the default SearchSpace for the system.",
"title": "Search Space",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/SearchSpace/choices/?choice_title=Name&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/SearchSpace",
"type": "string",
"name": "DefaultSearchSpaceObjectId"
},
"DefaultSearchSpaceURI": {
"name": "DefaultSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Default Search Space URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"CrossBoxSendDelay": {
"minItems": 0,
"type": "integer",
"description": " For cross-box operations, the delay in milliseconds before sending the DTMF sequence after connecting to this location.",
"name": "CrossBoxSendDelay",
"title": "Cross Box Send Delay"
},
"SynchronizationUserObjectId": {
"target_title": "ServerName",
"description": "Holds the user object ID of the account used to send and receive synchronization messages between nodes in the digital network.",
"title": "Synchronization User",
"minItems": 0,
"format": "uri",
"choices": [],
"target_attr": "ObjectId",
"target": "/api/device/cuc/TBD/choices/?choice_title=ServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cuc/TBD",
"type": "string",
"name": "SynchronizationUserObjectId"
},
"LastDirectoryPushDate": {
"minItems": 0,
"type": "string",
"description": " The date at which we last pushed to this remote network node.",
"name": "LastDirectoryPushDate",
"title": "Last Directory Push Date"
},
"LastDirectoryPullDate": {
"minItems": 0,
"type": "string",
"description": " The date at which we last pulled from this remote network node.",
"name": "LastDirectoryPullDate",
"title": "Last Directory Pull Date"
},
"MaxGreetingLength": {
"minItems": 0,
"type": "integer",
"description": " The maximum length (in seconds) allowed for recording a system greeting. ",
"name": "MaxGreetingLength",
"title": "Max Greeting Length"
},
"DtmfAccessId": {
"minItems": 0,
"type": "string",
"description": "The DTMF access id for the VMS. The dialable number.",
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The unique text name of this Location, e.g. \"Seattle Office.\" Used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"AgcTargetDb": {
"minItems": 0,
"type": "integer",
"description": " The average decibel (dB) level that a recorded message should have after application of automatic gain control (AGC). This is the \"nominal gain\" for all recordings processed by AGC. ",
"name": "AgcTargetDb",
"title": "Agc Target Db"
},
"ReplicationSetOutgoing": {
"minItems": 0,
"type": "integer",
"description": " Identifies the replication set we are currently sending to this remote node.",
"name": "ReplicationSetOutgoing",
"title": "Replication Set Outgoing"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/ConnectionLocation/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/ConnectionLocation/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/ConnectionLocation/[pkid1]", "/api/v0/device/cuc/ConnectionLocation/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/ConnectionLocation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/ConnectionLocation |
|
{"hrefs": ["/api/device/cuc/ConnectionLocation/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/ConnectionLocation |
|
{"hrefs": ["/api/device/cuc/ConnectionLocation/[pkid1]", "/api/device/cuc/ConnectionLocation/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/ConnectionLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/ConnectionLocation/export/ |
|
{ "hrefs":["/api/device/cuc/ConnectionLocation/[pkid1]", "/api/device/cuc/ConnectionLocation/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/ConnectionLocation and the JSON format can be used to import instances of device/cuc/ConnectionLocation.
GET http://[host-proxy]/api/device/cuc/ConnectionLocation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/ConnectionLocation | POST | /api/device/cuc/ConnectionLocation/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/ConnectionLocation/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/ConnectionLocation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/ConnectionLocation/ |
|
The device/cuc/ConnectionLocation schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/ConnectionLocation instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/ConnectionLocation/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/ConnectionLocation/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/ConnectionLocation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConnectionLocation/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cuc/ConnectionLocation/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/ConnectionLocation/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/ConnectionLocation/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/ConnectionLocation/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConnectionLocation/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConnectionLocation/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConnectionLocation",
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae6a2ce894e0012058898",
"meta": {
"tags": [],
"cached": true,
"title": "cucm",
"business_key": {},
"schema_version": "11.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6a2ce894e0012058898",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6a2ce894e0012058898/?model_type=device/cuc/ConnectionLocation",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConnectionLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6a2ce894e0012058898"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"KeypadMapId": 1,
"SmtpUnknownRecipientAction": 0,
"AllowCrossBoxTransfer": false,
"ReplicationSet": 0,
"IncludeLocations": true,
"SystemVersion": "11.5.1.2083",
"DestinationType": 1,
"DefaultPartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"hierarchy_friendly_name": "AB_Group (Customer)",
"LastUSNAck": 0,
"EncryptionKey": "0e39b776-ccad-49e4-8290-b5720de89d33",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"Status": 0,
"DefaultWaveFormatObjectId": "8961a48d-085d-4023-a4b4-6f682f8a8578",
"SmtpDomain": "cucm",
"DtmfName": "2826",
"DefaultLanguage": 1033,
"MaxContacts": 150000,
"DefaultWaveFormatURI": "/vmrest/waveformats/8961a48d-085d-4023-a4b4-6f682f8a8578",
"CrossBoxMaxRings": 4,
"PushState": 0,
"IsPrimary": true,
"SmtpSmartHost": "smarthost.smtp.com",
"DefaultPartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"TransferTimeout": 5000,
"ObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LastUSNSent": 0,
"PushDirectory": false,
"PullState": 0,
"UseSmartSmtpHost": false,
"URI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"TimeZone": 140,
"SynchronizationUserURI": "/vmrest/users/0d6504f6-5256-4c63-b7b8-86dbfdd91331",
"ReplicationSetIncoming": 0,
"HostAddress": "192.168.100.20",
"TransferNumberOfRings": 4,
"CrossBoxResponseTimeout": 5,
"DefaultTTSLanguage": 1033,
"PullDirectory": false,
"AllowCrossBoxLogin": false,
"LastUSNReceived": 0,
"DefaultSearchSpaceObjectId": "74b4757d-3e96-4776-8749-037c094a6d3c",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"DefaultSearchSpaceURI": "/vmrest/searchspaces/74b4757d-3e96-4776-8749-037c094a6d3c",
"CrossBoxSendDelay": 200,
"SynchronizationUserObjectId": "0d6504f6-5256-4c63-b7b8-86dbfdd91331",
"MaxGreetingLength": 90,
"DisplayName": "cucm",
"AgcTargetDb": -26,
"ReplicationSetOutgoing": 0
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6a2ce894e0012058898",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "cucm",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6a2ce894e0012058898",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6a2ce894e0012058898/?hierarchy=[hierarchy]&model_type=device/cuc/ConnectionLocation",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConnectionLocation/5f3ae6a2ce894e0012058898/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConnectionLocation",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6a2ce894e0012058898"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"KeypadMapId": 1,
"SmtpUnknownRecipientAction": 0,
"AllowCrossBoxTransfer": false,
"ReplicationSet": 0,
"IncludeLocations": true,
"SystemVersion": "11.5.1.2083",
"DestinationType": 1,
"DefaultPartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"LastUSNAck": 0,
"EncryptionKey": "0e39b776-ccad-49e4-8290-b5720de89d33",
"Status": 0,
"DefaultWaveFormatObjectId": "8961a48d-085d-4023-a4b4-6f682f8a8578",
"SmtpDomain": "cucm",
"DtmfName": "2826",
"DefaultLanguage": 1033,
"MaxContacts": 150000,
"DefaultWaveFormatURI": "/vmrest/waveformats/8961a48d-085d-4023-a4b4-6f682f8a8578",
"CrossBoxMaxRings": 4,
"PushState": 0,
"IsPrimary": true,
"SmtpSmartHost": "smarthost.smtp.com",
"DefaultPartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"TransferTimeout": 5000,
"ObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LastUSNSent": 0,
"PushDirectory": false,
"PullState": 0,
"UseSmartSmtpHost": false,
"URI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"TimeZone": 140,
"SynchronizationUserURI": "/vmrest/users/0d6504f6-5256-4c63-b7b8-86dbfdd91331",
"ReplicationSetIncoming": 0,
"HostAddress": "192.168.100.20",
"TransferNumberOfRings": 4,
"CrossBoxResponseTimeout": 5,
"DefaultTTSLanguage": 1033,
"PullDirectory": false,
"AllowCrossBoxLogin": false,
"LastUSNReceived": 0,
"DefaultSearchSpaceObjectId": "74b4757d-3e96-4776-8749-037c094a6d3c",
"DefaultSearchSpaceURI": "/vmrest/searchspaces/74b4757d-3e96-4776-8749-037c094a6d3c",
"CrossBoxSendDelay": 200,
"SynchronizationUserObjectId": "0d6504f6-5256-4c63-b7b8-86dbfdd91331",
"MaxGreetingLength": 90,
"DisplayName": "cucm",
"AgcTargetDb": -26,
"ReplicationSetOutgoing": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/ConnectionLocation. | GET | /api/device/cuc/ConnectionLocation/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/ConnectionLocation as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/ConnectionLocation/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/ConnectionLocation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/ConnectionLocation | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/ConnectionLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/ConnectionLocation/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cuc/ConnectionLocation and the JSON format can be used to import instances of device/cuc/ConnectionLocation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/ConnectionLocation/[pkid] | hierarchy=[hierarchy] | The device/cuc/ConnectionLocation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/ConnectionLocation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/ConnectionLocation. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/ConnectionLocation/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |