submittalsacc Schema Description
Documentation Updated: 2024-06-26- attachments
- comments
- custom_identifier_settings
- item_watchers
- items
- itemtype
- packages
- specs
- steps
- tasks
attachments
Attachments for ACC Build Submittal items.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the Attachment | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | item_id | string: UUID | The ID for the parent Item Foreign Key: Table: items Column: id | |
5 | name | string | Name of the file | |
6 | revision | number | Revision of the item when the attachment was added | |
7 | created_by | string | Autodesk User ID of the user that created the attachment | |
8 | created_at | timestamp: SQL | Date and time when the attachment created | |
9 | updated_at | timestamp: SQL | Date and time when the attachment last updated | |
10 | updated_by | string | Autodesk User ID of the user that last updated the attachment | |
11 | upload_urn | string | storage URN where attachments are uploaded | |
12 | category_id | string | ID of the attachment category | |
13 | category_value | string | value of the category_id | |
14 | task_id | string: UUID | The ID for the parent Task Foreign Key: Table: tasks.id Column: | |
15 | is_file_uploaded | boolean | Was the upload process completed successfully | |
16 | urn | string | ID of the version of the file |
comments
Comments for ACC Build Submittal items.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the Comment | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | item_id | string: UUID | The ID for the parent Item Foreign Key: Table: items Column: id | |
5 | updated_by | string | Autodesk User ID of the user that last updated the comment | |
6 | updated_at | timestamp: SQL | Date and time when the comment updated | |
7 | created_by | string | Autodesk User ID of the user that created the comment | |
8 | created_at | timestamp: SQL | Date and time when the comment was created | |
9 | body | string | Body of the comment |
custom_identifier_settings
Submittal custom identifier settings for the ACC Build system.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the custom identifier settings | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | updated_by | string | Autodesk User ID of the user that last updated the task | |
5 | updated_at | timestamp: SQL | Date and time when the task was updated | |
6 | can_switch_type | boolean | Defaults to 'True', after one usage the value will be set to 'False' permanently. | |
7 | sequence_type | enum: string | Possible Values:
| Project current sequence type |
item_watchers
List of Autodesk User IDs of distribution_list users and their typeordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | item_id | string: UUID | ID for the Item Foreign Key: Table: items Column: id | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | user_id | string | Autodesk User IDs of cc'ed user/role/company | |
5 | user_type_id | string | Possible Values:
| if of the distribution_list member user_type (user/role/company) |
6 | user_type_value | string | value of the user_type_id |
items
Submittal items for the ACC Build system.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | The ID for the Submittal. | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | spec_id | string: UUID | ID for the associated Spec Foreign Key: Table: specs Column: id | |
5 | spec_identifier | string | Identifier of the spec this item related to | |
6 | title | string | Title (name) of the item | |
7 | type_id | string | ID for the item type Foreign Key: Table: item type Column: id | |
8 | type_value | string | value of the item type_id | |
9 | response_comment | string | Response comment of the item (in addition to response id) | |
10 | ball_in_court | string | Array of Autodesk User IDs of the users that are ball in court for the item workflow Schema Change: formerly assigned_to (now we have multiple reviewers) Schema Change: Deprecated field | |
11 | revision | number | Revision of the item | |
12 | responded_by | string | Autodesk User ID of the user that responded | |
13 | description | string | Description of the item | |
14 | responded_at | timestamp: SQL | Date and time when response was added | |
15 | due_date | date: string | Date and time for the item to be done with current state | |
16 | required_on_job_date | date: string | Date and time for the item to be done on site | |
17 | manager | string | Autodesk User ID / Role member group ID / Company member group ID of the manager | |
18 | created_by | string | Autodesk User ID of the user that created the item | |
19 | created_at | timestamp: SQL | when was the item created | |
20 | state_id | string | State of the item | |
21 | response_id | string | ID of the response, if was added. Foreign Key: Table: response Column: id | |
22 | response_value | string | value of the response_id | |
23 | subsection | string | Sub spec section | |
24 | subcontractor | string | Autodesk User ID / Role member group ID / Company member group ID of the subcontractor | |
25 | identifier | number | Identifier of the item. Created automatically | |
26 | updated_by | string | Autodesk User ID of the user the last updated the item | |
27 | updated_at | timestamp: SQL | last time the item was updated | |
28 | status_id | enum: string | Possible Values:
| Status ID |
29 | status_value | string | value of the status_id | |
30 | package_title | string | Title of the package the item is related to (if any) | |
31 | package | string: UUID | ID for the associated Package Foreign Key: Table: packages.id Column: | |
32 | package_identifier | number | Identifier of the package the item is related to (if any) | |
33 | priority_id | number | Possible Values:
| id of the priority the item is related to (if any) |
34 | priority_value | string | value of the priority_id | |
35 | required_date | date: string | item's required date | |
36 | required_approval_date | date: string | item's required approval date | |
37 | lead_time | number | item's lead time | |
38 | sent_to_submitter | timestamp: SQL | when the submitter received the item | |
39 | received_from_submitter | timestamp: SQL | When the submitter moved the item forward | |
40 | submitted_by | string | Autodesk User ID of the user that submitted the item to the manager | |
41 | sent_to_review | timestamp: SQL | When the first review step started Schema Change: formerly sent_to_reviewer (now we have multiple reviewers) | |
42 | sent_to_review_by | string | Autodesk User ID of the user that submitted the item to review | |
43 | received_from_review | timestamp: SQL | When the review finished Schema Change: formerly received_from_reviewer | |
44 | published_date | timestamp: SQL | When the item was closed and distributed | |
45 | published_by | string | Autodesk User ID of the user that published the item | |
46 | submitter_due_date | date: string | When the responsible contractor submission is due | |
47 | manager_due_date | date: string | When the manager review is due | |
48 | ball_in_court_users | string | Array of Autodesk User IDs of the users that are ball in court for the item workflow | |
49 | ball_in_court_roles | string | Array of Role member group IDs of the roles that are ball in court for the item workflow | |
50 | ball_in_court_companies | string | Array of Company member group IDs of the companies that are ball in court for the item workflow | |
51 | manager_type | enum: string | Possible Values:
| Indication for manager id type |
52 | subcontractor_type | enum: string | Possible Values:
| Indication for subcontractor id type |
53 | custom_identifier | string | The custom identifier of the item. | |
54 | custom_identifier_sort | string | Same value as 'custom_identifier' but this column has db collation in order to enable sorting by the custom identifier value. | |
55 | custom_identifier_human_readable | string | Ingested custom identifier of the item. May include the item spec identifier along with the custom identifier value. |
itemtype
Submittal types for ACC Build Submittal items.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the type | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | created_at | timestamp: SQL | Date and time when the typye created | |
5 | updated_by | string | Autodesk User ID of the user that last updated the typye | |
6 | updated_at | timestamp: SQL | Date and time when the type last updated | |
7 | created_by | string | Autodesk User ID of the user that created the type | |
8 | value | string | Value of the type | |
9 | platform_id | string | For default types | |
10 | is_active | boolean | Is the type active |
packages
Submittal Packages for the ACC Build system.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the Package | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | spec_id | string: UUID | ID for the associated Spec Foreign Key: Table: specs Column: id | |
5 | title | string | Title of the package | |
6 | identifier | number | Identifier of the package. Created Automatically | |
7 | description | string | Description for the package | |
8 | updated_by | string | Autodesk User ID of the user that last updated the package | |
9 | created_at | timestamp: SQL | Date and time when the spec was created | |
10 | created_by | string | Autodesk User ID of the user that created the package | |
11 | updated_at | timestamp: SQL | Date and time when spec was last updated | |
12 | spec_identifier | string | Identifier of the spec this package related to |
specs
Submittal Spec Sections for the ACC Build system.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
2 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
3 | id | string: UUID | ID for the Spec Section | |
4 | identifier | string | Spec identifier. Created by the user | |
5 | title | string | Title of the spec | |
6 | created_at | timestamp: SQL | Date and time when the spec was created | |
7 | created_by | string | Autodesk User ID of the user that created the spec | |
8 | updated_at | timestamp: SQL | Date and time when the spec was updated | |
9 | updated_by | string | Autodesk User ID of the user that last updated the spec |
steps
Review steps for ACC Build Submittal items.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the step | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | updated_by | string | Autodesk User ID of the user that last updated the step | |
5 | updated_at | timestamp: SQL | Date and time when the step was updated | |
6 | created_by | string | Autodesk User ID of the user that created the step | |
7 | created_at | timestamp: SQL | Date and time when the step was created | |
8 | status | enum: string | Possible Values:
| The status of the step |
9 | step_number | number | The order of the step in the review workflow | |
10 | days_to_respond | number | Number of days that the reviewers have to respond | |
11 | due_date | date: string | Date for the item to be done with current state | |
12 | started_at | timestamp: SQL | Date and time when the step started | |
13 | completed_at | timestamp: SQL | Date and time when the step finished | |
14 | item_id | string: UUID | The ID for the parent Item Foreign Key: Table: items Column: id |
tasks
Review tasks for ACC Build Submittal items.ordinal_position | column_name | data_type | constraints | notes |
---|---|---|---|---|
1 | id | string: UUID | ID for the task | |
2 | bim360_account_id | string: UUID | BIM 360 HQ Account ID. | |
3 | bim360_project_id | string: UUID | BIM 360 HQ Project ID. | |
4 | updated_by | string | Autodesk User ID of the user that last updated the task | |
5 | updated_at | timestamp: SQL | Date and time when the task was updated | |
6 | created_by | string | Autodesk User ID of the user that created the task | |
7 | created_at | timestamp: SQL | Date and time when the task was created | |
8 | status | enum: string | Possible Values:
| The status of the task |
9 | assigned_to | string | Autodesk User ID / Role member group ID / Company member group ID that the task is assigned to | |
10 | is_required | boolean | Is the task a required task in the review step | |
11 | response_comment | string | Response comment of the task (in addition to response id) | |
12 | responded_at | timestamp: SQL | Date and time when response was added | |
13 | responded_by | string | Autodesk User ID of the user that responded | |
14 | started_at | timestamp: SQL | Date and time when the task started | |
15 | completed_at | timestamp: SQL | Date and time when the task finished | |
16 | completed_by | string | Autodesk User ID of the user that closed the task | |
17 | response_value | string | value of the response_id | |
18 | response_id | string: UUID | ID of the response, if was added. Foreign Key: Table: response.id Column: | |
19 | step_id | string: UUID | ID of the parent step Foreign Key: Table: steps.id Column: | |
20 | assigned_to_type | enum: string | Possible Values:
| Indication for assigned_to id type |