projects/{projectId}/sheets:batch-update
Updates a list of sheets.
Note that you can only update a single sheet number and a single title in one call. However, you can update multiple sheets and tags in a version set in a single call.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/construction/sheets/v1/projects/{projectId}/sheets:batch-update |
Authentication Context | user context optional |
Required OAuth Scopes | data:write |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
x-user-id string | The ID of the user on whose behalf the API request is made. This header is optional when using a 2-legged OAuth2, but required if using 2-legged OAuth2 with user impersonation.
When using 2-legged OAuth2 without user impersonation, your app has access to all users defined by the administrator in the SaaS integrations UI. However, when user impersonation is enabled, the API call is restricted to act only on behalf of the specified user. This header is not relevant for 3-legged OAuth2. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). |
Content-Type* string | Must be application/json |
Request
URI Parameters
projectId string: UUID | The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You can use a project ID either with a “b.” prefix or without a “b.” prefix. For instance, a project ID of “b.a4be0c34a-4ab7” can also be referred to as “a4be0c34a-4ab7”. |
Request
Body Structure
ids* array: string | To find the IDs of the sheets you want to update, call GET sheets.
|
updates object | The list of updates. |
number string | The new sheet number.
Only available for single sheet update.
The API will format the number in the following ways before applying it to the sheet:
Max length: 255 |
title string | The new title of the sheet.
Only available for single sheet.
The API will format the title in the following ways before applying it to the sheet:
Max length: 255 |
versionSetId string | The ID of the new version set. |
addTags array: string | The tags to be attached to the sheets.
The API will format the tags in the following ways before applying them to the sheets:
|
removeTags array: string | The tags to be detached from the sheets.
The API will format the tags in the following ways before comparing them to the existing tags:
|
Response
HTTP Status Code Summary
200 OK | Successfully updated sheets. |
400 Bad Request | The parameters of the requested operation are invalid. |
403 Forbidden | The user or client represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The requested resource cannot be found. |
409 Conflict | The request could not be completed due to a conflict with the current state of the target resource. |
429 Too Many Requests | The server has received too many requests. |
500 Internal Server Error | An unexpected error occurred on the server. |
Response
Body Structure (200)
results array: object | The IDs of the updated sheets. |
id string | The ID of the sheet. |
Example
Successfully updated sheets.
Request
curl -v 'https://developer.api.autodesk.com/construction/sheets/v1/projects/9ba6681e-1952-4d54-aac4-9de6d9858dd4/sheets:batch-update' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"ids": [
"0d7a5883-1694-3078-a06d-ad24413f8b06"
],
"updates": {
"number": "A-01",
"title": "Floor One",
"versionSetId": "7c2ecde0-2406-49f9-9199-50176848a0b7",
"addTags": [
"floor"
],
"removeTags": [
"top"
]
}
}'
Response
{
"results": [
{
"id": "0d7a5883-1694-3078-a06d-ad24413f8b06"
}
]
}