Get Function Object¶

Get information about a NEXUS function from the REST service, that can then be used to call the function via REST to execute.

HTTP Request¶

GET /icweb.dll/function/{functionName}

URI Parameters¶

Name	In	Required	Type	Description
`functionName` \| `functionKey`	Path	Yes	String \| Integer	Specify the function name or function key to be returned.

Responses¶

Name	Type	Description
200 OK	FunctionObject	OK
401	Not authorised	An attempt was made to access a function when you do not have permissions.

FunctionObject¶

The Function object, contains information about the function.

Name	Type	Description	Optional
`name`	string	Name of the function.	No
`key`	Integer	Key value for this function, unique.	No
`resultTypeId`	Integer	Result type of the result from executing this function. See Field Types.	No
`parameters`	FunctionParameter []	List of parameters for this function.	No

FunctionParameter¶

The Function Parameter object, contains information about each parameter in a function.

Name	Type	Description	Optional	Default
`name`	string	Name of the parameter	No
`parameterTypeId`	Integer	Result type of the result from executing this function. See Field Types	No
`allowsNull`	Boolean	If this parameter allows a null input value	Yes	Yes

Example¶

Request¶

GET /icweb.dll/function/Compare A = B

Response¶

{
        "name": "Compare A = B",
        "key": 57,
        "resultTypeId": 5,
        "parameters": [{
                "name": "A",
                "parameterTypeId": 0
        }, {
                "name": "B",
                "parameterTypeId": 0
        }]
}