Attribute Values
POST
v1/containers/{containerId}/property-values:batch-update
Updates the existing values of multiple custom attributes associated with an item such as a Budget, Contract, Cost Item, PCO, and so on.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/cost/v1/containers/:containerId/property-values:batch-update |
| 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. |
| Content-Type* string | Must be application/json |
| region string | The region where the project data resides, to which this request is routed.
This header is optional because the request is automatically routed to a target region based on the project ID or container ID. Using the header, though, can save lookup time on each API call. For information about verifying the region the data resides in, see the Working with BIM 360 Services in Different Regions section on the API Basics page. Possible values: |
* Required
Request
URI Parameters
| containerId string: UUID | The ID of the cost container for the project. Each project is assigned a container that stores all of the cost data for the project.
To find the container ID, see the Retrieve a Cost Container ID tutorial. In ACC projects, the container ID is the same as the project ID. To obtain a project ID, use GET projects. |
Request
Body Structure
The values of the properties.
| associationId* string: UUID | The object ID of the item associated with the actions, such as a budget, contract, or cost item. |
| associationType* enum:string | The type of item to which it is associated. Possible values: Budget, Contract, CostItem, FormInstance, and Payment, MainContract, BudgetPayment, Expense, ExpenseItem, OCO, SCO, DistributionItem, BudgetTransfer in the coming release. |
| propertyDefinitionId* string: UUID | ID of the custom attribute definition. |
| value* string,null,number,boolean | Value of the custom attribute associated to an item. |
* Required
Response
HTTP Status Code Summary
| 200 OK | The resource is updated successfully. |
| 400 Bad Request | The parameters are invalid. |
| 401 Unauthorized | The provided bearer token is invalid. |
| 403 Forbidden | Forbidden. The user or service represented by the bearer token does not have permission to perform this operation. |
| 404 Not Found | The resource or endpoint cannot be found. |
| 409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 429 Too Many Requests | Rate limit exceeded. Retry your request after a few minutes. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
| 503 Service Unavailable | Service unavailable. |
Response
Body Structure (200)
| name string | Name of the custom attribute. Inherited from the custom attribute definition. |
| builtIn boolean | A flag to indicate whether this is a pre-defined attribute or not. Inherited from the custom attribute definition. |
| position number | The order of the custom attribute displayed in the BIM 360 Cost Management. Inherited from the custom attribute definition. |
| propertyDefinitionId string: UUID | The ID of the custom attribute definition. This is the ID from /properties. |
| type string | The type of the custom attribute. Inherited from the custom attribute definition. |
| value string | The value of the custom attribute. |
Example
The resource is updated successfully.
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/property-values:batch-update' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '[
{
"associationId": "EDC42DF6-277A-436A-A50D-EF57F35E1248",
"associationType": "Budget",
"propertyDefinitionId": "229d3420-9481-11e8-87fb-215990a8aeb3",
"value": "2018-10-1"
}
]'
Show More
Response
[
{
"name": "Source Type",
"builtIn": true,
"position": 0,
"propertyDefinitionId": "fc4a7581-7838-11e8-a467-7de33c3af32d",
"type": "options",
"value": "RFI"
}
]
Show More
