Workflow for Using the REST Query Service

Step Description Notes
1 Deploy Proficy Historian for AWS. This step is required. Make a note of the NLB DNS of the EC2 instance on which you have deployed Proficy Historian for AWS.
Tip: To find the NLB DNS:
  1. Access the EKS cluster on which you have deployed Proficy Historian for AWS.
  2. Access the EC2 instance.
  3. In the navigation pane, under Load Balancing, select Load Balancers.
  4. Select the load balancer for which you want to find the DNS.
  5. In the Description section, copy the DNS name.
2 Deploy the Web Admin console and the REST Query service. This step is required.
3 Connect the Web Admin console and the REST Query service with the Historian server. This step is required.
4 Install an API platform, such as POSTMAN. This step is required. The API platform is used to send API requests and receive responses.
5 Get an authorization token by sending a request with the following parameters:
  • Method: POST
  • URI: http://<NLB DNS>:8080/oauth/token
  • Authorization type: Basic Auth
  • Username: Enter admin.
  • Password: Enter the password that you provided in the UAA Configuration field while deploying Proficy Historian for AWS.
  • Body: Select x-www-form-urlencoded, and then enter grant-type and client-credentials as a key-value pair.
This step is required to establish a connection with the UAA service. Copy the token (the value in the access_token parameter).
6 Using the API platform, send REST queries. For a list of available queries, refer to REST Queries for Retrieving Data Samples and REST Queries for Data Aggregation. For information on common API parameters, refer to Common API Parameters.