Planning API (1.0.0)

Download OpenAPI specification:Download

URL: https://servicedesk.conundra.eu

The planning API provides information about plannings and their lifecycle.

You can find out more in our developer portal.

Changelog

  • The following endpoints are marked for removal on 30/06/2025. More information on how to migrate can be found here.
    • GET /planning/v0/releases
    • GET /planning/v0/plannings/{id}/releases/latest
  • The following v0 endpoints will remain supported for now, even after 30/06/2025, until further notice:
    • GET /planning/v0/ping > Will be kept for convenience as long as there are v0 endpoints available.
    • GET /planning/v0/plannings/{id}/export > No alternative in v1. No excel export will be created in v1 and onwards. These will be replaced with alternative endpoints in the future that will fulfill the same needs.
    • GET /planning/v0/plannings > Although this endpoint will still be available until further notice, we strongly suggest you already migrate to the newer GET /planning/v1/plannings. Please contact us, if the newer endpoint does not fulfill your needs.
  • Upgraded some endpoints from v0 to v1:
    • GET /planning/v0/ping has been superseded by GET /planning/v1/ping. No changes were made to the API contract.
    • GET /planning/v0/plannings has been superseded by GET /planning/v1/plannings. Note that the response body has been changed significantly from the v0 endpoint.
    • GET /planning/v0/releases has been deprecated in favor of GET /planning/v1/plannings?released_since={date-time}. The response body contains small changes compared to the v0 endpoint.
    • GET /planning/v0/plannings/{id}/releases/latest has been deprecated in favor of GET /planning/v1/plannings/{id}/releases/latest. This introduces the concept of routes with multiple trips. Note that this changes the response body of the endpoint significantly compared to the v0 endpoint.

health

Validate connection and accessibility of the API.

Returns a single `pong` string

The ping-endpoint can be used for validating a connection with the application. It will authenticate the caller and returns a pong response when everything is set-up correctly.

Securitykeycloak
Responses
200

Everything set-up correctly

401

Authentication required

get/ping
Response samples
text/plain
pong

plannings

Endpoints used for retrieving information about plannings and its releases.

Get a cursor paged list of plannings

Returns a cursor paged list of plannings. Results are sorted by created_at in descending order. You can find out more about how to use cursors in our developer portal.

Securitykeycloak
Request
query Parameters
released_since
string <date-time>

When provided, only plannings which have been released since (exclusive) the given date will be returned.

Example: released_since=2021-01-01T10:15:30Z
cursor
string

Cursor of the page to retrieve.

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

The maximum amount of plannings that should be returned in the response

Example: limit=100
Responses
200

OK

400

Bad request

401

Authentication required

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

Retrieve a released planning using a given planning id

Retrieves detailed information on the given released planning.

Note that information about releases are only stored for 2 weeks after the release was made. If you try to retrieve a release which is older than 2 weeks, you will get a 404 Not Found response.

Securitykeycloak
Request
path Parameters
id
required
string

The unique identifier of a planning

Responses
200

OK

401

Authentication required

404

Not found

get/plannings/{id}/releases/latest
Response samples
application/json
{
  • "release_metadata": {
    },
  • "routes": [
    ]
}