[Index]
Model ref.: device/cuc/DistributionListMember
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": {
"MemberDistributionListObjectId": {
"minItems": 0,
"title": "Member Distribution List Object Id",
"type": "string",
"description": "The member of this distribution list. If the member is a virtual contact, the unique identifier of the VirtualContact object that is a member of the distribution list. Otherwise, this attribute is set to NULL. The member of this distribution list. If the member is another distribution list, the unique identifier of DistributionList object that is a member of the distribution list. Otherwise, this attribute is set ot NULL.",
"name": "MemberDistributionListObjectId"
},
"DistributionListObjectId": {
"description": " The unique identifier of the DistributionList object to which this distribution list member belongs. - template parameter [1]",
"name": "DistributionListObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/DistributionList",
"title": "Distribution List Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/DistributionList/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MemberLocationURI": {
"name": "MemberLocationURI",
"title": "Member Location URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"IsUserTemplate": {
"minItems": 0,
"title": "Is User Template",
"type": "boolean",
"description": "Indicated whether this global user object refers to a template.",
"name": "IsUserTemplate"
},
"MemberGlobalUserObjectId": {
"minItems": 0,
"title": "Member Global User Object Id",
"type": "string",
"description": " The member of this distribution list. If the member is a user, the ObjectId of the global user that is a member of the distribution list. Otherwise, this attribute is set ot NULL.",
"name": "MemberGlobalUserObjectId"
},
"AllowForeignMessage": {
"minItems": 0,
"title": "Allow Foreign Message",
"type": "boolean",
"description": " Controls if we allow foreign message systems to send to this particular distribution list. Only valid if the list is for subscribers only (i.e. does not allow contacts)",
"name": "AllowForeignMessage"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DistributionListMember object. - template parameter [2]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MemberDistributionListURI": {
"name": "MemberDistributionListURI",
"title": "Member Distribution List URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MemberGlobalUserURI": {
"name": "MemberGlobalUserURI",
"title": "Member Global User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MemberUserObjectId": {
"minItems": 0,
"title": "Member User Object Id",
"type": "string",
"description": " The primary key for this table. A globally unique, system-generated identifier for a GlobalUser object.",
"name": "MemberUserObjectId"
},
"DistributionListURI": {
"name": "DistributionListURI",
"title": "Distribution List URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Alias": {
"minItems": 0,
"title": "Alias",
"type": "string",
"description": "Alias of user, or null if member is a distribution list. The unique text name for either a user, distribution list, or personal group.",
"name": "Alias"
},
"MemberUserURI": {
"name": "MemberUserURI",
"title": "Member User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"LocationObjectId": {
"minItems": 0,
"title": "Location Object Id",
"type": "string",
"description": "Holds the location of the referenced member object. Taken from one of: tbl_GlobalUser, tbl_Contact, tbl_DistributionList.",
"name": "LocationObjectId"
},
"MemberContactURI": {
"name": "MemberContactURI",
"title": "Member Contact URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MemberLocationObjectId": {
"minItems": 0,
"title": "Member Location Object Id",
"type": "string",
"description": "Holds the location of the referenced member object. Taken from one of: tbl_GlobalUser, tbl_Contact, tbl_DistributionList.",
"name": "MemberLocationObjectId"
},
"MemberContactObjectId": {
"minItems": 0,
"title": "Member Contact Object Id",
"type": "string",
"description": "The member of this distribution list. If the member is a contact, the unique identifier of the Contact object that is a member of the distribution list. Otherwise, this attribute is set to NULL. The member of this distribution list. If the member is a contact, the unique identifier of the Contact object that is a member of the distribution list. Otherwise this attribute is set to NULL.",
"name": "MemberContactObjectId"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": "DisplayName of member (Subscriber or DistributionList)",
"name": "DisplayName"
},
"MemberGlobalUserDignetObjectId": {
"minItems": 0,
"title": "Member Global User Dignet Object Id",
"type": "string",
"description": " Digital Networking ObjectD",
"name": "MemberGlobalUserDignetObjectId"
},
"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": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/DistributionListMember/add/ |
|
The GUI Add form of device/cuc/DistributionListMember 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/DistributionListMember/ | 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/DistributionListMember/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/DistributionListMember/[pkid1]", "/api/device/cuc/DistributionListMember/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/DistributionListMember/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/DistributionListMember/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/DistributionListMember/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/DistributionListMember/[pkid1]", "/api/v0/device/cuc/DistributionListMember/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/DistributionListMember/?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/DistributionListMember |
|
{"hrefs": ["/api/device/cuc/DistributionListMember/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/DistributionListMember |
|
{"hrefs": ["/api/device/cuc/DistributionListMember/[pkid1]", "/api/device/cuc/DistributionListMember/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/DistributionListMember; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/DistributionListMember/export/ |
|
{ "hrefs":["/api/device/cuc/DistributionListMember/[pkid1]", "/api/device/cuc/DistributionListMember/[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/DistributionListMember and the JSON format can be used to import instances of device/cuc/DistributionListMember.
GET http://[host-proxy]/api/device/cuc/DistributionListMember/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/DistributionListMember | POST | /api/device/cuc/DistributionListMember/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/DistributionListMember/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/DistributionListMember/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/DistributionListMember/ |
|
The device/cuc/DistributionListMember schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/DistributionListMember instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/DistributionListMember/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 24
},
"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/DistributionListMember/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DistributionListMember/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/DistributionListMember/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/DistributionListMember",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DistributionListMember/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/DistributionListMember/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/DistributionListMember/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/DistributionListMember/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/DistributionListMember/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DistributionListMember/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DistributionListMember/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DistributionListMember",
"model_specific_actions": [
"add",
"list",
"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"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "63057b44c46e74b468824b41",
"meta": {
"tags": [],
"cached": true,
"title": "Adam Pjones",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057b44c46e74b468824b41",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057b44c46e74b468824b41/?model_type=device/cuc/DistributionListMember",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DistributionListMember",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057b44c46e74b468824b41"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DistributionListObjectId": "72bb6add-9352-4ae1-afe0-f24606a71fb0",
"MemberLocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"DisplayName": "Adam Pjones",
"ObjectId": "8f16b052-6669-4472-b24a-8a06672a360d",
"MemberGlobalUserURI": "/vmrest/globalusers/533a6851-0472-4a2c-b644-8a4cd2187a14",
"hierarchy": "6305775dc46e74b46881c66a",
"MemberUserObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"MemberUserURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14",
"IsUserTemplate": false,
"URI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0/distributionlistmembers/8f16b052-6669-4472-b24a-8a06672a360d",
"DistributionListURI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0",
"AllowForeignMessage": false,
"Alias": "Jones",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberLocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"MemberGlobalUserObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"hierarchy_friendly_name": "Overton (Customer)",
"MemberGlobalUserDignetObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "63057b44c46e74b468824b49",
"meta": {
"tags": [],
"cached": true,
"title": "Don Rich",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057b44c46e74b468824b49",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057b44c46e74b468824b49/?model_type=device/cuc/DistributionListMember",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b49/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/DistributionListMember",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057b44c46e74b468824b49"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DistributionListObjectId": "72bb6add-9352-4ae1-afe0-f24606a71fb0",
"MemberLocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"DisplayName": "Don Rich",
"ObjectId": "47aff17f-e26e-4774-b678-472eb89fccf1",
"MemberGlobalUserURI": "/vmrest/globalusers/db83873f-bb81-4529-b901-46e8c6318f0f",
"hierarchy": "6305775dc46e74b46881c66a",
"MemberUserObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"MemberUserURI": "/vmrest/users/db83873f-bb81-4529-b901-46e8c6318f0f",
"IsUserTemplate": false,
"URI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0/distributionlistmembers/47aff17f-e26e-4774-b678-472eb89fccf1",
"DistributionListURI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0",
"AllowForeignMessage": false,
"Alias": "drich01",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberLocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"MemberGlobalUserObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"hierarchy_friendly_name": "Overton (Customer)",
"MemberGlobalUserDignetObjectId": "db83873f-bb81-4529-b901-46e8c6318f0f",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "63057b44c46e74b468824b45",
"meta": {
"tags": [],
"cached": true,
"title": "jones, Vjones",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"self": [
{
"pkid": "63057b44c46e74b468824b45",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/63057b44c46e74b468824b45/?model_type=device/cuc/DistributionListMember",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b45/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DistributionListMember",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057b44c46e74b468824b45"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DistributionListObjectId": "72bb6add-9352-4ae1-afe0-f24606a71fb0",
"MemberLocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"DisplayName": "jones, Vjones",
"ObjectId": "e800da10-9d30-47c2-a9da-b96e0b8c6ed7",
"MemberGlobalUserURI": "/vmrest/globalusers/c3b26278-518b-4f1c-b236-e2b5ef871238",
"hierarchy": "6305775dc46e74b46881c66a",
"MemberUserObjectId": "c3b26278-518b-4f1c-b236-e2b5ef871238",
"MemberUserURI": "/vmrest/users/c3b26278-518b-4f1c-b236-e2b5ef871238",
"IsUserTemplate": false,
"URI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0/distributionlistmembers/e800da10-9d30-47c2-a9da-b96e0b8c6ed7",
"DistributionListURI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0",
"AllowForeignMessage": false,
"Alias": "Pjones",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberLocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"MemberGlobalUserObjectId": "c3b26278-518b-4f1c-b236-e2b5ef871238",
"hierarchy_friendly_name": "Overton (Customer)",
"MemberGlobalUserDignetObjectId": "c3b26278-518b-4f1c-b236-e2b5ef871238",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "63057b44c46e74b468824b41",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Adam Pjones",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"self": [
{
"pkid": "63057b44c46e74b468824b41",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"children": []
},
"actions": [
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63057b44c46e74b468824b41/?hierarchy=[hierarchy]&model_type=device/cuc/DistributionListMember",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DistributionListMember/63057b44c46e74b468824b41/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DistributionListMember",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"63057b44c46e74b468824b41"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"DistributionListObjectId": "72bb6add-9352-4ae1-afe0-f24606a71fb0",
"MemberLocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberGlobalUserDignetObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"DisplayName": "Adam Pjones",
"LocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"ObjectId": "8f16b052-6669-4472-b24a-8a06672a360d",
"MemberGlobalUserURI": "/vmrest/globalusers/533a6851-0472-4a2c-b644-8a4cd2187a14",
"IsUserTemplate": false,
"URI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0/distributionlistmembers/8f16b052-6669-4472-b24a-8a06672a360d",
"AllowForeignMessage": false,
"Alias": "Jones",
"DistributionListURI": "/vmrest/distributionlists/72bb6add-9352-4ae1-afe0-f24606a71fb0",
"LocationURI": "/vmrest/locations/connectionlocations/cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberLocationObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"MemberGlobalUserObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"MemberUserObjectId": "533a6851-0472-4a2c-b644-8a4cd2187a14",
"MemberUserURI": "/vmrest/users/533a6851-0472-4a2c-b644-8a4cd2187a14"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/DistributionListMember. | GET | /api/device/cuc/DistributionListMember/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/DistributionListMember as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cuc/DistributionListMember/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/DistributionListMember/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/DistributionListMember/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/DistributionListMember | 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/DistributionListMember; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/DistributionListMember/[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/DistributionListMember and the JSON format can be used to import instances of device/cuc/DistributionListMember.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/DistributionListMember/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/DistributionListMember instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/DistributionListMember/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/DistributionListMember. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/DistributionListMember/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |