CALLAPI

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

This function is deprecated and replaced with SPARK_XCALL.

The functions CALLAPI and GETOUTPUT functions work together.

Syntax: CS.SPARK_CALLAPI(xcall_block)

Call Spark service APIs. Retrieve the output using GETOUTPUT.

Parameter	Description
xcall_block *	Range address of the Xcall block in upstream service. You can also use a named range for convenience. Example: $A$1:$B$4

xcall_block block

Create a xcall_block block in the Excel workbook (upstream service) to make an API call. The xcall_block block can be anywhere in your workbook but must be on the same sheet as the CS.SPARK_CALLAPI function. The 4 row x 2 column table must include this information:

Key	Description	Example
CALLTYPE	SparkService	SparkService
FOLDERNAME	Name of the folder containing downstream service.	myfolder
SERVICENAME	Name of downstream service.	myservice
REQUESTBODY	Payload for calling downstream service. Must be in JSON format. You can copy the from the downstream service API Tester.	{ "request_data": { "inputs": { "a": 1 } }, "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.

Sample response

{
    "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
    }
}