project-bid-forms/{formId}/line-items:batch-create
Creates multiple project bid form line items. Max 2000 line items per call.
Note that a bid form’s line items must each have a unique combination of the type
, description
, and section
field values.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/construction/buildingconnected/v2/project-bid-forms/{formId}/line-items:batch-create |
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 |
Request
Body Structure
An array of bid form line items to create.
Max 2000 bid form line items per call.
type* enum:string | The type of the bid form line item.
The possible values have the following UI equivalents:
|
description* string | A description of the bid form line item. |
section string | The user-defined name of an optional section of the bid form that the line item is in. If the section does not exist, a new section is created automatically. This value should be null if the item is not in a section.
Note that all of the line items for which you provide the same section value will be in the same section. |
isRequired boolean | Indicates whether the bid form line item is required. Possible values:
|
unit enum:string | The unit format of the bid form line item.
The possible values of this field depend on the value of the line item’s
Note that the value |
external object | Information about an external tool that can link the line item to a cost or other element that is external to BuildingConnected.
Note that BuildingConnected does not use the information in this object. |
id* string | A user-provided ID of the external tool. |
name string | A user-provided name for the external tool. |
Response
HTTP Status Code Summary
201 Created | Created |
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 (201)
results array: object | |
id string | The unique ID of the bid form line item.
Max length: 24 |
type enum:string | The type of the bid form line item.
The possible values have the following UI equivalents:
|
description string | A description of the bid form line item. |
section string | The user-defined name of a section of the bid form that the line item is in. This value is null if the item is not in a section. |
isRequired boolean | Indicates whether the bid form line item is required. Possible values:
|
unit enum:string | The unit format of the bid form line item.
The possible values of this field depend on the value of the line item’s
Note that the value |
external object | Information about an external tool that can link the line item to a cost or other element that is external to BuildingConnected.
Note that BuildingConnected does not use information in this object. |
id string | The ID of the external tool. |
name string | The name of the external tool. |
Example
Created
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/project-bid-forms/:formId/line-items:batch-create' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '[
{
"type": "ACKNOWLEDGMENT",
"description": "This line item is important.",
"section": null,
"isRequired": true,
"unit": "YES_NO",
"external": {
"id": "",
"name": ""
}
}
]'
Response
{
"results": [
{
"id": "53811754d3a604966df72247",
"type": "ACKNOWLEDGMENT",
"description": "This line item is important.",
"section": null,
"isRequired": true,
"unit": "YES_NO",
"external": {
"id": "",
"name": ""
}
}
]
}