Download as Excel (legacy)

This documentation is for the legacy implementation of Download as Excel file. The differences are described in Download the Excel file with inputs.

Get a copy of the original Excel file with inputs embedded from the API Call History for a particular Execute API call_id using the legacy implementation.

Returns: Link to download the Excel file.

GET /{tenant}/api/v3/folders/{folder}/services/{service}/download/{callId}/{index}

Authorization

• Bearer {token} accessible from Authorization - Bearer token or systematically via Client Credentials.

  • The request headers should include a key for Authorization with the value Bearer {token}.

• API key created from Authorization - API keys. The API key groups must contain User groups that are also assigned to Permissions - Features permissions Spark.DownloadServiceByCallId.json or Spark.AllEncompassingProxy.json.

  • The request headers should include the keys x-synthetic-key and x-tenant-name with the values of the API key and tenant name respectively.

Path parameters

Key	Value
tenant *	Tenant is part of your Log in to Spark URL and also available in the User menu.
folder *	Folder associated with the API call.
service *	Service associated with the API call.
callId *	Execute API call_id.

Query parameters

Key	Value
index	Index number for the record to get. With Execute API (v4), multiple request records can be submitted at once.

Sample request with API key

See How to: Setup a feature permission for guidance in assigning the enable the Authorization - API keys to access Permissions - Features permissionsSpark.DownloadServiceByCallId.json.

curl --location 'https://excel.myenvironmentname.coherent.global/mytenantname/api/v3/folders/myfoldername/services/myservicename/download/a5c6a61f-06f8-499b-8a4d-818be4e74d29' \
--header 'x-tenant-name: mytenantname' \
--header 'x-synthetic-key: 5458626120e2'

Sample response

HTTP 200 OK Content-Type: application/json

{
    "status": null,
    "response_data": {
        "download_url": "https://myenvironmentname.coherent.global/SparkService_CallLogDetails_a5c6a61f-06f8-499b-8a4d-818ce4e74d29.xlsx"
    },
    "response_meta": {
        "service_id": "4e798d55-7504-41cd-80b6-2b1542cd380f",
        "version_id": "e9fb31ab-d9e2-42f9-b2b1-d9201cffb126",
        "version": "0.1.0",
        "process_time": 0,
        "call_id": "a5c6a61f-06f8-499b-8a4d-818be4e74d30",
        "compiler_type": "Neuron",
        "compiler_version": null,
        "source_hash": null,
        "engine_id": "0ADFAEF8E4246B31322E367A8E19A841",
        "correlation_id": null,
        "parameterset_version_id": null,
        "system": "SPARK",
        "request_timestamp": "2023-11-14T06:32:18.210Z"
    },
    "error": null
}