[Index]

API Reference for view/MenuTool

Tool to manage menus.

Model ref.: view/MenuTool

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/MenuTool/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "source_menu": {
               "type": "string", 
               "description": "The menu that will be merged or updated from.", 
               "title": "Source Menu"
          }, 
          "hierarchy_level": {
               "default": "{{ fn.hierarchy_friendly_path }}", 
               "readonly": true, 
               "type": "string", 
               "title": "Hierarchy level"
          }, 
          "new_menu_name": {
               "type": "string", 
               "description": "Name of the menu to create.", 
               "title": "New Menu Name"
          }, 
          "description": {
               "default": "Menu Tool", 
               "readonly": true, 
               "type": "string", 
               "title": " "
          }, 
          "target_hierarchy": {
               "default": "{{ fn.hierarchy_friendly_path }}", 
               "type": "string", 
               "title": "Target Hierarchy"
          }, 
          "backup": {
               "type": "boolean", 
               "description": "When selected a backup of the target menu will be made.", 
               "title": "Backup Menu"
          }, 
          "notes": {
               "default": "This view allows you to merge menu items from one menu to another.", 
               "readonly": true, 
               "type": "string", 
               "title": " "
          }, 
          "menu_placement": {
               "default": "after", 
               "choices": [
                    {
                         "value": "after", 
                         "title": "After"
                    }, 
                    {
                         "value": "before", 
                         "title": "Before"
                    }
               ], 
               "type": "string", 
               "description": "Menu Operation", 
               "title": "Menu Placement"
          }, 
          "source_menu_list": {
               "type": "string", 
               "title": "Source Menu List"
          }, 
          "menu_operation": {
               "choices": [
                    {
                         "value": "create_snippet", 
                         "title": "Create Snippet"
                    }, 
                    {
                         "value": "merge", 
                         "title": "Merge"
                    }
               ], 
               "type": "string", 
               "description": "Menu Operation", 
               "title": "Menu Operation"
          }, 
          "new": {
               "type": "boolean", 
               "description": "Create a new menu with a custom name.", 
               "title": "New Menu"
          }, 
          "target_menu": {
               "type": "string", 
               "description": "The menu that will be updated or merged into.", 
               "title": "Target Menu"
          }, 
          "target_menu_list": {
               "type": "string", 
               "title": "Target Menu List"
          }
     }
}

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

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/MenuTool/	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.

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/MenuTool/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
Get the on-line Help for view/MenuTool.	GET	/api/view/MenuTool/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/MenuTool 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	Payload
Tag	PATCH	/api/view/MenuTool/[pkid]/+tag/	hierarchy=[hierarchy]	If payload required:

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

API Reference for view/MenuTool

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

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Help

Instance API Reference

Tag

Help