UDFCALLAPI

This legacy function allows the user to call Spark service API through Coherent Assistant.

This is an outdated custom function which we have replaced with SPARK_XCALL. This is available through the add-in for backward compatibility.

Syntax

CS.SPARK_UDFCALLAPI([UDFCallTableRange])

• XCallTableRange: Required. Range address of the XCall block in upstream service. E.g. $A$1:$B$4. You can also use a named range for convenience.

UDFCall Block

Create an UDFCall block in the Excel workbook (upstream service) to make an API call. The UDFCall block can be anywhere in your workbook but must be on the same sheet as your Spark_UdfCallAPI function.

• This table needs to include

  • CALLTYPE: SparkService

  • FOLDERNAME: name of the folder containing downstream service.

  • SERVICENAME: name of downstream service.

  • REQUESTBODY: payload for calling downstream service. Must be in JSON format. You can copy the REQUESTBODY from downstream service API tester. If this is your first time using the SparkService we encourage to leave content of "request_meta" empty. Spark will use the latest version and the default Service Type to execute this service.

• XCall block example

• REQUESTBODY example (v3 format)

{
    "request_data": {
        "inputs": {
            "InputField": "InputValue"
        }
    },
    "request_meta": {}
}

Output

The function will return a JSON formatted string with two parts.

• The first, metadata, contains information about the call to the downstream service such as status, error_code, and response_time.

• The second, data, contains the response body of the downstream service.

Response from Spark (example):

{
    "metadata": {
        "name": null,
        "calltype": "SparkService",
        "status": "200",
        "error_code": "",
        "response_time": "225"
    },
    "data": {
        "status": "Success",
        "response_data": {
            "outputs": {
                "OutputField": "OutputValue"
            },
            "warnings": [],
            "errors": [],
            "service_chain": []
        },
        "response_meta": {
            "service_id": "166f5109-b01f-4d14-b10d-49669e3489e0",
            "version_id": "52e710a8-9ca1-4ab2-9366-dc304a9eb670",
            "version": "1.0.0",
            "process_time": 4,
            "call_id": "07ea654c-4136-4075-a195-7eaba15391c4",
            "compiler_type": "Type3",
            "compiler_version": "1.0.0",
            "source_hash": null,
            "engine_id": "F0D5B2B02645AAE15F63BABFBF94FBEF",
            "correlation_id": "",
            "system": "SPARK",
            "request_timestamp": "2022-02-28T16:14:25.148Z"
        },
        "error": null
    }
}