[Index]
Model ref.: device/cuc/VnmapLocationHttps
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": {
"MediatorLocationObjectId": {
"minItems": 0,
"title": "Mediator Location Object Id",
"type": "string",
"description": " Location objectid of direclty connected locations",
"name": "MediatorLocationObjectId"
},
"Status": {
"minItems": 0,
"title": "Status",
"type": "integer",
"description": " Indicates the status of the directory synchronication with this location.(Idle or synching)",
"name": "Status"
},
"DirectorySynchronizationRole": {
"minItems": 0,
"title": "Directory Synchronization Role",
"type": "integer",
"description": " It specifies the directory synchronization mode in the cluster.",
"name": "DirectorySynchronizationRole"
},
"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"
},
"NeighbourLocationURI": {
"minItems": 0,
"title": "Neighbour Location URI",
"type": "string",
"name": "NeighbourLocationURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"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"
},
"IsVpimBridgehead": {
"minItems": 0,
"type": "boolean",
"name": "IsVpimBridgehead",
"title": "Is Vpim Bridgehead"
},
"TimeOfLastSync": {
"minItems": 0,
"title": "Time Of Last Sync",
"type": "string",
"description": " Reflects the time at which we last synchronized with the this location.",
"name": "TimeOfLastSync"
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"LastUsn": {
"minItems": 0,
"title": "Last Usn",
"type": "integer",
"description": " Last USN synched",
"name": "LastUsn"
},
"RetryQueueSizeCount": {
"minItems": 0,
"type": "integer",
"name": "RetryQueueSizeCount",
"title": "Retry Queue Size Count"
},
"MediatorLocationURI": {
"minItems": 0,
"title": "Mediator Location URI",
"type": "string",
"name": "MediatorLocationURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"HostAddress": {
"minItems": 0,
"type": "string",
"name": "HostAddress",
"title": "Host Address"
},
"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"
},
"LocationObjectId": {
"minItems": 0,
"title": "Location Object Id",
"type": "string",
"description": " The ObjectId of the network location.",
"name": "LocationObjectId"
},
"ReplicationSetId": {
"minItems": 0,
"title": "Replication Set Id",
"type": "string",
"description": " The remote ReplicationSet that this location is consuming.",
"name": "ReplicationSetId"
},
"IsPrimary": {
"minItems": 0,
"title": "Is Primary",
"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"
},
"LocationURI": {
"minItems": 0,
"title": "Location URI",
"type": "string",
"name": "LocationURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"VoiceNameSyncStatus": {
"minItems": 0,
"title": "Voice Name Sync Status",
"type": "integer",
"description": " Indicates the status of voice name synchronication with this location.",
"name": "VoiceNameSyncStatus"
},
"MaxUsn": {
"minItems": 0,
"title": "Max Usn",
"type": "integer",
"description": " Max usn recieved in feed response.",
"name": "MaxUsn"
},
"NeighbourLocationObjectId": {
"minItems": 0,
"title": "Neighbour Location Object Id",
"type": "string",
"description": " Location objectid of immediately connected location.",
"name": "NeighbourLocationObjectId"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/VnmapLocationHttps/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/VnmapLocationHttps/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/VnmapLocationHttps/[pkid1]", "/api/v0/device/cuc/VnmapLocationHttps/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/VnmapLocationHttps/?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/VnmapLocationHttps |
|
{"hrefs": ["/api/device/cuc/VnmapLocationHttps/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/VnmapLocationHttps |
|
{"hrefs": ["/api/device/cuc/VnmapLocationHttps/[pkid1]", "/api/device/cuc/VnmapLocationHttps/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/VnmapLocationHttps; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/VnmapLocationHttps/export/ |
|
{ "hrefs":["/api/device/cuc/VnmapLocationHttps/[pkid1]", "/api/device/cuc/VnmapLocationHttps/[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/VnmapLocationHttps and the JSON format can be used to import instances of device/cuc/VnmapLocationHttps.
GET http://[host-proxy]/api/device/cuc/VnmapLocationHttps/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/VnmapLocationHttps | POST | /api/device/cuc/VnmapLocationHttps/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/VnmapLocationHttps/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/VnmapLocationHttps/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/VnmapLocationHttps/ |
|
The device/cuc/VnmapLocationHttps schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/VnmapLocationHttps instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/cuc/VnmapLocationHttps/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/VnmapLocationHttps",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/VnmapLocationHttps/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/VnmapLocationHttps",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/VnmapLocationHttps/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/VnmapLocationHttps/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/VnmapLocationHttps/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/VnmapLocationHttps/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/VnmapLocationHttps/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/VnmapLocationHttps/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/VnmapLocationHttps/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"MediatorLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Status": 0,
"DirectorySynchronizationRole": 0,
"DisplayName": "cucm",
"NeighbourLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"IsVpimBridgehead": false,
"NeighbourLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"URI": "/vmrest/vnmaplocationhttpses/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LastUsn": 0,
"RetryQueueSizeCount": 0,
"MediatorLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"HostAddress": "192.168.100.20",
"DestinationType": 1,
"IsPrimary": true,
"VoiceNameSyncStatus": 0,
"MaxUsn": 0,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/VnmapLocationHttps",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "cucm",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/",
"pkid": "5ae8a01faffa931cce390913"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a01faffa931cce390913"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a01faffa931cce390913/?model_type=device/cuc/VnmapLocationHttps",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a01faffa931cce390913"
},
{
"data": {
"MediatorLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Status": 0,
"DirectorySynchronizationRole": 0,
"DisplayName": "cucm",
"NeighbourLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"IsVpimBridgehead": false,
"NeighbourLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"URI": "/vmrest/vnmaplocationhttpses/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LastUsn": 0,
"RetryQueueSizeCount": 0,
"MediatorLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"HostAddress": "192.168.100.21",
"DestinationType": 1,
"IsPrimary": true,
"VoiceNameSyncStatus": 0,
"MaxUsn": 0,
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/VnmapLocationHttps",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "cucm",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ef8affa931cce38ca95",
"pkid": "5ae89ef8affa931cce38ca95"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/",
"pkid": "5ae8a030affa931cce390cc2"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a030affa931cce390cc2"
],
"schema_version": "",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a030affa931cce390cc2/?model_type=device/cuc/VnmapLocationHttps",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a030affa931cce390cc2/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a030affa931cce390cc2"
}
]
}
(Show the first instance)
{
"data": {
"MediatorLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Status": 0,
"DirectorySynchronizationRole": 0,
"DisplayName": "cucm",
"NeighbourLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"IsVpimBridgehead": false,
"MaxUsn": 0,
"URI": "/vmrest/vnmaplocationhttpses/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"LastUsn": 0,
"RetryQueueSizeCount": 0,
"MediatorLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"HostAddress": "192.168.100.20",
"DestinationType": 1,
"IsPrimary": true,
"VoiceNameSyncStatus": 0,
"NeighbourLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
},
"meta": {
"model_type": "device/cuc/VnmapLocationHttps",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "cucm",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/",
"pkid": "5ae8a01faffa931cce390913"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a01faffa931cce390913"
],
"schema_version": "11.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a01faffa931cce390913/?hierarchy=[hierarchy]&model_type=device/cuc/VnmapLocationHttps",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/VnmapLocationHttps/5ae8a01faffa931cce390913/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a01faffa931cce390913"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/VnmapLocationHttps. | GET | /api/device/cuc/VnmapLocationHttps/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/VnmapLocationHttps as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/VnmapLocationHttps/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/VnmapLocationHttps/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/VnmapLocationHttps/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/VnmapLocationHttps | 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/VnmapLocationHttps; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/VnmapLocationHttps/[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/VnmapLocationHttps and the JSON format can be used to import instances of device/cuc/VnmapLocationHttps.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/VnmapLocationHttps/[pkid] | hierarchy=[hierarchy] | The device/cuc/VnmapLocationHttps instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/VnmapLocationHttps/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/VnmapLocationHttps. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/VnmapLocationHttps/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |