Get a plan
GET/v1/plans/:planId
Returns a plan with its setups and operations. Requires Create a plan (POST /v1/parts/{id}/plans) to have run and its job to have succeeded.
A toolpath calculation makes the plan readable at planned as soon as it has planned the part, before it cuts: jobId names the job cutting it, so compare it with the job you queued. A plan already toolpathed keeps its last result while it is recalculated, and its jobId moves when that run completes. A failed calculation leaves the plan as its last successful run left it, or planned under the failed job for a plan that had no toolpaths.
Experimental. Available now and still gaining functionality. It may change in breaking ways in a minor API release; each such change is listed in the release notes, so check them before upgrading.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 410
- 500
- 503
The plan, with its setups and action-specs.
The request is invalid.
The API key is missing or invalid.
The API key may not perform this operation: it has no access to this part of the API, it may only read it, or its creator has not met the organization’s two-factor requirement.
The plan was not found.
The plan is older than the retention window and is no longer available.
The plan could not be retrieved.
Authentication is temporarily unavailable.