scope-specific-bid-forms
Retrieves a list of the scope-specific bid forms created by the user’s company.
The term “scope-specific” is displayed in the BuildingConnected applications and refers specifically to a given bid package; for example, the “Concrete” bid package may have its own scope-specific bid form.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/buildingconnected/v2/scope-specific-bid-forms |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
Request
Query String Parameters
cursorState string | An opaque cursor token that identifies where the next page of paginated results should start. It’s returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.
Omit this parameter to initiate a paginated request or to restart pagination. |
limit int | The maximum number of records that the endpoint may return per page.
Note that a returned page may contain fewer records than the limit under either of these conditions:
Default value: |
filter[projectId] string | The ID of a project with which the objects returned in the response must be associated. |
filter[bidPackageId] string | The ID of a bid package with which the objects returned in the response must be associated. |
filter[updatedAt] string | The required range of dates and times during which the last update must have been made to the objects returned in the response, in ISO 8601 format.
A single date and time takes this format: |
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)
pagination object | The pagination details of a response. |
limit int | The maximum number of records to return per page.
Note that a returned page may contain fewer records than the limit under either of these conditions:
|
cursorState string | An opaque cursor token that identifies where the next page of paginated results should start. It’s returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.
Omit this parameter to initiate a paginated request or to restart pagination. |
nextUrl string | The URL path that returns the next page of data. |
results array: object | Information about the returned scope-specific bid forms that were created by the current user’s company. |
id string | The ID of the scope-specific bid form.
Max length: 24 |
projectId string | The ID of the project that the bid form addresses.
Max length: 24 |
bidPackageId string | The ID of the bid package that the bid form addresses.
Max length: 24 |
createdBy string | The ID of the user who created the scope-specific bid form.
Max length: 24 |
updatedBy string | The ID of the user who last updated the scope-specific bid form.
Max length: 24 |
createdAt datetime: ISO 8601 | The date and time that the scope-specific form was created, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time that the scope-specific form was last updated, in ISO 8601 format. |
isTemplate boolean | Indicates whether this bid form a is a template or an actual scope-specific bid form for a project.
|
lineItems object | An array of line items. |
pagination object | The pagination details of a response. |
limit int | The maximum number of records to return per page.
Note that a returned page may contain fewer records than the limit under either of these conditions:
|
cursorState string | An opaque cursor token that identifies where the next page of paginated results should start. It’s returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.
Omit this parameter to initiate a paginated request or to restart pagination. |
nextUrl string | The URL path that returns the next page of data. |
results array: object | |
id string | The unique ID of the scope-specific line item.
Max length: 24 |
type enum:string | The type of the scope-specific line item.
The possible values have the following UI equivalents:
|
description string | A description of the scope-specific line item. |
section string | The section that the scope-specific line item is under. This value is null if the item is not under a section. |
isRequired boolean | Indicates whether the scope-specific line item is required. Possible values:
|
unit enum:string | The unit format of the scope-specific line item.
The possible values of this field depend on the value of
Note that the value |
code string | The code associated with the scope-specific line item. This value is null if type is not COST_BREAKDOWN . Only COST_BREAKDOWN type items have a code. |
quantity number | The quantity of the scope-specific line item. This value is null under either of the following conditions:
|
isQuantityFixed boolean | Indicates whether the scope-specific line item quantity is fixed. If it is fixed, bidders cannot change it. Possible values:
|
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
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/scope-specific-bid-forms?filter[updatedAt]=2020-05-01T06:00:00.000Z..' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 100,
"cursorState": "eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9",
"nextUrl": ""
},
"results": [
{
"id": "5af0892518d349f6d59e1bbb",
"projectId": "59d2bd7440b36a0da258f24d",
"bidPackageId": "590dd127b359f408f190b5a7",
"createdBy": "5542856b27aae240452fce62",
"updatedBy": "5542856b27aae240452fce62",
"createdAt": "2021-08-19T23:07:16.083Z",
"updatedAt": "2021-08-20T23:07:16.083Z",
"isTemplate": false,
"lineItems": {
"pagination": {
"limit": 100,
"cursorState": "eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9",
"nextUrl": ""
},
"results": [
{
"id": "53811754d3a604966df72247",
"type": "COST_BREAKDOWN",
"description": "Duct Insulation",
"section": "Furnish & Install",
"isRequired": true,
"unit": "HOURS",
"code": "D2",
"quantity": 1000,
"isQuantityFixed": true,
"external": {
"id": "",
"name": ""
}
}
]
}
}
]
}