Community Tip - You can Bookmark boards, posts or articles that you'd like to access again easily! X
Mapping previous versions of ThingWorx Analytics API to ThingWorx Analytics 8.1 Services
Since ThingWorx Analytics 8.1, the classic server monolith has been replaced by a series of independent microservices. This new structure groups services around specific elements of functionality (data, training, results). Thus the use of the previous API commands to access ThingWorx Analytics functions has been replaced by the use of ThingWorx Services. Those Services exist within specific Microservice Things accessible in the ThingWorx Platform 8.1.
The table below shows a mapping of the most common previous API commands from version 8.0 and previous versions to the version 8.1 related services. The table below does not contain an exhaustive listing either of API commands nor of Services.
The API commands used below are samples which might require further information like headers and Body once used. These are used in the table below for reference purposes.
Previous API Command Purpose | Sample Syntax | TWA 8.1 Service | Analytics Thing related to Service | Service description | |
1 | Version Info | GET: http://<IP Address>:8080/1.0/about/versioninfo | VersionInfo | This service is available in each Mircorservice Thing inheriting from Analytics Server | Returns the internal version number for a specific microservice. The first two digits = ThingWorx Core
digits = version of the
|
2 | Registering new Dataset | POST: http://<IP Address>:8080/1.0/datasets/ | CreateDataset | Data Microservice | Creates the dataset uploads the data along with its metadata and optimizes it
|
3 | Checking Dataset Status | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name> | ListCreatedDatasets | Data Microservice | This old functionality is replaced by a Service that lists all the created Datasets |
4 | Creating Metadata | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/configuration | CreateDataset | Data Microservice | (Check line 2 for further information) |
5 | Checking Dataset Configuration | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/configuration | GetDatasetSchema | Data Microservice | Retrieves the metadata from a dataset. |
6 | Loading Dataset CSV | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/data | CreateDataset | Data Microservice | (Check line 2 for further information) |
7 | Checking Job Status | GET: http://<IP Address>:8080/1.0/status/<Job ID> | GetJobStatus | Available in all created Microservices inheriting from AnalyticsJob Server | Retrieves the status of a specific job |
8 | Signals Job | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/signals | CreateJob | Signals Microservice | Create a job to identify signals |
9 | Signal Results Job | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/signals/<Job ID>/results | RetrieveResult | Signals Microservice | Retrieve a result of a Signals job |
10 | Profile Job | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/profiles | CreateJob | Profiling Microservice | Creates a job to generate
|
11 | Profile Result Job | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/profiles/<Job ID>/results | RetrieveResult | Profiling Micorservice | Retrieve the results of a profiles job. |
12 | Train Model Job | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/prediction | CreateJob | Training Micorservice | Create a prediction model job. |
13 | Train Model Result Job | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/prediction/<Job ID>/results | RetrieveModel | Training Microservice | Only retrieves the PMML model. But if a holdout for validation was specified in the CreateJob, a validation job is auto-created and
|
14 | Scoring Job | POST: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/predictive_scores | BatchScore | Prediction Microservice | Submit Predictive Scoring Job |
15 | Scoring Job Result | GET: http://<IP Address>:8080/1.0/datasets/<DataSet Name>/predictive_scores/<Job ID>/results | RetrieveResult | Prediction Microservice | Retrieve results from prediction scoring jobs |