11. API - Batch calculations

With the API you can request simulations without having to access the 3Di web portal and follow your simulation. It is ideal for making various calibration runs. Also, it allows you to use several types of external forcing not available through the web portal and save and use states or restart files.

Visit https://3di.lizard.net/api/v1/calculation/start/ for all options.

11.1. Using POSTMAN

The first step is to install POSTMAN as an extension on Google Chrome.

Then take the following steps:

  1. Log-in using a POSTMAN account. This account is not linked to 3Di.
Postman Login

Postman Login

  1. Select POST (instead of GET) left of URL
  2. Enter this URL: https://3di.lizard.net/api/v1/calculation/start/
  3. Select basic authorisation
Postman URL

Postman URL

  1. Enter your 3Di username and password
  2. Select update request
Postman Update Request

Postman Update Request

  1. Click on Body
  2. Select ‘raw’
  3. Select JSON from the drop-down
  4. Enter the raw json body, that’s the part between {} and consists of multiple lines.
  5. Click Send
Postman Send

Postman Send

Note that postman stores your password which poses a possible security risk.

Times

All dates and times used in the API are based on the so-called ISO8601 standards. You can use your local times and add the off set to UTC Time. More about these standards can be found on Wikipedia. In the example below:

2016-06-22T18:00+02:00

This rainfall event will start at 18:00 hour local time.