Get service version
Get details for a service version.
Returns: Detailed information about the Excel workbook, upload details, Neuron compilation outputs, mapped Xinput, Xoutput, and metadata, etc.
GET /api/v1/product/{folder}/engines/get/{service}/{versionId}Authorization
Bearer {token}accessible from Authorization - Bearer token or systematically via Client Credentials.The request headers should include a key for
Authorizationwith the valueBearer {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.ServiceGet.jsonorSpark.AllEncompassingProxy.json.The request headers should include the keys
x-synthetic-keyandx-tenant-namewith the values of the API key and tenant name respectively.
Path parameters
Key
Value
folder *
Folder associated with the request.
service *
Service associated with the request.
versionId *
version_id of the Spark service version.
Sample response
HTTP 200 OK Content-Type: application/json
Sample service version details
{
"message": null,
"data": {
"bookSummary": {
"bookServiceName": "AtimesB",
"bookFileName": null,
"bookFileHash": "394ED4529FAF3778D13C2AE6918DB9C2",
"bookFileGUID": "986ef1ea-c0f0-4634-98e5-e58bc418b25e",
"bookRevision": "0.1.0",
"bookReleaseDate": "2026-01-19 16:05:23",
"bookDescription": null,
"bookAuthor": "[email protected]",
"bookUploadDate": "2026-01-19 16:05:23",
"bookUploaderEmail": "[email protected]",
"bookVersionReleaseNotes": null,
"docstoreSize": 11825,
"timeExtractModel": 15125,
"totalTime": 794,
"uploadTime": 736,
"versionId": "c53d397f-af04-4b6a-9437-232c7bc30ea4",
"product": "Arithmetic",
"isStarred": false,
"universalFileHash": null,
"versionLabel": null,
"parametersetCompatibilityGroup": "",
"tags": "",
"originalServiceHash": "9D51F4327DD1B475BF7EE67FD6359466E57EE71CA2F48C0AF8522E2D13E6B22A",
"compiledOutputHash": "BC4646F5F42E1CAF54564448556CDA47DB986989A054E4D33115EF57A4EEC61D",
"compilerVersion": "Neuron_v1.25.0",
"compilerVersionServiceUpdate": "MaintainVersion"
},
"bookProperties": [
{
"name": "PublicAPI",
"value": "False"
},
{
"name": "PublicAPI",
"value": "False"
},
{
"name": "AllowToStoreHistory",
"value": "True"
},
{
"name": "Author",
"value": "[email protected]"
},
{
"name": "BaseUrl",
"value": "https://excel.myenvironment.coherent.global"
},
{
"name": "BatchSizeOverride",
"value": "0"
},
{
"name": "CalcMode",
"value": "AUTO"
},
{
"name": "CompilerVersion",
"value": "Neuron_v1.25.0"
},
{
"name": "CompilerVersionServiceUpdate",
"value": "MaintainVersion"
},
{
"name": "DefaultEngineType",
"value": "Neuron"
},
{
"name": "Description",
"value": null
},
{
"name": "DirectAddressingOutputsEnabled",
"value": "False"
},
{
"name": "FileGUID",
"value": "986ef1ea-c0f0-4634-98e5-e58bc418b25e"
},
{
"name": "ForceInputsWriteBeforeCalcModeChanges",
"value": "True"
},
{
"name": "NoOfInstance",
"value": "0"
},
{
"name": "OriginalFileName",
"value": "AtimesB.xlsx"
},
{
"name": "ProductName",
"value": "Arithmetic"
},
{
"name": "Provenance",
"value": null
},
{
"name": "PublicAPI",
"value": "False"
},
{
"name": "ReleaseNote",
"value": null
},
{
"name": "Revision",
"value": "0.1.0"
},
{
"name": "ServiceGUID",
"value": null
},
{
"name": "ServiceName",
"value": "AtimesB"
},
{
"name": "ServiceStatus",
"value": "active"
},
{
"name": "ServiceVersionGUID",
"value": "c53d397f-af04-4b6a-9437-232c7bc30ea4"
},
{
"name": "Tenant",
"value": "mytenant"
},
{
"name": "UniversalServiceHash",
"value": null
},
{
"name": "UploadDate",
"value": "2026-01-19 16:05:23"
},
{
"name": "UploaderEmail",
"value": "[email protected]"
},
{
"name": "VersionUpgradeAssert",
"value": "OFF"
},
{
"name": "XConnectorServiceName",
"value": null
},
{
"name": "XConnectorTargetUrl",
"value": null
},
{
"name": "DirectAddressingOutputsEnabled",
"value": "False"
},
{
"name": "VersionLabel",
"value": null
},
{
"name": "ServiceUuid",
"value": "8d438c34-d120-46b5-b82c-07278caefd6e"
},
{
"name": "UpgradeType",
"value": "minor"
},
{
"name": "BatchSizeOverride",
"value": "0"
},
{
"name": "DirectAddressingOutputsEnabled",
"value": "False"
},
{
"name": "VersionLabel",
"value": null
},
{
"name": "ServiceUuid",
"value": "8d438c34-d120-46b5-b82c-07278caefd6e"
},
{
"name": "UpgradeType",
"value": "minor"
},
{
"name": "BatchSizeOverride",
"value": "0"
}
],
"engineHash": "394ED4529FAF3778D13C2AE6918DB9C2",
"engineID": "8d438c34-d120-46b5-b82c-07278caefd6e",
"fetchTimeUTC": "2026-01-19T16:05:24.4846647Z",
"validationErrors": [],
"xlInputs": [
{
"sheetIndex": 1,
"value": 2,
"rawValue": 2.0,
"dataType": "NUMBER",
"numberFormatType": "NUMBER",
"numberFormat": "",
"rowIndex": 4,
"columnIndex": 3,
"rows": 1,
"columns": 1,
"textColor": null,
"backGroundColor": null,
"xjName": null,
"validation": {
"allow": "wholeNumber",
"data": "between",
"min": 1.0,
"max": 5.0,
"options": [],
"ignoreEmptyCells": true,
"errorBoxText": null
},
"type": "XInput",
"validationCol": 0,
"validationRow": 0,
"headerSpecs": [],
"subServiceName": null,
"name": "A",
"sheetName": "Sheet1",
"address": "C4",
"description": null,
"cellCount": 1,
"validationErrors": []
},
{
"sheetIndex": 1,
"value": 3,
"rawValue": 3.0,
"dataType": "NUMBER",
"numberFormatType": "NUMBER",
"numberFormat": "",
"rowIndex": 5,
"columnIndex": 3,
"rows": 1,
"columns": 1,
"textColor": null,
"backGroundColor": null,
"xjName": null,
"validation": {
"allow": "wholeNumber",
"data": "between",
"min": 1.0,
"max": 5.0,
"options": [],
"ignoreEmptyCells": true,
"errorBoxText": null
},
"type": "XInput",
"validationCol": 0,
"validationRow": 0,
"headerSpecs": [],
"subServiceName": null,
"name": "B",
"sheetName": "Sheet1",
"address": "C5",
"description": null,
"cellCount": 1,
"validationErrors": []
}
],
"xOutput": [
{
"sheetIndex": 1,
"value": null,
"rawValue": null,
"dataType": "TEXT",
"numberFormatType": "TEXT",
"numberFormat": "",
"rowIndex": 6,
"columnIndex": 3,
"rows": 1,
"columns": 1,
"textColor": null,
"backGroundColor": null,
"xjName": null,
"validation": null,
"type": "XOutput",
"validationCol": 0,
"validationRow": 0,
"headerSpecs": [],
"subServiceName": null,
"name": "AtimesB",
"sheetName": "Sheet1",
"address": "C6",
"description": null,
"cellCount": 1,
"validationErrors": []
}
],
"sizeOfUploadFile": 15456,
"sizeOfCompressedFile": 15611,
"success": true,
"totalHiddenSheets": 0,
"totalInputTables": 0,
"totalOutputSolves": 0,
"totalOutputTables": 0,
"totalReports": 0,
"totalSheets": 1,
"totalXJInputs": 0,
"totalXJOutputs": 0,
"effectiveStartDate": "2026-01-19T16:05:00Z",
"effectiveEndDate": "2126-01-19T16:05:00Z",
"chainingEngines": [],
"chainedEngines": [],
"solveInputs": [],
"reportInputs": [],
"imageInputs": [],
"serviceCategories": [],
"engineWarnings": [],
"engineType": "Neuron",
"lastCalcTime": 0.0,
"totalTime": 20,
"serviceStatus": "active",
"inputMetadata": {
"solves": [],
"reports": [],
"single": [
"A",
"B"
],
"images": [],
"tables": [],
"csv": []
},
"outputMetadata": {
"csv": [],
"solves": [],
"reports": [],
"single": [
"AtimesB"
],
"images": [],
"tables": []
},
"xParameter": {},
"nodeGenCompilerResult": {
"Infos": [
"TEST: [Summary] Spark performs a self-test comparing the saved output values in the Excel file and a calculation of the formulas using Spark. The self-test can be used to understand and diagnose mismatches. For the mapped outputs in this workbook, there were 1 matches out of 1 (100.0%) assessed at 12 digits accuracy. The maximum difference has a significance of -∞ and magnitude of -∞. Self-test results may not match if the workbook includes external references, random functions, Xcall, Xrichoutput, Xsolve. The outputs that contain a mismatch are listed in the compiler messages. Read the Spark Neuron documentation for more information about the self-test."
],
"Warnings": [],
"Errors": [],
"TokenCnt": [
"RootRelative",
2,
"ImmutableRef",
2,
"Add",
1
],
"SourceXlsxMd5": "dd55495f945dfbb596c2c03c36b685dd",
"SourceLines": 199,
"SourceBytes": 5737,
"SourceFiles": 4,
"CompilerVersion": "1.25.0",
"Sheets": 1,
"Cells": 27,
"CellsWithData": 14,
"Formulas": 1,
"SelfTestCellMatches": 1,
"SelfTestCellsInspected": 1,
"SelfTestMaxSoe": "-Infinity",
"SelfTestMaxMoe": "-Infinity",
"SelfTestDigits": 12,
"SelfTestProcessTimeMillis": 7,
"CompilerStage1Millis": 70,
"CompilerStage2Millis": 13619,
"CompilerStage3Millis": 83,
"CompilerStage4Millis": 93,
"CompilerStage5Millis": 22,
"CompilerDateTime": "2026-01-19T16:05:39.492Z",
"trace": null
},
"metadata": {
"engineInformation": {
"fileSize": 15456,
"author": "[email protected]",
"productName": "Arithmetic",
"revision": "0.1.0",
"description": null,
"fileMD5Hash": "394ED4529FAF3778D13C2AE6918DB9C2",
"universalFileHash": null,
"releaseDate": "2026-01-19T16:05:58.3747957Z",
"serviceName": "AtimesB",
"noOfInstance": 0,
"uploaderEmail": "[email protected]",
"defaultEngineType": "Neuron",
"originalFileName": "AtimesB.xlsx",
"sizeOfUploadedFile": 15456,
"releaseNote": null,
"isTypeScriptFile": false,
"engineUpgradeType": "minor",
"publicAPI": false,
"fileGuid": "986ef1ea-c0f0-4634-98e5-e58bc418b25e",
"serviceGuid": null,
"serviceVersionGuid": "c53d397f-af04-4b6a-9437-232c7bc30ea4",
"baseUrl": "https://excel.myenvironment.coherent.global",
"tenant": "mytenant",
"allowToStoreHistory": true,
"calcMode": "AUTO",
"forceInputsWriteBeforeCalcModeChanges": true,
"provenance": null,
"versionLabel": null,
"explainerType": "",
"isXParameter": false,
"parametersetCompatibilityGroup": "",
"xParameterSetVersionId": "",
"versionUpgradeAssert": "OFF",
"xReportRanges": null,
"tags": "",
"originalServiceHash": "9D51F4327DD1B475BF7EE67FD6359466E57EE71CA2F48C0AF8522E2D13E6B22A",
"compiledOutputHash": "BC4646F5F42E1CAF54564448556CDA47DB986989A054E4D33115EF57A4EEC61D",
"compilerVersion": "Neuron_v1.25.0",
"compilerVersionServiceUpdate": "MaintainVersion",
"directAddressingOutputsEnabled": false,
"xConnectorServiceName": null,
"xConnectorTargetUrl": null,
"batchSizeOverride": 0,
"serviceStatus": "active",
"skipMetadata": false,
"skipCompile": false
},
"xInputTable": [
{
"Input Name": "A",
"Description": null,
"Address": "C4"
},
{
"Input Name": "B",
"Description": null,
"Address": "C5"
}
],
"xOutputTable": [
{
"Output Name": "AtimesB",
"Description": null,
"Address": "C6"
}
],
"formsService": null,
"staticService": null,
"versionId": "c53d397f-af04-4b6a-9437-232c7bc30ea4",
"hasSignatureChain": null
},
"totalUsedRowsAndCells": 15,
"isLambdaExist": false,
"parameterset_version_id": "",
"isAutoJsonFormExists": true,
"engineInfos": [
{
"key": "The compiler used for this service version was Neuron_v1.25.0.",
"value": []
}
],
"engineErrors": null,
"hasSignatureChain": null,
"isSameServiceOwner": true
},
"errorCode": null,
"status": "Success"
}Last updated