Important!
The 3D print API is shutting down on January 15, 2017. See our end of life notice for more information.
POST meshes/analyze¶a>
Analyzes a mesh for basic problems.
Note that this endpoint cannot report all mesh problems; some problems cannot be evaluated until other problems have been repaired.
This endpoint is asynchronous and initiates a task that runs in the background, rather than halting execution of your program. The response returns a task id that you need to use to call the GET tasks/:id endpoint, which retreives the new mesh object.
Resource Information¶
| Method and URI | POST https:/ |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request¶
HTTP Headers¶
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| Authorization | yes | string | Must be Bearer <token>, where <token> is obtained via a three- |
| Content-Type | yes | string | Must be application/json |
Body Structure¶
The POST body is a single, flat JSON object with the following attribute:
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| id | yes | string: UUID | identifier of the mesh to be analyzed |
Response¶
HTTP Status Code Summary¶
Code |
Message |
Meaning |
|---|---|---|
| 202 | OK | Successful |
| 302 | Found | Redirect to another resource. |
| 400 | Bad Request | Invalid request. E.g., the request could not be parsed. |
| 401 | Unauthorized | Invalid authorization header. E.g., user is not logged in, or cannot access resource. |
| 404 | Not Found | Endpoint does not exist. |
| 422 | Unprocessable Entity | Semantic errors |
| 429 | Precondition Required | Request rate limit exceeded |
| 500 | Internal Server Error | An unknown error occurred on the server. |
Body Structure (202)¶
The response body is a single, flat JSON object with the following attributes:
Field |
Type |
Description |
|---|---|---|
| id | string: UUID | Task ID |
| status | enum: string | Possible values: running, done, and error |
| progress | float | A value between 0 (not started) and 1 (complete) indicating percentage complete |
| result | object | The response if status is done |
| error | object | The error message if status is error |
Examples¶
Task for Analyzing a Mesh Successfully Created (202)¶
curl -X 'POST' -H 'Authorization: Bearer RWLzh098vuF3068r73FI7nF2RORf' -H 'Content-Type: application/json' -v 'https://developer.api.autodesk.com/ps/v1/geom/meshes/analyze' -d '{
"id":"d21e0d6a-2ce4-43bc-a1e3-ce1bb8fdb7e2"
}'
{
"id": "a35d1b14-a245-4317-9b0a-552f4178949d",
"progress": 0,
"status": "running",
"task_update_time": "2016-06-05T15:08:41.492Z"
}
For an example of a completed task result, see the Examples section in the GET tasks/:id endpoint documentation.
