Check compilation status

Get the Neuron "Excel-to-code" compilation status of the Excel upload. This can be run after Upload Excel file to Spark.

Returns: progress of the compilation job. 100 is complete.

GET /{tenant}/api/v3/folders/{folder}/services/{service}/getcompilationprogess/{jobId}

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.ServiceCompilationProgress.json or Spark.AllEncompassingProxy.json.

  • The request headers should include the keys x-synthetic-key and x-tenant-name with 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 *	Target folder name. This should be the same as in Upload Excel file to Spark.
service *	Target folder name. This should be the same as in Upload Excel file to Spark.
jobId *	nodegen_compilation_jobid from Upload Excel file to Spark.

Sample response

HTTP 200 OK Content-Type: application/json

If the progress is 100, the compilation has completed.

{
    "status": "Success",
    "response_data": {
        "status": "Success",
        "last_error_message": "null",
        "progress": 100
    },
    "response_meta": {
        "system": "SPARK",
        "request_timestamp": "2023-05-19T01:39:42.074Z"
    },
    "error": null
}