Skip to content

PTV OptiFlow Planning API (1.10.0)

The planning API provides information about plannings and their lifecycle.

You can find out more in our developer portal.

Download OpenAPI description
planning-api.json
planning-api.yaml
Overview
URL
https://servicedesk.conundra.eu
Servers
Mock server
https://developer.conundra.eu/_mock/apis/plannings/planning-api
Production Api
https://api.conundra.eu/planning/v1

Health

Validate connection and accessibility of the API.

Operations

Plannings

Endpoints used for retrieving information about plannings and its releases.

Operations

Plan Profiles [EXPERIMENTAL]

Endpoints used for managing plan profiles.

Operations

Location Workload Levelling

Endpoints used for managing location workload levelling sets.

Operations

List the existing location workload levelling sets

Request

Retrieves detailed information on all location workload levelling sets, limited to at most 100 items.

Security
clientCredentials
Query
cursorstring

Cursor of the page to retrieve.

limitinteger(int32)[ 1 .. 100 ]

The maximum amount of location workload levelling sets that should be returned in the response

Default 100
Example: limit=100

Responses

OK

Bodyapplication/json
dataArray of objects(LocationWorkloadLevellingSetResponse)required

Subset of Location Workload Levelling Sets matching the provided query, limited to the limit specified in the request.

business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$read-only

The identifier for this location workload levelling set

namestring

The name of the location workload levelling set

Example: "Weekday"
settingsArray of objects(LocationWorkloadLevellingSetting)
etagstring(Etag)
cursorobject(Cursors)required
selfstring

The cursor for this page. Not present when the result contains no data.

Example: "c2VsZl9fcGFnZQ"
prevstring

The cursor for the previous page. Not present when fetching data for the first page.

Example: "cHJldmlvdXNfX3BhZ2U"
nextstring

The cursor for the next page. Not present when fetching data for the last page.

Example: "bmV4dF9fcGFnZQ"
Response
application/json
{
  "data": [
    { … }
  ],
  "cursor": {
    "self": "c2VsZl9fcGFnZQ",
    "prev": "cHJldmlvdXNfX3BhZ2U",
    "next": "bmV4dF9fcGFnZQ"
  }
}

Get location workload levelling set

Request

Retrieves detailed information on the given location workload levelling set.

Security
clientCredentials
Path
business_idstring^[a-zA-Z0-9.~\-_]+$required

The unique identifier of an entity

Responses

OK

Headers
ETagstring

A weak Etag (ex W/"<etag_value>") which contains the current version of the entity

Example: "W/\"25\""
Bodyapplication/json
business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$read-only

The identifier for this location workload levelling set

namestring

The name of the location workload levelling set

Example: "Weekday"
settingsArray of objects(LocationWorkloadLevellingSetting)
Response
application/json
{
  "business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "name": "Weekday",
  "settings": [
    { … }
  ]
}

Upsert location workload levelling set

Request

Create or update a location workload levelling set. A unique ID (business_id) is required to identify the location workload levelling set. Calling this endpoint with an existing business_id will update the location workload levelling set.

Security
clientCredentials
Path
business_idstring^[a-zA-Z0-9.~\-_]+$required

The unique identifier of an entity

Headers
If-Matchstring

Weak Etag used for optimistic locking.

Example: W/"24"
Bodyapplication/jsonrequired
namestring

The name of the location workload levelling set

Example: "Weekday"
settingsArray of objects(LocationWorkloadLevellingSetting)

Responses

location workload levelling set created successful

Headers
ETagstring

A weak Etag (ex W/"<etag_value>") which contains the current version of the entity

Example: "W/\"25\""
Locationstring

The URL of the newly created resource

Example: "/settings/location-workload-levelling-sets/86b54c9d-21d7-4b37-af3d-25f03886153b"
Response
No content

Order-Order Restrictions

Endpoints used for managing order-order restriction sets.

Operations

Break Rules [EXPERIMENTAL]

Endpoints used for managing break rule sets.

Operations

Depot Sets [EXPERIMENTAL]

Endpoints used for managing depot sets.

Operations

Charging Location Sets [EXPERIMENTAL]

Endpoints used for managing charging location sets.

Operations
Company
PTV Logistics
Copyright © Conundra BV - PTV Logistics GmbH. All right reserved.