admin Schema Description
Documentation Updated: 2024-10-21
Service List for the Account
1 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
2 | service | enum: string | Possible Values:
- documentManagement
- projectManagement
- costManagement
- designCollaboration
- fieldManagement
- modelCoordination
- field
- glue
- plan
- insight
| BIM 360 Service |
This is a list of accounts in BIM 360. For individual customer exports, this table will only include the single customer's information.
1 | bim360_account_id | string: UUID | | Account Identifier |
2 | display_name | string | Max length: 255 | Display name of the account |
3 | start_date | timestamp: SQL | | Start of the account availability |
4 | end_date | timestamp: SQL | | End of the account availability |
Business units for use in BIM 360.
1 | id | string: UUID | | ID of the Business Unit |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | parent_id | string: UUID | | Parent ID of the Business Unit |
4 | name | string | Max length: 255 | Name of the Business Unit |
5 | description | string | Max length: 255 | Description for the Business Unit |
Company organizations for use in BIM 360.
1 | id | string: UUID | | Company ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | name | string | Max length: 255 | Name of the company |
4 | trade | enum: string | Max length: 255 | Trade of the company |
5 | category | string | Max length: 255 | Category for the company |
6 | address_line1 | string | Max length: 255 | Company specified address |
7 | address_line2 | string | Max length: 255 | Company specified address |
8 | city | string | Max length: 255 | City for the Company address |
9 | state_or_province | string | Max length: 255 | State for the Company address |
10 | postal_code | string | Max length: 255 | Postal code for the address |
11 | country | string | Max length: 255 | Country of the address |
12 | phone | string | Max length: 255 | Phone for the company |
13 | website_url | string | Max length: 255 | Web site for the company |
14 | description | string | Max length: 255 | Description of the company |
15 | erp_id | string | Max length: 255 | ERP Id |
16 | tax_id | string | Max length: 255 | Tax ID |
17 | status | enum: string | Possible Values:
| Status of the company |
18 | created_at | timestamp: SQL | | Date company created |
19 | project_size | number | | Size of project |
20 | user_size | number | | User size of project |
21 | custom_properties | string | Max length: 255 | Customer defined properties |
The company list for projects in BIM 360.
1 | project_id | string: UUID | | Project ID |
2 | company_id | string: UUID | | The company ID for the company that is a part of the project |
3 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
4 | company_oxygen_id | string | | Oxygen ID for the company |
The Product List for the Project
1 | bim360_project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | product_key | enum: string | Possible Values:
- autoSpecs
- build
- buildingConnected
- capitalPlanning
- cost
- designCollaboration
- docs
- financials
- insight
- modelCoordination
- projectAdministration
- takeoff
| Bim360/Acc Product |
4 | status | enum: string | Possible Values:
- active
- activating
- inactive
- activationFailed
- deactivationFailed
- deactivating
| Status of the product |
5 | created_at | timestamp: SQL | | Date/time service was added |
The project roles for projects in BIM 360.
1 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
2 | bim360_project_id | string: UUID | | Project ID |
3 | role_oxygen_id | string | | Oxygen ID for the role |
4 | name | string | | Name for the role |
5 | status | enum: string | Possible Values:
| Status of the role |
The Service List for the Account
1 | project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | service | enum: string | Possible Values:
- documentManagement
- projectManagement
- costManagement
- designCollaboration
- fieldManagement
- modelCoordination
- field
- glue
- plan
- insight
| BIM 360 Service |
4 | status | enum: string | Possible Values:
| Status of the service |
5 | created_at | timestamp: SQL | | Date/time service was added |
The company list for projects in BIM 360.
1 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
2 | company_oxygen_id | string: UUID | | Oxygen ID for the company |
3 | project_id | string: UUID | | Project ID |
4 | user_id | string: UUID | | The user ID for the member of the company |
The product list for the users in a particular project
1 | bim360_project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | user_id | string: UUID | | The user ID for the member of the project |
4 | product_key | enum: string | Possible Values:
- autoSpecs
- build
- buildingConnected
- capitalPlanning
- cost
- designCollaboration
- docs
- financials
- insight
- modelCoordination
- projectAdministration
- takeoff
| ACC product the user has access to for this project |
5 | access_level | enum: string | Possible Values:
- project_user
- project_admin
| The Project access level for the user |
6 | created_at | timestamp: SQL | | Date user added to the product |
The list of roles for the user in a particular project
1 | project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | user_id | string: UUID | | The user ID for the member of the project |
4 | role_id | string: UUID | | The role the user has for this particular project |
5 | created_at | timestamp: SQL | | Date user added to project |
The service list for the user in a particular project
1 | project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | user_id | string: UUID | | The user ID for the member of the project |
4 | service | enum: string | Possible Values:
- projectAdministration
- documentManagement
- projectManagement
- costManagement
- designCollaboration
- fieldManagement
- modelCoordination
- field
- glue
- plan
- insight
| BIM 360 Service the user has access to for this project |
5 | role | enum: string | Possible Values:
- project_user
- project_admin
| The Project role for the user |
6 | created_at | timestamp: SQL | | Date user added |
The user list for projects
1 | bim360_project_id | string: UUID | | Project ID |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | user_id | string: UUID | | The user ID for the member of the project |
4 | status | string | Possible Values:
- active
- activating
- deleted
| The user's status for the project |
5 | company_id | string: UUID | | The user's assigned company for the project |
6 | access_level | string | Possible Values:
- project_user
- project_admin
| The user's access level for the project |
7 | created_at | timestamp: SQL | | Created date |
8 | updated_at | timestamp: SQL | | Updated date |
Projects in BIM 360.
The industry roles for use in BIM 360.
1 | id | string: UUID | | The ID of the Role |
2 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
3 | name | string | Max length: 255 | The Name of the Role |
4 | status | enum: string | Possible Values:
| Status of the Role |
Users in BIM 360.
1 | id | string: UUID | | The HQ User ID |
2 | autodesk_id | string | Max length: 255 | Autodesk User ID |
3 | bim360_account_id | string: UUID | | BIM 360 HQ Account ID. |
4 | email | string | Max length: 255 | Email address for the user |
5 | name | string | Max length: 255 | Name for the user |
6 | first_name | string | Max length: 255 | First name of the user |
7 | last_name | string | Max length: 255 | Last name of the user |
8 | address_line1 | string | Max length: 255 | User specified address |
9 | address_line2 | string | Max length: 255 | User specified address |
10 | city | string | Max length: 255 | City for the user address |
11 | state_or_province | string | Max length: 255 | State for the user address |
12 | postal_code | string | Max length: 255 | Postal code for the address |
13 | country | string | Max length: 255 | Country for the user |
14 | last_sign_in | timestamp: SQL | | Last time the user has signed in to BIM 360 |
15 | phone | string | Max length: 255 | Phone number for the user |
16 | job_title | string | Max length: 255 | User specified job title |
17 | access_level_account_admin | boolean | | Account Administrator |
18 | access_level_project_admin | boolean | | Indicates the user is a project admin for at least 1 active project |
19 | access_level_project_member | boolean | | Indicates the user is participating in at least 1 active project in which they are not an admin |
20 | access_level_executive | boolean | | Account Executive |
21 | default_role_id | string: UUID | Max length: 255 | ID of the account role to set when adding users to additional projects. For example if this ID is for 'Architect' then by default the user will be set to an 'Architect' role in any projects. |
22 | default_company_id | string: UUID | Max length: 255 | ID of the company ID to set when adding users to additional projects. |
23 | status | string | Possible Values:
| Current status of a user in the account |
24 | status_reason | string | | Reason for the current user status in the account |
25 | created_at | timestamp: SQL | | Time user was added to the account |
26 | updated_at | timestamp: SQL | | Last time the user record was updated |