Get a wave plan with its waves

Parameters

idpathrequiredstring

Responses

200Plan detail

planobjectrequired

idstring (uuid)required

locationIdstring (uuid)required

planDatestringrequired

horizonStartstringrequired

horizonEndstringrequired

statusenumrequired

draftcommittedsuperseded

sourceenumrequired

manualscheduledapi

assumptionsobjectrequired

summaryobjectrequired

diagnosticsobjectrequired

accuracyobjectrequired

committedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

wavesobject[]required

idstring (uuid)required

sequencenumberrequired

proposedNamestringrequired

zoneIdstring (uuid)required

groupKeystringrequired

orderIdsstring (uuid)[]required

orderCountnumberrequired

lineCountnumberrequired

unitCountnumberrequired

estimatedMinutesnumberrequired

scheduledStartstringrequired

scheduledEndstringrequired

laborByZoneobjectrequired

committedWaveIdstring (uuid)required

404Not found

errorstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/plans/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/plans/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/plans/3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "plan": {
    "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "locationId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
    "planDate": "plan date",
    "horizonStart": "horizon start",
    "horizonEnd": "horizon end",
    "status": "draft",
    "source": "manual",
    "assumptions": {},
    "summary": {},
    "diagnostics": {},
    "accuracy": {},
    "committedAt": "committed at",
    "createdAt": "created at",
    "updatedAt": "updated at"
  },
  "waves": [
    {
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "sequence": 1.5,
      "proposedName": "proposed name",
      "zoneId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "groupKey": "group key",
      "orderIds": [
        "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
      ],
      "orderCount": 1.5,
      "lineCount": 10,
      "unitCount": 1.5,
      "estimatedMinutes": 1.5,
      "scheduledStart": "scheduled start",
      "scheduledEnd": "scheduled end",
      "laborByZone": {},
      "committedWaveId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10"
    }
  ]
}