Function
The Function object represents the JavaScript functions executed by your step.
Properties
This section describes the properties of Function.
result
Function result object. Includes an array of values, if any, that are returned from the passed function.
status
Function status object. Includes the following properties:
path
String. Relative path name of the JavaScript function that is being passed by your action.
status (within status)
String. Describes the current status of the function.
capsuleId
String. Fully qualified capsule ID. For example, viv.gratuity.
actionId
String. Fully qualified action type ID. For example, viv.gratuity.calculate.
requests
[Optional] Request object map. If your function calls web requests, returns a mapping of an id to a FunctionWebRequest and a FunctionWebResponse.
requests: { [_id _: string]: { _req_: FunctionWebRequest, _res_: FunctionWebResponse } }
id
String. Identifier of a function web request. Maps to a FunctionWebRequest and a FunctionWebResponse.
FunctionWebRequest
Request information that the function passes to the web services. Can include information like method and url passed. Mapped from an id.
FunctionWebResponse
Response information that the function receives from web services. Can include information like duration of request, cached information, and status code. Mapped from an id.