Skip to content
/
List the existing break r...

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

Order-Order Restrictions

Endpoints used for managing order-order restriction sets.

Operations

Break Rules [EXPERIMENTAL]

Endpoints used for managing break rule sets.

Operations

List the existing break rule sets

Request

Retrieves detailed information on all break rule sets, limited to at most 100 items.

Security
clientCredentials
Query
cursorstring

Cursor of the page to retrieve.

limitinteger(int32)[ 1 .. 1000 ]

The maximum amount of break rule sets that should be returned in the response

Default 100
Example: limit=100

Responses

OK

Bodyapplication/json
dataArray of objects(BreakRuleSetPageItem)required

Subset of Break Rule Sets matching the provided query, limited to the limit specified in the request.

namestring[ 1 .. 250 ] charactersrequired

The name of the break rule set

Example: "Legal breaks for Belgium"
break_rule_groupsArray of objects(BreakRuleGroup)[ 1 .. 100 ] itemsrequired

List of all break rule groups within a set

namestring[ 1 .. 250 ] charactersrequired

The name of the break rule group

Example: "Heavy trucks"
break_rulesArray of objects(BreakRule)<= 100 itemsrequired

List of break rules

typestringrequired
Discriminator
max_work_time_between_breaksstring(duration)required

Maximum work time between breaks in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT4H30M"
break_durationstring(duration)required

Duration of the break in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT45M"
business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$

The identifier for this break rule set

etagstring(Etag)
cursorsobject(CursorsWithOnlyNext)required

Cursor that only supports next cursor navigation.

nextstring

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

Example: "bmV4dF9fcGFnZQ"
Response
application/json
{
  "data": [
    { … }
  ],
  "cursors": {
    "next": "bmV4dF9fcGFnZQ"
  }
}

Get break rule set

Request

Retrieves detailed information on the given break rule 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
namestring[ 1 .. 250 ] charactersrequired

The name of the break rule set

Example: "Legal breaks for Belgium"
break_rule_groupsArray of objects(BreakRuleGroup)[ 1 .. 100 ] itemsrequired

List of all break rule groups within a set

namestring[ 1 .. 250 ] charactersrequired

The name of the break rule group

Example: "Heavy trucks"
break_rulesArray of objects(BreakRule)<= 100 itemsrequired

List of break rules

typestringrequired
Discriminator
max_work_time_between_breaksstring(duration)required

Maximum work time between breaks in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT4H30M"
break_durationstring(duration)required

Duration of the break in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT45M"
business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$

The identifier for this break rule set

Response
application/json
{
  "name": "Legal breaks for Belgium",
  "break_rule_groups": [
    { … }
  ],
  "business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f"
}

Upsert break rule set

Request

Create or update a break rule set. A unique ID (business_id) is required to identify the break rule set. Calling this endpoint with an existing business_id will update the break rule 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[ 1 .. 250 ] charactersrequired

The name of the break rule set

Example: "Legal breaks for Belgium"
break_rule_groupsArray of objects(BreakRuleGroup)[ 1 .. 100 ] itemsrequired

List of all break rule groups within a set

namestring[ 1 .. 250 ] charactersrequired

The name of the break rule group

Example: "Heavy trucks"
break_rulesArray of objects(BreakRule)<= 100 itemsrequired

List of break rules

typestringrequired
Discriminator
max_work_time_between_breaksstring(duration)required

Maximum work time between breaks in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT4H30M"
break_durationstring(duration)required

Duration of the break in ISO-8601 duration format. Must be non-negative and not exceed 7 days.

Example: "PT45M"

Responses

break rule set created successfully

Headers
ETagstring

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

Example: "W/\"25\""
Response
No content

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.