Introduction to Tool APIs

This section describes API calls that are not related to a specific model. The full URL would include the host name: http://[hostname].

The calls described here all contain /tool/ in the URL and the full list can be obtained by the GET call for choices:

Task

Call

URL

Parameters

Response

List tools

GET

/api/tool/choices/

format=json

hierarchy=[hierarchy]

JSON format of the list of tools as title - value pairs.

Variables are enclosed in square brackets, e.g.:

  • [hierarchy] is the hierarchy UUID

  • [filename] refers to a file

Other parameters are described with the relevant API call.