Returns nodegen_compilation_jobid, original_file_documentid, and engine_file_documentid which are needed to Publish service.
If using an API key, the API key group must contain user groups that are also assigned to Spark.ServiceUpload.json or Spark.AllEncompassingProxy.json.
Authorizations
AuthorizationstringRequired
Bearer token can be accessed from the user menu.
Path parameters
tenantstringRequired
Tenant is part of your login URL and also available in the user menu.
Get the Neuron "Excel-to-code" compilation status of the Excel upload. This can be run after Upload Excel file to Spark.
If using an API key, the API key group must contain user groups that are also assigned to Spark.ServiceCompilationProgress.json or Spark.AllEncompassingProxy.json.
Authorizations
AuthorizationstringRequired
Bearer token can be accessed from the user menu.
Path parameters
tenantstringRequired
Tenant is part of your login URL and also available in the user menu.
Complete the actions to create a Spark service after Upload Excel file to Spark. Compilation must be completed before publishing, Check compilation status.
If using an API key, the API key group must contain user groups that are also assigned to Spark.ServicePublish.json or Spark.AllEncompassingProxy.json.
Authorizations
AuthorizationstringRequired
Bearer token can be accessed from the user menu.
Path parameters
tenantstringRequired
Tenant is part of your login URL and also available in the user menu.
Get details about every service version.
If using an API key, the API key group must contain user groups that are also assigned to Spark.GetVersions.json or Spark.AllEncompassingProxy.json.
Returns detailed information about the Excel workbook, upload details, Neuron compilation outputs, mapped Xinput, Xoutput, and metadata, etc.
If using an API key, the API key group must contain user groups that are also assigned to Spark.ServiceGet.json or Spark.AllEncompassingProxy.json.
If using an API key, the API key group must contain user groups that are also assigned to Spark.DownloadServiceByVersionId.json or Spark.AllEncompassingProxy.json.
Authorizations
AuthorizationstringRequired
Bearer token can be accessed from the user menu.
Path parameters
folderstringRequired
Folder associated with the API call.
Example: myfoldername
servicestringRequired
Service associated with the API call.
Example: myservicename
versionIdstring · uuidRequired
version_id of the requested service.
Example: 0fb13c76-8b9b-43da-b664-2b11eb11d5c3
Query parameters
filenamestringOptional
Name of the downloaded file. If not provided, Spark will use an appropriate name.
typenull,string · enum · nullableOptional
ca returns the Coherent Assistant enhanced version of the workbook. If not provided, the original workbook will be downloaded.
Get Swagger (OpenAPI 2.0) documentation for a Spark service.
If using an API key, the API key group must contain user groups that are also assigned to Spark.DownloadSwagger.json or Spark.AllEncompassingProxy.json.
Authorizations
AuthorizationstringRequired
Bearer token can be accessed from the user menu.
Path parameters
tenantstringRequired
Tenant is part of your login URL and also available in the user menu.
Example: mytenantname
folderstringRequired
Folder associated with the API call.
Example: myfoldername
servicestringRequired
Service associated with the API call.
Example: myservicename
categorystringRequired
All for all subservices or a list of the requested subservices.