Skip to main content
PUT
Stop or restart the optimization of a plan

Authorizations

Authorization
string
header
required

JWT bearer token, sent as Authorization: Bearer <token>. Two kinds of token are accepted:

  • A session token (1 hour), obtained through the interactive Console login flow. Used to sign in to the Console; not meant to be used against this API.
  • A long-term API token (366 days), obtained once via the Console and meant to be stored by your integration. It is the credential recommended for backend use, since it does not depend on repeating the interactive login flow.

Path Parameters

planId
string<uuid>
required
read-only

The plan UUID. Universally Unique Identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"cd4ce4e3-0208-4b10-b346-25f235214e4f"

Query Parameters

force
boolean
default:false

If true, on an archived item, the requested action is forced and the item is unarchived.

Example:

true

Body

application/json

A boolean value: false stops the optimization, true restarts it.

The body is of type boolean.

Example:

false

Response

The request succeeded.

An envelope carrying no item, only the reference of the plan the request acted on.

agencyId
string

Identifier of the Kardinal tenant/account the plan is scoped to, derived automatically from the access token used to make the request.

Modelling pitfall. Not a physical-depot or site partition key. A single fleet based at several physical depots is still one Plan; do not split it into several Plan objects just because resources have different departure/arrival positions.

Pattern: ^BLD[0-9]{7}_[a-zA-Z0-9-._~:@!$,]+$
Example:

"BLD1234567_production"

planId
string<uuid>
read-only

The plan id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"4cbd0ab8-282c-4b30-b981-29e1ed8a2016"

planVersion
integer

The plan's current version: unchanged by this request.

Required range: x >= 1
Example:

42

warnings
object[]

Amendments applied while processing this request, if any.