USusenash
Dispatch plans

Get Dispatch Plan Optimization

Changed on

The status of one of the plan's optimization runs; 404 ACTIVITY_NOT_FOUND for any other run.

get/v1/plans/{planId}/optimizations/{activityId}

Request

Path parameters

planIdstring required
activityIdstring required

The optimization run id from its start.

Response

OK

status'queued' | 'running' | 'succeeded' | 'failed' required

queued and running are still working; succeeded and failed are final. succeeded means the run finished: take it. Take can still refuse it with reason not_takeable, which is final for that run.

errorstring nullable required

Why a failed run failed, when it recorded a reason.

Changes