[Index]
This VIEW allows a user to search all Line dependencies in CUCM. It executes at Site level only and find all related data up in the tree. The VIEW renders with a list of clickable links to the various Relations 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": {
"hunt_group9_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"remote_destination_profile_link": {
"format": "link",
"type": "string",
"title": "Remote Destination Profile"
},
"hunt_group8_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"user1_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user4_link": {
"format": "link",
"type": "string",
"title": "User"
},
"phone2_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"user3_link": {
"format": "link",
"type": "string",
"title": "User"
},
"phone1_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"user7_link": {
"format": "link",
"type": "string",
"title": "User"
},
"user9_link": {
"format": "link",
"type": "string",
"title": "User"
},
"line_link": {
"format": "link",
"type": "string",
"title": "Line"
},
"user6_link": {
"format": "link",
"type": "string",
"title": "User"
},
"phone7_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"hunt_group7_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"user10_link": {
"format": "link",
"type": "string",
"title": "User"
},
"hunt_group1_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"device_profile_link": {
"format": "link",
"type": "string",
"title": "Device Profile"
},
"hunt_group6_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"phone5_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"user5_link": {
"format": "link",
"type": "string",
"title": "User"
},
"line_hierarchy": {
"type": "string",
"title": "Line Hierarchy"
},
"search_line": {
"type": "string",
"title": "Search Line"
},
"voicemail_link": {
"format": "link",
"type": "string",
"title": "Voicemail"
},
"phone3_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"hunt_group10_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"phone4_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"hunt_group3_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"line": {
"type": "string",
"title": "Line"
},
"phone8_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"phone6_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"user2_link": {
"format": "link",
"type": "string",
"title": "User"
},
"call_pickup_group_link": {
"format": "link",
"type": "string",
"title": "Call Pick Up Group"
},
"phone9_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"user8_link": {
"format": "link",
"type": "string",
"title": "User"
},
"phone10_link": {
"format": "link",
"type": "string",
"title": "Phone"
},
"hunt_group4_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"hunt_group5_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
},
"hunt_group2_link": {
"format": "link",
"type": "string",
"title": "Huntgroup"
}
},
"schema_version": "0.1"
}
| 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 |
|---|---|---|---|---|
| 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)
{
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/view/LineSearch/?skip=0&limit=3&order_by=None&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "0.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/view/LineSearch/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/LineSearch/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/LineSearch/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/LineSearch/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/LineSearch/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/LineSearch",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"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. |