bid-packages

Creates a bid package associated with a BuildingConnected project that is owned by the requesting user’s company. The requesting user must be a member of the project team.

A bid package comprises a scope of work, and has several values that are independent of the project to which it belongs: date values, separate files options, and publication state.

You can create the new bid package by specifying an existing (source) bid package as a template. Include the template object in the request to specify the types of content to copy from the source bid package. Note that any values you include in the request body take precedence over the corresponding values in the source bid package.

A new bid package initially has the state field set to DRAFT. After a user performs the publishing operation in the BuildingConnected UI, the state field changes permanently to PUBLISHED. Note that you can add new bidders to the bid package in either state.

An invite is created and sent to each existing bidder when the bid package is published, as well as when a new bidder is added to a published bid package. These invites create corresponding opportunities on Bid Board Pro, and they inherit a combination of values from the bid package and the project.

Resource Information

Method and URI	POST https://developer.api.autodesk.com/construction/buildingconnected/v2/bid-packages
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`

* Required

Request

Body Structure

Expand all

projectId* string	The ID of the project to which the bid package will belong. Max length: 24
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. This field is required and must not be empty.
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. If not provided, this defaults to the current user’s ID. 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 `project.isBiddingSealed` set to `true`, bids cannot be viewed before this date or submitted after this date. If not provided or null, this defaults to the value of the project’s `bidsDueAt` field.
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. If not provided or null, this defaults to the value of the project’s `endsAt` field.
rfisDueAt datetime: ISO 8601	The date and time by which bidders must submit their RFIs for this bid package, in ISO 8601 format. If not provided or null, this defaults to the value of the project’s `rfisDueAt` field.
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 not provided or null, this defaults to the value of the project’s `startsAt` field.
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 not provided or null, this defaults to the value of the project’s `jobWalkAt` field.
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 (`currentAccLinkedProjectId` must have a value) to be able to set this value.
template object	Information about an existing bid package from which this bid package will be copied.
bidPackageId* string	The ID of an existing (source) bid package from which this bid package will be copied. Max length: 24
includeForm boolean	Whether to copy the source bid package’s scope-specific bid form. Possible values: `true`: (Default) The bid form is copied to the new bid package. `false`: The bid form is not copied to the new bid package.
includeFiles boolean	Whether to copy the source bid package’s files. Possible values: `true`: The files are copied to the new bid package. `false`: (Default) The files are not copied to the new bid package.
bidderStates array: string	A list of the states of the source bid package’s invites to copy to the new bid package. Default value: [ ‘UNDECIDED’, ‘NOT_BIDDING’, ‘BIDDING’, ‘BID_SUBMITTED’, ‘NOT_INVITED’ ] Max 5 bidder states per bid package.

* Required

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

Header (201)

Location string	The created resource’s location.

Response

Body Structure (201)

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: `DRAFT`: (Default) The bid package has not been published. `PUBLISHED`: The bid package has been published. An opportunity is created on a given vendor’s Bid Board when both of the following are true: The bid package is or has been moved to `PUBLISHED` state. The vendor is or has been added to the bid package.
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 `project.isBiddingSealed` set to `true`, bids cannot be viewed before this date or submitted after this date.
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: `true`: Bids have been unsealed. `false`: Bids are still sealed.
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` is null in the corresponding BuildingConnected project. This value is always optionally null.
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, `currentAccDocsFolderId` is also 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: The value of `currentAccLinkedProjectId` is null. This project isn’t linked to an ACC project.

Example

Created

Request

curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/bid-packages' \
  -X 'POST' \
  -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
  -H 'Content-Type: application/json' \
  -d '{
        "projectId": "590dd127b319f408f190b3b8",
        "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",
        "template": {
          "bidPackageId": "590dd127b319f408f190b3b8",
          "includeForm": true,
          "includeFiles": false,
          "bidderStates": [
            "UNDECIDED",
            "NOT_BIDDING",
            "BIDDING",
            "BID_SUBMITTED",
            "NOT_INVITED"
          ]
        }
      }'
Show More

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"
}
Show More

Request

Response

Jump To

bid-packages

Resource Information

Request

Headers

Request

Body Structure

Response

HTTP Status Code Summary

Response

Header (201)

Response

Body Structure (201)

Example

Request

Response