/sys/func/basic/{name}/help

The help string (documentation) for this function. In this string, references to argument names are enclosed in arg tags using an XML-like syntax. For example, a reference to an argument with name count would appear as <arg>count</arg> in this string. This can be used to highlight argument names in the document string, for example.

Get /sys/func/basic/{name}/help

SecurityApiKey
Request
path Parameters
name
required
string

The name of an eScript basic function.

Responses
200

Normal response.

401

Unauthorized response.

get/sys/func/basic/{name}/help
Request samples
Response samples
application/json
{
  • "result": "Returns the greater value of <arg>x</arg> and <arg>y</arg>.",
  • "error": "Error message (present if an error occurred)."
}