projects/{projectId}/settings
Updates the measurement system settings for a project.
For more information about measurement system settings, see the ACC Configure Takeoff Settings help documentation.
Note that settings for Takeoff cannot be changed once takeoff types and items have been created in the project.
To check if a project contains takeoff types and items, call GET packages and use the package IDs (results[i].id
) to call GET takeoff-types.
Resource Information
Method and URI | PATCH https://developer.api.autodesk.com/construction/takeoff/v1/projects/{projectId}/settings |
Authentication Context | user context required |
Required OAuth Scopes | data:write |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
region string | Specifies the region where the service is located.
Possible values: |
Content-Type* string | Must be application/json |
Request
URI Parameters
projectId string: UUID | The ID of the project.
This corresponds to project ID in the Data Management API, and can be specified in the form of “UUID” or b.”UUID”. To learn how to find the project ID, see the Retrieve ACC Account and project ID tutorial. |
Request
Body Structure
measurementSystem* enum:string | The project measurement system.
Possible values: |
Response
HTTP Status Code Summary
200 OK | Successfully updated the measurement system settings. |
400 Bad Request | The parameters of the requested operation are invalid. |
401 Unauthorized | The provided bearer token is not valid. |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The requested resource could not be found. |
429 Too Many Requests | Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait. |
500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (200)
measurementSystem enum:string | The project measurement system.
Possible values: |
Example
Successfully updated the measurement system settings.
Request
curl -v 'https://developer.api.autodesk.com/construction/takeoff/v1/projects/:projectId/settings' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"measurementSystem": "IMPERIAL"
}'
Response
{
"measurementSystem": "IMPERIAL"
}