These values are used in the code and in the following examples too.

The project requires Java 1.8 or higher.

The project makes use of Gradle and uses the Gradle wrapper, which means you don't need Gradle installed.

The project makes use of Gradle and uses the Gradle wrapper to help you out carrying some common tasks such as building the project or running it.

List all the tasks that Gradle can do, such as build and test.

$ ./gradlew tasks

Compiles the project, runs the test and then creates an executable JAR file

$ ./gradlew build

Run the application using Java and the executable JAR file produced by the Gradle build task. The application will be listening to port 8080.

$ java -jar build/libs/play-spring-boot.jar

There are two types of tests, the unit tests and the functional tests. These can be executed as follows.

• Run unit tests only

  $ ./gradlew test

• Run functional tests only

  $ ./gradlew functionalTest

• Run both unit and functional tests

  $ ./gradlew check

Run the application which will be listening on port 8080.

$ ./gradlew bootRun

Below is a list of API endpoints with their respective input and output. Please note that the application needs to be running for the following endpoints to work. For more information about how to run the application, please refer to run the application section above.

Endpoint

POST /values/store

Example of body

{
  "rootId": <rootId>,
  "exampleValues": [
    {
      "time": <time>,
      "value": <value>
    }
  ]
}

Parameters

The following POST request, is an example request using CURL, sends the readings shown in the table above.

$ curl \
  -X POST \
  -H "Content-Type: application/json" \
  "http://localhost:8080/values/store" \
  -d '{"rootId":"root-10","exampleValues":[{"time":1606636800,"value":0.0503},{"time":1606636860,"value":0.0621},{"time":1606636920,"value":0.0222},{"time":1606636980,"value":0.0423},{"time":1606637040,"value":0.0191}]}'

The above command does not return anything.

Endpoint

GET /values/read/<rootId>

Parameters

Retrieving readings using CURL

$ curl "http://localhost:8080/values/read/root-0"

Example output

[
  {
    "time": "2020-11-29T08:00:00Z",
    "value": 0.0503
  },
  {
    "time": "2020-11-29T08:01:00Z",
    "value": 0.0621
  },
  {
    "time": "2020-11-29T08:02:00Z",
    "value": 0.0222
  },
  {
    "time": "2020-11-29T08:03:00Z",
    "value": 0.0423
  },
  {
    "time": "2020-11-29T08:04:00Z",
    "value": 0.0191
  }
]