[Index]
Model ref.: device/cuc/SubscriberDependency
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": {
"DependentEntityObjectId": {
"minItems": 0,
"type": "string",
"description": "The unique identifier of the entity that is dependent on the user.",
"name": "DependentEntityObjectId",
"title": "Dependent Entity Object Id"
},
"SubscriberObjectId": {
"minItems": 0,
"type": "string",
"description": "The unique identifier of the user which this object references. The primary key for this table. A globally unique, system-generated identifier for a UserSubscriber object. - template parameter [1]",
"name": "SubscriberObjectId",
"title": "Subscriber Object Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"format": "uri",
"minItems": 0,
"title": "User URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DependencyType": {
"minItems": 0,
"type": "string",
"description": "Type of dependency (e.g., After Greeting, After Mesage, Routing Rule, etc.)",
"name": "DependencyType",
"title": "Dependency Type"
},
"DependencyDestinationType": {
"minItems": 0,
"type": "integer",
"name": "DependencyDestinationType",
"title": "Dependency Destination Type"
},
"DependentEntityObjectType": {
"minItems": 0,
"type": "integer",
"description": "The type of object that is dependent on the user.",
"name": "DependentEntityObjectType",
"title": "Dependent Entity Object Type"
},
"DependentEntityOwnerType": {
"minItems": 0,
"type": "string",
"description": "The entity owner type of object (e.g., User, Call Handler Template)",
"name": "DependentEntityOwnerType",
"title": "Dependent Entity Owner Type"
},
"DependentEntityOwner": {
"minItems": 0,
"type": "string",
"description": "The unique identifier of the entity that owns the object which is dependent on the user. For example, a user's call handler may be the dependent entity, but the call handler is owned by another user.",
"name": "DependentEntityOwner",
"title": "Dependent Entity Owner"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/SubscriberDependency/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/SubscriberDependency/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/SubscriberDependency/[pkid1]", "/api/v0/device/cuc/SubscriberDependency/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/SubscriberDependency/?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/SubscriberDependency |
|
{"hrefs": ["/api/device/cuc/SubscriberDependency/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/SubscriberDependency |
|
{"hrefs": ["/api/device/cuc/SubscriberDependency/[pkid1]", "/api/device/cuc/SubscriberDependency/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/SubscriberDependency; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/SubscriberDependency/export/ |
|
{ "hrefs":["/api/device/cuc/SubscriberDependency/[pkid1]", "/api/device/cuc/SubscriberDependency/[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/SubscriberDependency and the JSON format can be used to import instances of device/cuc/SubscriberDependency.
GET http://[host-proxy]/api/device/cuc/SubscriberDependency/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/SubscriberDependency | POST | /api/device/cuc/SubscriberDependency/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/SubscriberDependency/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/SubscriberDependency/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/SubscriberDependency/ |
|
The device/cuc/SubscriberDependency schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/SubscriberDependency instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "URI",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/SubscriberDependency/?skip=0&limit=3&order_by=URI&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"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": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/SubscriberDependency/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/SubscriberDependency",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubscriberDependency/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/SubscriberDependency/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/SubscriberDependency/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/SubscriberDependency/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/SubscriberDependency/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubscriberDependency/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubscriberDependency/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubscriberDependency",
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": "5f3ae7bbce894e001205b13b",
"meta": {
"tags": [],
"cached": true,
"title": "/subscriberdependencies/00d60898-da5e-4e91-ab0d-b54a460833c0",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae7bbce894e001205b13b",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae7bbce894e001205b13b/?model_type=device/cuc/SubscriberDependency",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubscriberDependency",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae7bbce894e001205b13b"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"DependentEntityObjectId": "665e0113-d95d-4ced-be91-c4df9e43f984",
"SubscriberObjectId": "00d60898-da5e-4e91-ab0d-b54a460833c0",
"URI": "/subscriberdependencies/00d60898-da5e-4e91-ab0d-b54a460833c0",
"UserURI": "/vmrest/users/00d60898-da5e-4e91-ab0d-b54a460833c0",
"DependentEntityOwner": "Operator ",
"DependentEntityObjectType": 3,
"DependencyDestinationType": 5,
"DependentEntityOwnerType": "Call Handler ",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"DependencyType": "Recipient",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae7bbce894e001205b13b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "/subscriberdependencies/00d60898-da5e-4e91-ab0d-b54a460833c0",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae7bbce894e001205b13b",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/"
}
],
"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/SubscriberDependency/5f3ae7bbce894e001205b13b/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae7bbce894e001205b13b/?hierarchy=[hierarchy]&model_type=device/cuc/SubscriberDependency",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubscriberDependency/5f3ae7bbce894e001205b13b/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubscriberDependency",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae7bbce894e001205b13b"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"DependentEntityObjectId": "665e0113-d95d-4ced-be91-c4df9e43f984",
"SubscriberObjectId": "00d60898-da5e-4e91-ab0d-b54a460833c0",
"URI": "/subscriberdependencies/00d60898-da5e-4e91-ab0d-b54a460833c0",
"UserURI": "/vmrest/users/00d60898-da5e-4e91-ab0d-b54a460833c0",
"DependencyType": "Recipient",
"DependencyDestinationType": 5,
"DependentEntityObjectType": 3,
"DependentEntityOwnerType": "Call Handler ",
"DependentEntityOwner": "Operator "
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/SubscriberDependency. | GET | /api/device/cuc/SubscriberDependency/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/SubscriberDependency as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/SubscriberDependency/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/SubscriberDependency/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/SubscriberDependency | 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/SubscriberDependency; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/SubscriberDependency/[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/SubscriberDependency and the JSON format can be used to import instances of device/cuc/SubscriberDependency.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/SubscriberDependency/[pkid] | hierarchy=[hierarchy] | The device/cuc/SubscriberDependency instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/SubscriberDependency/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/SubscriberDependency. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/SubscriberDependency/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |