[Index]

API Reference for relation/DP_REL

Relation to view all dial plan elements with the same Dial Plan name.

Model ref.: relation/DP_REL

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/relation/DP_REL/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of relation/DP_REL 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/relation/DP_REL/ hierarchy=[hierarchy]
(For payload specification)

  • Response is a transaction pkid for the create action.
  • Use the GET call to
    tool/Transaction/[trans pkid]
    to inspect the created resource and its instance pkid.
  • List

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

    (The list will return 0 to 3 relation/DP_REL instances)

    (Show the first instance)

    Help

    Task Call URL Parameters Response
    Get the on-line Help for relation/DP_REL. GET /api/relation/DP_REL/help hierarchy=[hierarchy] On-line help of Model ref.: relation/DP_REL as HTML

    Instance API Reference

    Get

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

    Help

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