Skip to content
/
Get plan profile

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

List the existing plan profiles

Request

Retrieve plan profiles using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).

Security
clientCredentials
Query
cursorstring

The cursor of the page to retrieve. No cursor is needed to retrieve the first page.

limitinteger(int32)[ 1 .. 1000 ]

The maximum amount of plan profiles that should be returned in the response

Default 100
Example: limit=250

Responses

OK

Bodyapplication/json
dataArray of objects(PlanProfileListSummary)

The set of results for the current page.

cursorsobject(CursorsWithOnlyNext)

Cursor that only supports next cursor navigation.

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

Get plan profile

Request

Retrieves detailed information on the given plan profile.

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 unique identifier for the plan profile.

namestring[ 1 .. 200 ] charactersrequired

The name of the plan profile

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

The business ID of the depot set to use for this profile

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

The business ID of the charging location set to use for this profile

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

The business ID of the break rule set to use for this profile

Example: "eu-break-rules"
Response
application/json
{
  "business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "name": "Default Profile",
  "depot_set_business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "charging_location_set_business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "break_rule_set_business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f"
}

Upsert plan profile

Request

Create or update a plan profile. A unique ID (business_id) is required to identify the plan profile. Calling this endpoint with an existing business_id will update the plan profile.

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 .. 200 ] charactersrequired

The name of the plan profile

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

The business ID of the depot set to use for this profile

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

The business ID of the charging location set to use for this profile

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

The business ID of the break rule set to use for this profile

Example: "eu-break-rules"

Responses

plan profile 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

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

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.