[Index]

API Reference for view/LineSearch

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.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/view/LineSearch/add/
  • hierarchy=[hierarchy]
  • format=json
 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.

Create

Task Call URL Parameters Payload
Create POST /api/view/LineSearch/ hierarchy=[hierarchy]
(For payload specification)

  • Response is a transaction pkid for the create action.

  • The GET call to 
    tool/Transaction/[trans pkid]
    shows the View resource has no instance pkid, because a view model stores no instances.

    • Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/view/LineSearch/field_display_policy/ hierarchy=[hierarchy]
    • POST call to create the Field Display Policy
    • Field Display Policy schema

    • Use the returned properties to create the POST payload data for the .
    • For a description of the schema that shows properties to add to the POST payload:
    • The POST call is of the format: 
      • POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

    List

    Task Call URL Parameters Response
    List GET /api/view/LineSearch/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    		 The view/LineSearch schema and all instances as JSON.

    (The list will return 0 to 3 view/LineSearch instances)

    Help

    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

    Instance API Reference

    Tag

    Task Call URL Parameters Payload
    Tag PATCH /api/view/LineSearch/[pkid]/+tag/ hierarchy=[hierarchy] If payload required:

    Get

    Task Call URL Parameters Response
    Get GET /api/view/LineSearch/[pkid]/ hierarchy=[hierarchy] The view/LineSearch instance with [pkid].

    Help

    Task Call URL Parameters Response
    Help GET /api/view/LineSearch/[pkid]/help hierarchy=[hierarchy] The on-line Help for view/LineSearch.