bid-packages/{bidPackageId}
Updates fields in a bid package. The requesting user must be a member of the project team.
To remove an existing field value, include the field in the request with a value of null.
Resource Information
Method and URI | PATCH https://developer.api.autodesk.com/construction/buildingconnected/v2/bid-packages/{bidPackageId} |
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
name string | A user-defined name for the bid package, typically referring to a trade or scope of work such as “Concrete” or “Fire Alarms”. The name need not be unique. This value is listed as the trade on the bidder’s opportunity.
The name must not be empty if provided. |
number string | A user-defined identifying number of the bid package. This value need not be unique. |
keywords array: string | An array of keywords to associate with the bid package. Keywords are used by the BuildingConnected search functionality to find relevant bidders for the bid package.
Note that this value is private to your company and is not displayed to bidders. A bid package is limited to a maximum of 4 keywords. |
leadUserId string | The unique BuildingConnected ID of the lead user for this bid package. All opportunities created from this bid package will appear to be sent from this user.
Max length: 24 |
estimatedCost number | A numeric value representing the expected contract cost for the bid package’s scope of work in the associated project’s defaultCurrency .
Note that this value is private to your company and is not displayed to bidders. |
instructions string | The instructions for what to include in a bid for this bid package. This field may contain HTML tags for formatting. |
bidsDueAt datetime: ISO 8601 | The date and time by which bidders must submit their proposals for this bid package, in ISO 8601 format.
Note that If a project has If set to null, this defaults to the value of the project’s |
endsAt datetime: ISO 8601 | The expected end date and time of this scope of work, in ISO 8601 format.
If set to null, this defaults to the value of the project’s |
rfisDueAt datetime: ISO 8601 | The date and time by which bidders must submit their RFIs, in ISO 8601 format.
If set to null, this defaults to the value of the project’s |
startsAt datetime: ISO 8601 | The date and time that the scope of work of this bid package is expected to start, in ISO 8601 format.
If set to null, this defaults to the value of the project’s |
jobWalkAt datetime: ISO 8601 | The date and time that bidders invited to this bid package may come to the site and do a job walk, in ISO 8601 format.
If set to null, this defaults to the value of the project’s |
currentAccDocsFolderId string | The unique ID of an Autodesk Docs folder in the linked ACC project. Files in this folder are shared with the bid package’s bidders.
The project to which the bid package belongs must be linked to an ACC project ( Note that if the bid package already has a shared docs folder, this value cannot be null. |
Response
HTTP Status Code Summary
200 OK | OK |
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)
id string | The bid package’s unique ID.
Max length: 24 |
projectId string | The ID of the project to which the bid package belongs.
Max length: 24 |
name string | The name of the bid package, typically referring to a trade or scope of work such as “Concrete” or “Fire Alarms”. The name need not be unique. This value is listed as the trade on the bidder’s opportunity. |
leadUserId string | The unique BuildingConnected ID of the user set as the “Bid Package Lead”. All opportunities created from this bid package will appear to be sent from this user.
Max length: 24 |
number string | An identifying number of the bid package. This value need not be unique. |
keywords array: string | An array of keywords associated with the bid package. Keywords are used by the BuildingConnected search functionality to find relevant bidders for the bid package.
Note that this value is private to your company and is not displayed to bidders. |
estimatedCost number | A numeric value representing the expected contract cost for the bid package’s scope of work in the associated project’s defaultCurrency .
Note that this value is private to your company and is not displayed to bidders. |
instructions string | The instructions for what to include in a bid for this bid package. This field may contain HTML tags for formatting. |
state enum:string | The publication state of the bid package. Possible values:
An opportunity is created on a given vendor’s Bid Board when both of the following are true:
|
createdAt datetime: ISO 8601 | The date and time that the bid package was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time that the bid package was last updated, in ISO 8601 format. |
publishedAt datetime: ISO 8601 | The date and time that the bid package was published, in ISO 8601 format. |
bidsDueAt datetime: ISO 8601 | The date and time by which bidders must submit their proposals for this bid package, in ISO 8601 format.
Note that If a project has |
endsAt datetime: ISO 8601 | The date and time that the scope of work of this bid package is expected to be completed, in ISO 8601 format. |
rfisDueAt datetime: ISO 8601 | The date and time by which bidders must submit their RFIs for this bid package, in ISO 8601 format. |
startsAt datetime: ISO 8601 | The expected start date and time of this scope of work, in ISO 8601 format. |
jobWalkAt datetime: ISO 8601 | The date and time that bidders invited to this bid package may come to the site and do a job walk, in ISO 8601 format. |
bidAdminUnsealed boolean | Indicates whether bids have been unsealed for this bid package. Possible values:
|
bidAdminUnsealedAt datetime: ISO 8601 | Date and time that bidAdminUnsealed was set to true , in ISO 8601 format. This value is null if bids are still sealed. |
currentAccDocsFolderId string | The unique ID of an Autodesk Docs folder in the linked ACC project. Files in this folder are shared with all bidders in this bid package.
This value is null when |
currentAccLinkedProjectId string | The project ID of the ACC project currently linked to from this bid package’s BuildingConnected project.
Note that when this value is null, |
currentAccLinkedHubId string | The hub ID of the Autodesk Construction Cloud project currently linked to this bid package’s BuildingConnected project. Note that this value is null under any of the following conditions:
|
Example
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/bid-packages/:bidPackageId' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"name": "Concrete",
"number": "03",
"keywords": [
"Concrete"
],
"leadUserId": "5c0dd127b319f408fa90b3bc",
"estimatedCost": 100000,
"instructions": "Instruction about bid",
"bidsDueAt": "2014-09-25T19:00:00.000Z",
"endsAt": "2014-09-25T19:00:00.000Z",
"rfisDueAt": "2014-09-25T19:00:00.000Z",
"startsAt": "2014-09-25T19:00:00.000Z",
"jobWalkAt": "2014-09-25T19:00:00.000Z",
"currentAccDocsFolderId": "urn:adsk.wipprod:fs.folder:co.BJU3PTc4Sd2CmXM492XUiA"
}'
Response
{
"id": "590dd127b359f408f190b5a7",
"projectId": "590dd127b319f408f190b3b8",
"name": "Concrete",
"leadUserId": "5d8104b87e392d56e1e4b4ca",
"number": "03",
"keywords": [
"Concrete"
],
"estimatedCost": 100000,
"instructions": "Instruction about bid",
"state": "PUBLISHED",
"createdAt": "2014-09-25T19:00:00.000Z",
"updatedAt": "2014-09-26T16:00:00.000Z",
"publishedAt": "2014-09-25T19:00:00.000Z",
"bidsDueAt": "2014-09-25T19:00:00.000Z",
"endsAt": "2014-09-25T19:00:00.000Z",
"rfisDueAt": "2014-09-25T19:00:00.000Z",
"startsAt": "2014-09-25T19:00:00.000Z",
"jobWalkAt": "2014-09-25T19:00:00.000Z",
"bidAdminUnsealed": true,
"bidAdminUnsealedAt": "2022-09-25T19:00:00.000Z",
"currentAccDocsFolderId": "urn:adsk.wipprod:fs.folder:co.9g7HeA2wRqOxLlgLJ40UGQ",
"currentAccLinkedProjectId": "00f1b796-293a-4c1e-9474-f09711011426",
"currentAccLinkedHubId": "28b0d8b3-4730-4f4f-8bad-4a2a5d75ed26"
}