API Reference for view/ToolMacro

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

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

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/ToolMacro/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "input": {
               "readonly": false, 
               "required": false, 
               "type": "string", 
               "title": "Macro"
          }, 
          "show_context": {
               "default": "True", 
               "type": "boolean", 
               "title": "Show Context"
          }, 
          "context_hierarchy": {
               "choices": [
                    {
                         "value": "", 
                         "title": ""
                    }
               ], 
               "readonly": false, 
               "required": false, 
               "type": "string", 
               "title": "Context Hierarchy"
          }, 
          "context": {
               "type": "string", 
               "description": "Json formatted context data. ", 
               "title": "Context Data"
          }, 
          "output": {
               "readonly": false, 
               "required": false, 
               "type": "string", 
               "title": "Output"
          }
     }, 
     "schema_version": "0.1.0"
}

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

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]

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]

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

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

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

API Reference for view/ToolMacro

GET http://[host-proxy]/api/view/ToolMacro/schema/?hierarchy=[hierarchy]&format=json&schema=1

Export Bulk Load Template

Configuration Template

Field Display Policy

Help

Instance API Reference

Help