Introduction

At Plotwise we solve complex problems, however, we want to keep the API as simple as possible. Therefore we advise you to go through some of the key concepts of continuous planning, which you will find in the Plotwise Planning Flow section. Below you will find some of our API concepts.

Get an API Key and a root URL

The Plotwise API is private and protected by API keys.

Before you start using the Plotwise API, you need a root URL and an API key. All your requests must be performed towards the root_url and include the header apikey with the value of the key provided by Plotwise.

Get yours

To get your root_url and apikey, please contact Plotwise.

API versioning

The Plotwise API is versioned. To reach a certain API version you can add the version in the URL as follows:

https://{root_url}/bucket-planning/{api-version}/buckets/

API v2 is currently the only available version (also used implicitly when no version is requested explicitly).

https://{root_url}/bucket-planning/buckets/

You can find all the versioning information in the Changelog section of the documentation.

Fetching information

The format for a GET request is as follows:

https://{root_url}/bucket-planning/v2/buckets/{bucket_id}/routes/?limit=10&offset=10

The basic structure of a GET response is:

{
  "count":34,
  "next":"https://{root_url}/bucket-planning/v2/buckets/0393d142-123a-48d7-a762-660aab19e90c/routes/?limit=10&offset=10",
  "previous":null,
  "results":[{
    ...
  }]
}

Where:

• Count contains the total amount of elements matching the query.
• Next contains the URL of the next data chunk.
• Previous contains the URL of the previous data chunk.
• Results contains the requested information.

Timezones

The current Plotwise API version only allows working in the UTC+0 timezone. So:

UTC+0

All datetimes sent to the API must be in UTC+0

Date formats

To know more about the date formats used in Plotwise, please visit the Basic elements and formats page

Pagination

All requests performed to the Plotwise API requesting for information return paginated content. The pagination is done by adding the query params limit and offset. If these params are not present in the request the value is limit=10 and offset=0.

Moreover, all paginated responses will include next to the results attribute of the response to the attributes next and previous. These attributes will include the request to perform to get the previous and the next data chunk.

Example

https://{root_url}/bucket-planning/buckets/

This request will return the first 10 buckets owned by the requestor. The response will also include the following information:

{
  {
    "count":34,
    "next":"https://{root_url}/bucket-planning/buckets/?limit=10&offset=10",
    "previous":null,
    "results":[...]
  }
}

Here you can see the required request to perform to fetch the next 10 buckets.

A mention to HTTPS

All our domains are protected with SSL. So make sure to request using https.

Required fields in the entity reference tables

In the Entity Reference tables of this section, the column with the title "Required" defines whether proving a value for a field is mandatory or not. When Required=False, the field is allowed to be null. When Required=True, providing a value for that field is mandatory. In case the Required=N/A, the field is not applicable by the user.