[Index]
This VIEW was originally designed to focus on Line dependencies in CUCM, but it has since been extended to include other non-cucm number usages as well, so that now, it is being re-used by both the standalone Line Search tool (Subscriber Management) as well as the Number relation (INI) under number management. It was originally designed to only work at Site level (looking up), but has been extended to allow support from the Cust-node. The VIEW renders with a list of clickable links to the various different devices/entities in VOSS4UC.
Model ref.: view/LineSearch
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": {
"search_line": {
"type": "string",
"description": "Search for a (Used, Used-Utility or Used-Staging) Line",
"title": "Search Line"
},
"line1_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line2_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line3_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line4_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line5_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line6_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line7_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line8_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line9_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"line10_link": {
"format": "link",
"type": "string",
"title": "Line (Partition)"
},
"user1_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user2_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user3_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user4_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user5_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user6_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user7_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user8_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user9_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user10_link": {
"format": "link",
"type": "string",
"title": "User"
},
"phone1_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone2_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone3_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone4_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone5_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone6_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone7_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone8_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone9_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone10_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"huntpilot1_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot2_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot3_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot4_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot5_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot6_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot7_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot8_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot9_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"huntpilot10_link": {
"format": "link",
"type": "string",
"title": "Hunt Pilot"
},
"hunt_group1_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group2_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group3_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group4_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group5_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group6_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group7_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group8_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group9_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"hunt_group10_link": {
"format": "link",
"type": "string",
"title": "Hunt Line Group Member"
},
"call_pickup_group_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Member"
},
"voicemail_link": {
"format": "link",
"type": "string",
"title": "Voicemail User"
},
"device_profile_link": {
"format": "link",
"type": "string",
"title": "Device Profile"
},
"remote_destination_profile_link": {
"format": "link",
"type": "string",
"title": "Remote Destination Profile"
},
"ctirp_link": {
"format": "link",
"type": "string",
"title": "CTI Route Point"
},
"cpug1_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug2_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug3_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug4_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug5_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug6_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug7_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug8_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug9_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"cpug10_link": {
"format": "link",
"type": "string",
"title": "Call Pickup Group Pilot"
},
"meetme1_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme2_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme3_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme4_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme5_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme6_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme7_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme8_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme9_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"meetme10_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"callpark1_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark2_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark3_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark4_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark5_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark6_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark7_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark8_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark9_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark10_link": {
"format": "link",
"type": "string",
"title": "Call Park"
},
"callpark_directed1_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed2_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed3_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed4_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed5_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed6_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed7_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed8_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed9_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"callpark_directed10_link": {
"format": "link",
"type": "string",
"title": "Directed Call Park"
},
"meetme_link": {
"format": "link",
"type": "string",
"title": "Meet Me"
},
"vmpilot_link": {
"format": "link",
"type": "string",
"title": "Voicemail Pilot"
},
"systemcallhandler_link": {
"format": "link",
"type": "string",
"title": "System Call Handler"
},
"vossphone_link": {
"format": "link",
"type": "string",
"title": "VOSS Phone"
},
"msteams_LineUriTell_link": {
"format": "link",
"type": "string",
"title": "User (MS Subscriber)"
},
"msteams_AaOrCq_application_link": {
"format": "link",
"type": "string",
"title": "MS AutoAttendant / Call Queue"
},
"msteams_AaOrCq_ResourceAccount_link": {
"format": "link",
"type": "string",
"title": "Resource Account linked to the AA / CQ"
},
"webexapp_calling_link": {
"format": "link",
"type": "string",
"title": "Webex App Calling"
}
},
"schema_version": "3.0.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/LineSearch/add/ |
|
The GUI Add form of view/LineSearch 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/view/LineSearch | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/view/LineSearch/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/LineSearch/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/LineSearch/ |
|
The view/LineSearch schema and all instances as JSON. |
(The list will return 0 to 3 view/LineSearch instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/LineSearch/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/LineSearch",
"summary_attrs": [
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"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": [
"add"
],
"schema_version": "3.0.3",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/LineSearch/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/view/LineSearch/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/LineSearch/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/LineSearch/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/LineSearch/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/LineSearch. | GET | /api/view/LineSearch/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/LineSearch as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/LineSearch/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/LineSearch/[pkid] | hierarchy=[hierarchy] | The view/LineSearch instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/LineSearch/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/LineSearch. |