Conundra Planning API (0.2.0)

Download OpenAPI specification:Download

API support: apiteam@conundra.eu URL: https://www.conundra.eu/contact-us Terms of Service

Conundra helps you transport less air by creating optimized transport planning solutions.

health

Miscellaneous endpoints for general API functionality

Returns a single `pong` string

Very simple endpoint, which can be used for health purpose.

Responses
200

pong

get/ping

plannings

APIs related to Plannings

Get a cursor paged list of plannings

Returns a cursor paged list of plannings. Most recent first based on moment of creation.

Request
query Parameters
cursor
string

Cursor of the page to retrieve, see also Cursor-Paging section.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Number of results by page, see also Cursor-Paging section. If value > maximum, we round to the maximum allowed limit. If value < minimum an error may be returned.

Responses
200

Planning overview

default

General error payload

get/plannings
Response samples
application/json
{
  • "plannings": [
    ],
  • "cursor": {
    }
}

Retrieve a planning

Returns a planning in in the requested format.

Request
path Parameters
business-id
required
string

The identifier of a entity instance

Responses
200

Excel export

409

Conflict: the planning is in a non-exportable state (e.g. queued, running, failed).

default

General error payload

get/plannings/{business-id}
Response samples
{
  • "business_id": "abcde12345",
  • "info": {
    },
  • "last_run": {
    },
  • "metrics": {
    },
  • "audit_info": {
    }
}