[Index]

API Reference for view/ToolMacro

Model ref.: view/ToolMacro

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

Export Bulk Load Template

Task Call URL Parameters Response
Get a compressed format of the Bulk Load spreadsheet template for view/ToolMacro POST /api/view/ToolMacro/export_bulkload_template/
  • hierarchy=[hierarchy]
  • modeltype=view/ToolMacro
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Configuration Template

Task Call URL Parameters Response
Configuration Template GET /api/view/ToolMacro/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]

Field Display Policy

Task Call URL Parameters Response
Field Display Policy GET /api/view/ToolMacro/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]

Help

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

Instance API Reference

Help

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