[Index]

API Reference for view/TDK_VTI_VIEW

Model ref.: view/TDK_VTI_VIEW

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/TDK_VTI_VIEW/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of view/TDK_VTI_VIEW 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/TDK_VTI_VIEW 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.

    • Tag

    Task Call URL Parameters Response
    Tag PATCH /api/view/TDK_VTI_VIEW/+tag/
    • hierarchy=[hierarchy]
    • format=json
    		  

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/view/TDK_VTI_VIEW/configuration_template/ hierarchy=[hierarchy]
    • POST call to create the Configuration Template
    • Configuration Template 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/ConfigurationTemplate/?hierarchy=[hierarchy]

    Instance API Reference

    Tag

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