[Index]

API Reference for tool/Theme

Model ref.: tool/Theme

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

Variables are enclosed in square brackets.

Help

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

List

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

(The list will return 0 to 3 tool/Theme instances)

(Show the first instance)

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/tool/Theme/?format=json&schema&action=add&hierarchy=[hierarchy]
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of tool/Theme 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.

Help

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