API Reference for device/cuc/VpimLocation

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

GET http://[host-proxy]/api/device/cuc/VpimLocation/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "EnableAutoUpdateContactDisplayName": {
               "minItems": 0, 
               "title": "Enable Auto Update Contact Display Name", 
               "type": "boolean", 
               "description": " A flag indicating whether a contact's display name is updated when a contact is automatically updated. ", 
               "name": "EnableAutoUpdateContactDisplayName"
          }, 
          "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"
          }, 
          "AutoCreateDisplayNameRule": {
               "minItems": 0, 
               "title": "Auto Create Display Name Rule", 
               "type": "string", 
               "description": " Indicates how text names on incoming messages will be mapped to the display name for auto-created contacts.\n\nA value of NULL indicates the text name is mapped directly to the display name of the contact.\nA non-null value indicates this is a custom rule that defines the mapping of the text name to the display name. Example: <FirstName>, <LastName>", 
               "name": "AutoCreateDisplayNameRule"
          }, 
          "EnableAutoDeleteContact": {
               "minItems": 0, 
               "title": "Enable Auto Delete Contact", 
               "type": "boolean", 
               "description": " A flag indicating whether a contact is automatically deleted when an NDR is received.", 
               "name": "EnableAutoDeleteContact"
          }, 
          "VoiceName": {
               "minItems": 0, 
               "title": "Voice Name", 
               "type": "string", 
               "description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.", 
               "name": "VoiceName"
          }, 
          "AudioFormatOutgoing": {
               "minItems": 0, 
               "title": "Audio Format Outgoing", 
               "type": "integer", 
               "description": " An enumeration indicating whether VPIM messages from Unity to the remote system corresponding to this location should be converted to another audio format.", 
               "name": "AudioFormatOutgoing"
          }, 
          "LocalPhonePrefix": {
               "minItems": 0, 
               "title": "Local Phone Prefix", 
               "type": "string", 
               "description": " The number used to construct addresses for contacts who use the voice messaging system that corresponds to this location. NULL is allowed.", 
               "name": "LocalPhonePrefix"
          }, 
          "DestinationType": {
               "minItems": 0, 
               "title": "Destination Type", 
               "type": "integer", 
               "description": " For delivery locations, the destination type for that location, e.g. Connection, Unity, VPIM, Bridge.", 
               "name": "DestinationType"
          }, 
          "LastDirectoryPushDate": {
               "minItems": 0, 
               "title": "Last Directory Push Date", 
               "type": "string", 
               "description": " The time and date of the last manual directory push to this VPIM location.\n\nNULL indicates no push has taken place.", 
               "name": "LastDirectoryPushDate"
          }, 
          "IpAddress": {
               "minItems": 0, 
               "type": "string", 
               "name": "IpAddress", 
               "title": "Ip Address"
          }, 
          "PartitionObjectId": {
               "minItems": 0, 
               "title": "Partition Object Id", 
               "type": "string", 
               "description": " The unique identifier of the Partition to which the DtmfAccessId is assigned.", 
               "name": "PartitionObjectId"
          }, 
          "UseSmartSmtpHost": {
               "minItems": 0, 
               "title": "Use Smart Smtp Host", 
               "type": "boolean", 
               "description": " A flag indicating whether the Unity Connection SMTP server forwards messages to the SMTP Smart Host for delivery.\n\nValues:\n0:  Do not forward to SMTP Smart Host\n1:  Forward message to SMTP Smart Host\n", 
               "name": "UseSmartSmtpHost"
          }, 
          "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"
          }, 
          "DtmfName": {
               "minItems": 0, 
               "title": "Dtmf Name", 
               "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"
          }, 
          "EnableAGC": {
               "minItems": 0, 
               "title": "Enable AGC", 
               "type": "boolean", 
               "description": " A flag indicating whether Cisco Unity Connection should apply software-based gain control to messages received from this VPIM location.", 
               "name": "EnableAGC"
          }, 
          "VoiceNameURI": {
               "name": "VoiceNameURI", 
               "title": "Voice Name URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "IncludeSenderVoiceName": {
               "minItems": 0, 
               "title": "Include Sender Voice Name", 
               "type": "boolean", 
               "description": " A flag indicating whether Unity adds the sender?s recorded voice name to an outgoing VPIM message.", 
               "name": "IncludeSenderVoiceName"
          }, 
          "LocationObjectId": {
               "minItems": 0, 
               "title": "Location Object Id", 
               "type": "string", 
               "description": " Points to the LocationVMS record identifying where this VPIM location was created.", 
               "name": "LocationObjectId"
          }, 
          "AllowBlindAddressing": {
               "minItems": 0, 
               "title": "Allow Blind Addressing", 
               "type": "boolean", 
               "description": " A flag indicating whether messages can be addressed to this location without an existing handler or subscriber.", 
               "name": "AllowBlindAddressing"
          }, 
          "VoiceFileURI": {
               "name": "VoiceFileURI", 
               "title": "Voice File URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "SearchSpaceObjectId": {
               "minItems": 0, 
               "title": "Search Space Object Id", 
               "type": "string", 
               "description": " The unique identifier of the SearchSpace that determines the Partition(s) that are searched to find the recipient of an incoming VPIM message to a user.", 
               "name": "SearchSpaceObjectId"
          }, 
          "EnableAutoCreateNoVoiceName": {
               "minItems": 0, 
               "title": "Enable Auto Create No Voice Name", 
               "type": "boolean", 
               "description": " A flag indicating whether a contact may be automatically created/updated when the incoming VPIM message does not include a recorded voice name.", 
               "name": "EnableAutoCreateNoVoiceName"
          }, 
          "EnableOutgoingSecureMessages": {
               "minItems": 0, 
               "title": "Enable Outgoing Secure Messages", 
               "type": "boolean", 
               "description": " A flag indicating whether outgoing messages can be marked \"Secure.\"", 
               "name": "EnableOutgoingSecureMessages"
          }, 
          "EnableOutgoingPrivateMessages": {
               "minItems": 0, 
               "title": "Enable Outgoing Private Messages", 
               "type": "boolean", 
               "description": " A flag indicating whether outgoing messages can be marked \"Private.\"", 
               "name": "EnableOutgoingPrivateMessages"
          }, 
          "SearchSpaceURI": {
               "name": "SearchSpaceURI", 
               "title": "Search Space URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "EnableAutoCreateContact": {
               "minItems": 0, 
               "title": "Enable Auto Create Contact", 
               "type": "boolean", 
               "description": " A flag indicating whether a contact is automatically created when messages are received from senders at this location.", 
               "name": "EnableAutoCreateContact"
          }, 
          "AudioFormatIncoming": {
               "minItems": 0, 
               "title": "Audio Format Incoming", 
               "type": "integer", 
               "description": " An enumeration indicating whether incoming VPIM messages from the remote system corresponding to this location should be converted to another audio format.", 
               "name": "AudioFormatIncoming"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a VPIM location. - template parameter [1]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "PushDirectory": {
               "minItems": 0, 
               "title": "Push Directory", 
               "type": "boolean", 
               "description": " Tells SMTP service whether or not to execute a manual directory push to this VPIM location.", 
               "name": "PushDirectory"
          }, 
          "ContactTemplateObjectId": {
               "minItems": 0, 
               "title": "Contact Template Object Id", 
               "type": "string", 
               "description": " The template upon which to base new contacts created whose destination for messages is this LocationVPIM.", 
               "name": "ContactTemplateObjectId"
          }, 
          "URI": {
               "name": "URI", 
               "title": "URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "ListContactsInDirectory": {
               "minItems": 0, 
               "title": "List Contacts In Directory", 
               "type": "boolean", 
               "description": " A flag indicating whether a contact should be listed in the phone directory for outside callers, when a contact is automatically created.  Default value is 0. \n\nValues:\n0:  Do not list contact in directory\n1:  List contact in directory\n", 
               "name": "ListContactsInDirectory"
          }, 
          "AlternateNamesURI": {
               "title": "Alternate Names URI", 
               "type": "string", 
               "description": "The URI to get the alternate names of the VPIM location.", 
               "name": "AlternateNamesURI"
          }, 
          "EnableAutoUpdateContact": {
               "minItems": 0, 
               "title": "Enable Auto Update Contact", 
               "type": "integer", 
               "description": " An enumeration indicating whether a contact is automatically updated when messages are received from senders at this location, and if so, under what condition the contact is updated.", 
               "name": "EnableAutoUpdateContact"
          }, 
          "RemotePhonePrefix": {
               "minItems": 0, 
               "title": "Remote Phone Prefix", 
               "type": "string", 
               "description": " The number used to construct addresses for contacts who use the voice messaging system that corresponds to this location. NULL is allowed.", 
               "name": "RemotePhonePrefix"
          }, 
          "AutoCreateExtensionRule": {
               "minItems": 0, 
               "title": "Auto Create Extension Rule", 
               "type": "integer", 
               "description": " An enumeration indicating how the phone number on incoming VPIM messages should be mapped to the extension for the auto-created contact.", 
               "name": "AutoCreateExtensionRule"
          }, 
          "PartitionURI": {
               "name": "PartitionURI", 
               "title": "Partition URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "DtmfAccessId": {
               "minItems": 0, 
               "title": "Dtmf Access Id", 
               "type": "string", 
               "description": " The dialable number.", 
               "name": "DtmfAccessId"
          }, 
          "LocationURI": {
               "name": "LocationURI", 
               "title": "Location URI", 
               "minItems": 0, 
               "format": "uri", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }
     }, 
     "schema_version": "12.5"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/cuc/VpimLocation/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/cuc/VpimLocation 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/VpimLocation/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/VpimLocation/	hierarchy=[hierarchy]	{"hrefs":["/api/device/cuc/VpimLocation/[pkid1]", "/api/device/cuc/VpimLocation/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/cuc/VpimLocation
```
GET http://[host-proxy]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/VpimLocation/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/VpimLocation device/cuc/VpimLocation schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/VpimLocation/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/VpimLocation/[pkid1]", "/api/v0/device/cuc/VpimLocation/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
```
GET http://[host-proxy]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json
```
The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/VpimLocation	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/VpimLocation/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/VpimLocation	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/VpimLocation/[pkid1]", "/api/device/cuc/VpimLocation/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/VpimLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/VpimLocation/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/VpimLocation/[pkid1]", "/api/device/cuc/VpimLocation/[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/VpimLocation and the JSON format can be used to import instances of device/cuc/VpimLocation.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/cuc/VpimLocation:

 GET http://[host-proxy]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/VpimLocation	POST	/api/device/cuc/VpimLocation/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cuc/VpimLocation	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/VpimLocation/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/VpimLocation/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/cuc/VpimLocation/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/VpimLocation schema and all instances as JSON.

(The list will return 0 to 3 device/cuc/VpimLocation instances)

GET http://[host]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/VpimLocation/?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": "12.5", 
          "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/VpimLocation/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/VpimLocation/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/VpimLocation", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/VpimLocation/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/VpimLocation/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/VpimLocation/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/VpimLocation/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/VpimLocation/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/VpimLocation/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/VpimLocation", 
          "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": "20.1.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/VpimLocation.	GET	/api/device/cuc/VpimLocation/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/VpimLocation as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/cuc/VpimLocation/[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/VpimLocation/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/VpimLocation/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cuc/VpimLocation

GET http://[host-proxy]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/VpimLocation	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/VpimLocation; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/VpimLocation/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/VpimLocation and the JSON format can be used to import instances of device/cuc/VpimLocation.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/VpimLocation/[pkid]/	hierarchy=[hierarchy]	The device/cuc/VpimLocation instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/cuc/VpimLocation/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/cuc/VpimLocation.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cuc/VpimLocation/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/cuc/VpimLocation

GET http://[host-proxy]/api/device/cuc/VpimLocation/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cuc/VpimLocation/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge