[Index]
Model ref.: device/cuc/Branch
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": { "UserName": { "minItems": 0, "title": "User Name", "type": "string", "description": " The UserName for central unity connection to be used by branch.", "name": "UserName" }, "PartitionObjectId": { "minItems": 0, "title": "Partition Object Id", "type": "string", "description": " Primary key for the table Partition. This will be used to map the particular partition against the Branch.", "name": "PartitionObjectId" }, "SyncGreetings": { "minItems": 0, "title": "Sync Greetings", "type": "boolean", "description": " This field indicates if the personal greetings for the users of this branch will be sent to the actual branch, while provisioning", "name": "SyncGreetings" }, "PartitionURI": { "name": "PartitionURI", "title": "Partition URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "SmtpDomain": { "minItems": 0, "title": "Smtp Domain", "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" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a Branch. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "IsDisabled": { "minItems": 0, "title": "Is Disabled", "type": "boolean", "description": " Flag to indicate whether the branch is enabled or not", "name": "IsDisabled" }, "URI": { "name": "URI", "title": "URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "OperatorObjectId": { "minItems": 0, "title": "Operator Object Id", "type": "string", "description": " The is used to store the Branch's operator.", "name": "OperatorObjectId" }, "DisplayName": { "minItems": 0, "title": "Display Name", "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" }, "ServerAddress": { "minItems": 0, "title": "Server Address", "type": "string", "description": " This is used to store the FQDN of a branch", "name": "ServerAddress" }, "SyncVoiceName": { "minItems": 0, "title": "Sync Voice Name", "type": "boolean", "description": " This field indicates if the voice name for the users of this branch will be sent to the actual branch, while provisioning", "name": "SyncVoiceName" }, "VmUploadState": { "minItems": 0, "title": "Vm Upload State", "type": "integer", "description": " This column indicates about the current VM Upload state of the branch. It can have values like: Idle, In-progress.", "name": "VmUploadState" }, "IsAlive": { "minItems": 0, "title": "Is Alive", "type": "boolean", "description": " The live status of Branch is maintained in this column.", "name": "IsAlive" }, "Password": { "minItems": 0, "title": "Password", "type": "string", "description": " The Password for central unity connection to be used by branch.", "name": "Password" }, "Port": { "minItems": 0, "title": "Port", "type": "integer", "description": " To be used by Central Unity Connection for creating a connection with Branch.", "name": "Port" }, "ProvisionState": { "minItems": 0, "title": "Provision State", "type": "integer", "description": " This column indicates about the current provisioning state of the branch. It can have values like: Idle, In-progress, Scheduled", "name": "ProvisionState" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/Branch/add/ |
|
The GUI Add form of device/cuc/Branch as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/cuc/Branch/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cuc/Branch/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/Branch/[pkid1]", "/api/device/cuc/Branch/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/Branch/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/Branch/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/Branch/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Branch/[pkid1]", "/api/v0/device/cuc/Branch/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Branch/?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/Branch |
|
{"hrefs": ["/api/device/cuc/Branch/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Branch |
|
{"hrefs": ["/api/device/cuc/Branch/[pkid1]", "/api/device/cuc/Branch/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Branch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Branch/export/ |
|
{ "hrefs":["/api/device/cuc/Branch/[pkid1]", "/api/device/cuc/Branch/[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/Branch and the JSON format can be used to import instances of device/cuc/Branch.
GET http://[host-proxy]/api/device/cuc/Branch/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Branch | POST | /api/device/cuc/Branch/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/Branch/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/Branch/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/Branch/ |
|
The device/cuc/Branch schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Branch instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/Branch/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/Branch/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Branch/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/Branch/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/Branch", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Branch/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/Branch/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/Branch/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/Branch/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/Branch/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Branch/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Branch/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Branch", "model_specific_actions": [ "add", "list", "update", "get", "remove", "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" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/Branch. | GET | /api/device/cuc/Branch/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Branch as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/Branch/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cuc/Branch/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Branch/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Branch/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Branch | 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/Branch; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Branch/[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/Branch and the JSON format can be used to import instances of device/cuc/Branch.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/Branch/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/Branch instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/Branch/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Branch. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/Branch/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |