put-formations
PUT/v1/formations
Creates or replaces company formations by name, asynchronously. The body is an array of formations (a single formation is also accepted). A formation whose name already exists in the company scope has its surfaces replaced; other formations in the scope are left in place, although the import may pull up placeholder bottoms of formations above the new ones (reported as written.adjusted on the job).
PUT does not set enabled, maxDepth or maxThickness: a new formation starts with enabled: true and no depth constraints, and a replaced one keeps its values. These fields are left out because the import is shared with the ComboCurve app. To set them, wait for the job to succeed, look up the formation's id with GET /v1/formations?name=..., then PATCH.
The whole request is validated first; problems return 400 with the location of each one and nothing is imported. Returns 202 with a job id to poll at GET /v1/formations/jobs/{jobId}.
Request
Responses
- 202
- 400
Accepted
Bad Request. There is something wrong with the request data.