Service APIs

APIs for managing Spark services.

Upload Excel file to Spark

post

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.

Example: mytenantname
folderstringRequired

Folder associated with the API call.

Example: myfoldername
servicestringRequired

Service associated with the API call.

Example: myservicename
Body
serviceFilestring · binaryRequired

Service file to be uploaded.

Example: @/path/to/file
Responses
chevron-right
200

OK

application/json
objectOptional
post
/{tenant}/api/v3/folders/{folder}/services/{service}/upload
200

OK

Check compilation status

get

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.

Example: mytenantname
folderstringRequired

Folder associated with the API call.

Example: myfoldername
servicestringRequired

Service associated with the API call.

Example: myservicename
jobIdstring · uuidRequired

job_id associated from POST job.

Example: b13a5526-60c8-43cc-840f-2c76dca701d9
Responses
chevron-right
200

OK

application/json
objectOptional
get
/{tenant}/api/v3/folders/{folder}/services/{service}/getcompilationprogess/{jobId}
200

OK

Publish service

post

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.

Example: mytenantname
folderstringRequired

Folder associated with the API call.

Example: myfoldername
servicestringRequired

Service associated with the API call.

Example: myservicename
Body
Responses
chevron-right
200

OK

application/json
objectOptional
post
/{tenant}/api/v3/folders/{folder}/services/{service}/publish
200

OK

List service versions

get

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.

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
Responses
chevron-right
200

OK

application/json
objectOptional
get
/api/v1/product/{folder}/engines/getversions/{service}
200

OK

Get details for a service version

get

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.

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
Responses
chevron-right
200

OK

application/json
objectOptional
get
/api/v1/product/{folder}/engines/get/{service}/{versionId}
200

OK

Download the Excel file from a Spark service

get

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.

Possible values:
Responses
chevron-right
200

OK

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
string · binaryOptional
get
/api/v1/product/{folder}/engines/{service}/download/{versionId}
200

OK

Download Swagger

get

Get Swaggerarrow-up-right (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.

Example: All
isDownloadbooleanRequired

true for integrating with this endpoint.

Example: true
versionIdstring · uuidRequired

version_id of the requested service.

Example: 0fb13c76-8b9b-43da-b664-2b11eb11d5c3
Responses
chevron-right
200

OK

application/json
objectOptional
get
/{tenant}/api/v3/folders/{folder}/services/{service}/downloadswagger/{category}/{isDownload}/{versionId}
200

OK

Delete service

delete

If using an API key, the API key group must contain user groups that are also assigned to Spark.ServiceDelete.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
Responses
chevron-right
200

OK

application/json
objectOptional
delete
/api/v1/product/{folder}/engines/delete/{service}
200

OK

Last updated