Dispatch plans
Take Dispatch Plan Optimization
Changed onTake a succeeded run into the plan's draft. Fails with 409 PLAN_OPTIMIZATION_UNAVAILABLE and reason not_finished while the run is queued or running (poll again), or not_takeable for a run that failed or whose result does not fit the plan; and with 409 PLAN_OPTIMIZATION_STALE when the draft changed after the run started. not_takeable and PLAN_OPTIMIZATION_STALE are final for that run: start a new one. Fails with 409 PLAN_LEASE_HELD (naming heldBy) while anyone has the plan open in the Planner, and with 409 PLAN_REVISION_STALE (naming currentRevision) when the plan changed since expectedRevision.
post/v1/plans/{planId}/optimizations/{activityId}:take
Request
- Base URLhttps://api.sandbox.usenash.com
- Authnone declared
- TypeScripthttps://skmtc.dev/usenash/apis/nash-api/docs/v1/plans/:planId/optimizations/:activityId:take/post.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
planIdstring required
activityIdstring required
The optimization run id from its start.
Request body
Response
OK
Changes
- info
endpoint added
- info