Status

Status service provides API to get the status of the specified token. Your client application sends an HTTP request to the service application for using the Status API to get the status of the specified token.

Status Service Request Schema

To get the status of the specified token, you need to use GET method. Token information can be specified in the request URL, as:

GET: http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}/status

URL Parameters

Parameter	Description
datasourcekey	Used to specify the data source from where you want to get the token information.
token	Used to specify the analysis instance. Token value can be obtained from the 3rd service.

Response Messages

HTTP Status Code	Reason
200	An IStatus object is returned to specify the status. When the status is "Completed", it means the query has been executed successfully and data is prepared for the output. Once the Status API is returned successfully, you can get the data by using the Result Data service. If the status is still “Executing”, you can send this request repeatedly until the status is changed to other values: Completed, Cleared or Exception. If the status is “Exception”, it means some error occurs during the executing. For example, the token provided in this request doesn’t exist, an exception would be returned as response.
404	{datasource} or {token} is invalid.

HTTP Status Code

Reason

200

An IStatus object is returned to specify the status. When the status is "Completed", it means the query has been executed successfully and data is prepared for the output. Once the Status API is returned successfully, you can get the data by using the Result Data service.

If the status is still “Executing”, you can send this request repeatedly until the status is changed to other values: Completed, Cleared or Exception.

If the status is “Exception”, it means some error occurs during the executing. For example, the token provided in this request doesn’t exist, an exception would be returned as response.

404

{datasource} or {token} is invalid.

Analysis Service Request Schema

Analysis service provides API to calculate the analysis data according to the specified token. Your client application sends an HTTP request to the service application for using the Analysis API.

To get the analysis data by the specified token, you need to use GET method. Token information can be specified in the request URL, as:

GET:http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}

Response Messages

HTTP Status Code	Reason
200	An IAnalysis object is returned to specify the analysis result information.
404	{datasource} or {token} is invalid.

Result Data Request Schema

Result Data service provides API to get the result data by the specified token. Your client application sends an HTTP request to the service application for using the Result Data API.

To get the result data by the specified token, you need to use GET method. Token information can be specified in the request URL, as:

GET: http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}/result

Response Messages

HTTP Status Code	Reason
200	An array object is returned to specify the result data. After calling this service to obtain the data prepared, the token will be removed. You cannot use it in other requests then. Otherwise, an exception would be returned.
404	{datasource} or {token} is invalid.

Clear Token Service Request Schema

Clear Token service provides API to clear the token when it is not needed. Your client application sends an HTTP request to the service application for using the Clear Token API to clear the token when it is not needed.

To get the result data by the specified token, you need to use DELETE method. Token information can be specified in the request URL, as:

DELETE:http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}

Response Messages

HTTP Status Code	Reason
204	No content for response.
404	{datasource} or {token} is invalid.