[Index]
Model ref.: device/cuc/GlobalUser
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": {
"City": {
"minItems": 0,
"type": "string",
"description": " The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated.",
"name": "City",
"title": "City"
},
"VoiceName": {
"minItems": 0,
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName",
"title": "Voice Name"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"FirstName": {
"minItems": 0,
"type": "string",
"description": " The first name (i.e., givenName) of this user. Not their surname nor middle name.",
"name": "FirstName",
"title": "First Name"
},
"LastName": {
"minItems": 0,
"type": "string",
"description": " The last name (i.e., surname or family name) of this user, by which a user is commonly known.",
"name": "LastName",
"title": "Last Name"
},
"Department": {
"minItems": 0,
"type": "string",
"description": " The name or number for the department or subdivision of an organization to which a person belongs.",
"name": "Department",
"title": "Department"
},
"PartitionURI": {
"name": "PartitionURI",
"format": "uri",
"minItems": 0,
"title": "Partition URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AltLastName": {
"minItems": 0,
"type": "string",
"description": " The alternate spelling of a user last name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.",
"name": "AltLastName",
"title": "Alt Last Name"
},
"PartitionObjectId": {
"minItems": 0,
"type": "string",
"description": " This column shadows the object's primary dtmfaccessid partionobjectid from tbl_DtmfAccessId. It was added to speed up queries.",
"name": "PartitionObjectId",
"title": "Partition Object Id"
},
"DtmfNameLastFirst": {
"minItems": 0,
"type": "string",
"description": " The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the last name of the user. These digits are used for searching the user by name via the phone.",
"name": "DtmfNameLastFirst",
"title": "Dtmf Name Last First"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"format": "uri",
"minItems": 0,
"title": "Voice Name URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the LocationVMS object to which this user belongs.",
"name": "LocationObjectId",
"title": "Location Object Id"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a GlobalUser object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"IsTemplate": {
"minItems": 0,
"type": "boolean",
"description": " Indicated whether this global user object refers to a template.",
"name": "IsTemplate",
"title": "Is Template"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Alias": {
"minItems": 0,
"type": "string",
"description": " This column shadows the object's primary alias from tbl_Alias. It was added to speed up queries.",
"name": "Alias",
"title": "Alias"
},
"DtmfNameFirstLast": {
"minItems": 0,
"type": "string",
"description": " The digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the first name of the user. These digits are used for searching the user by name via the phone.",
"name": "DtmfNameFirstLast",
"title": "Dtmf Name First Last"
},
"XferString": {
"minItems": 0,
"type": "string",
"description": " The cross-server transfer extension. If NULL, the user's primary extension is used.",
"name": "XferString",
"title": "Xfer String"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"format": "uri",
"minItems": 0,
"title": "Voice File URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AltFirstName": {
"minItems": 0,
"type": "string",
"description": " The alternate spelling of a user first name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing, and for VUI client name lookup.",
"name": "AltFirstName",
"title": "Alt First Name"
},
"DtmfAccessId": {
"minItems": 0,
"type": "string",
"description": " This column shadows the object's primary dtmfaccessid from tbl_DtmfAccessId. It was added to speed up queries.",
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
"ListInDirectory": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection should list the subscriber in the phone directory for outside callers.",
"name": "ListInDirectory",
"title": "List In Directory"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/GlobalUser/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/GlobalUser/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/GlobalUser/[pkid1]", "/api/v0/device/cuc/GlobalUser/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/GlobalUser/?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/GlobalUser |
|
{"hrefs": ["/api/device/cuc/GlobalUser/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/GlobalUser |
|
{"hrefs": ["/api/device/cuc/GlobalUser/[pkid1]", "/api/device/cuc/GlobalUser/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/GlobalUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/GlobalUser/export/ |
|
{ "hrefs":["/api/device/cuc/GlobalUser/[pkid1]", "/api/device/cuc/GlobalUser/[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/GlobalUser and the JSON format can be used to import instances of device/cuc/GlobalUser.
GET http://[host-proxy]/api/device/cuc/GlobalUser/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/GlobalUser | POST | /api/device/cuc/GlobalUser/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/GlobalUser/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/GlobalUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/GlobalUser/ |
|
The device/cuc/GlobalUser schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/GlobalUser instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/GlobalUser/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 14
},
"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": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/GlobalUser/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/GlobalUser",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/GlobalUser/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/GlobalUser/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/GlobalUser/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/GlobalUser/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/GlobalUser/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/GlobalUser/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/GlobalUser/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/GlobalUser",
"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": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3af406ce894e001208d0e2",
"meta": {
"tags": [],
"cached": true,
"title": "Andy Carstel",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af406ce894e001208d0e2",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/"
}
],
"parent": [
{
"pkid": "5f3ae64ace894e0012057585",
"href": "/api/data/HierarchyNode/5f3ae64ace894e0012057585"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af406ce894e001208d0e2/?model_type=device/cuc/GlobalUser",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/GlobalUser",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae64ace894e0012057585",
"5f3af406ce894e001208d0e2"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ObjectId": "8ad159de-365f-4325-98fe-a1c2690dcbf1",
"FirstName": "Andy",
"LastName": "Carstel",
"DtmfNameLastFirst": "22778352639",
"IsTemplate": false,
"URI": "/vmrest/globalusers/8ad159de-365f-4325-98fe-a1c2690dcbf1",
"DtmfAccessId": "8201102",
"Alias": "acarstel01",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ListInDirectory": true,
"DtmfNameFirstLast": "26392277835",
"Department": "Finance",
"DisplayName": "Andy Carstel",
"hierarchy_friendly_name": "CL1-AB-C-Hannover (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Hannover"
}
},
{
"pkid": "5f3af396ce894e001208b9a2",
"meta": {
"tags": [],
"cached": true,
"title": "Andy Dervers",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af396ce894e001208b9a2",
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/"
}
],
"parent": [
{
"pkid": "5f3ae62dce894e0012056f66",
"href": "/api/data/HierarchyNode/5f3ae62dce894e0012056f66"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af396ce894e001208b9a2/?model_type=device/cuc/GlobalUser",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/GlobalUser/5f3af396ce894e001208b9a2/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/GlobalUser",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae62dce894e0012056f66",
"5f3af396ce894e001208b9a2"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ObjectId": "9d2a8c05-ca81-4553-9a55-9d65896d50ab",
"FirstName": "Andy",
"LastName": "Dervers",
"DtmfNameLastFirst": "33783772639",
"IsTemplate": false,
"URI": "/vmrest/globalusers/9d2a8c05-ca81-4553-9a55-9d65896d50ab",
"DtmfAccessId": "8127002",
"Alias": "adervers01",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ListInDirectory": true,
"DtmfNameFirstLast": "26393378377",
"Department": "Engineering",
"DisplayName": "Andy Dervers",
"hierarchy_friendly_name": "CL1-AB-C-Rennes (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Rennes"
}
},
{
"pkid": "5f3af25ece894e001208798c",
"meta": {
"tags": [],
"cached": true,
"title": "Frances Gertrand",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3af25ece894e001208798c",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/"
}
],
"parent": [
{
"pkid": "5f3ae621ce894e0012056c72",
"href": "/api/data/HierarchyNode/5f3ae621ce894e0012056c72"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5f3af25ece894e001208798c/?model_type=device/cuc/GlobalUser",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/GlobalUser/5f3af25ece894e001208798c/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/GlobalUser",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae621ce894e0012056c72",
"5f3af25ece894e001208798c"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ObjectId": "b4622f27-b945-4c65-847f-689b5faa681b",
"FirstName": "Frances",
"LastName": "Gertrand",
"DtmfNameLastFirst": "437872633726237",
"IsTemplate": false,
"URI": "/vmrest/globalusers/b4622f27-b945-4c65-847f-689b5faa681b",
"DtmfAccessId": "8115502",
"Alias": "fgertrand01",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ListInDirectory": true,
"DtmfNameFirstLast": "372623743787263",
"Department": "Sales",
"DisplayName": "Frances Gertrand",
"hierarchy_friendly_name": "CL1-AB-C-Grenoble (Site)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Grenoble"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3af406ce894e001208d0e2",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Andy Carstel",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae64ace894e0012057585",
"href": "/api/data/HierarchyNode/5f3ae64ace894e0012057585"
}
],
"self": [
{
"pkid": "5f3af406ce894e001208d0e2",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/"
}
],
"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/GlobalUser/5f3af406ce894e001208d0e2/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3af406ce894e001208d0e2/?hierarchy=[hierarchy]&model_type=device/cuc/GlobalUser",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/GlobalUser/5f3af406ce894e001208d0e2/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/GlobalUser",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5bace894e00120559f8",
"5f3ae64ace894e0012057585",
"5f3af406ce894e001208d0e2"
],
"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": "19.3.1",
"tagged_versions": []
},
"data": {
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"ObjectId": "8ad159de-365f-4325-98fe-a1c2690dcbf1",
"FirstName": "Andy",
"LastName": "Carstel",
"DtmfNameLastFirst": "22778352639",
"IsTemplate": false,
"URI": "/vmrest/globalusers/8ad159de-365f-4325-98fe-a1c2690dcbf1",
"DtmfAccessId": "8201102",
"Alias": "acarstel01",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ListInDirectory": true,
"DtmfNameFirstLast": "26392277835",
"Department": "Finance",
"DisplayName": "Andy Carstel",
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/GlobalUser. | GET | /api/device/cuc/GlobalUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/GlobalUser as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/GlobalUser/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/GlobalUser/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/GlobalUser | 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/GlobalUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/GlobalUser/[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/GlobalUser and the JSON format can be used to import instances of device/cuc/GlobalUser.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/GlobalUser/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/GlobalUser instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/GlobalUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/GlobalUser. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/GlobalUser/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |