Field Guide
This field guide presents the different types of objects that are part of the BIM 360 API and gives descriptions of each field as well as typical examples.
Project
The Project entity provides a unified definition of your construction project across all BIM 360 services. A Project is linked to a Business Unit by including the business_unit_id
within the Project schema.
Schema
A project is represented by a flat JSON object with the following attributes:
id string: UUID | Project ID |
account_id string: UUID | Account ID |
name string | Name of the project
Max length: 255
|
start_date date | The starting date of a project; must be earlier than
end_date Format:
YYYY-MM-DD |
end_date date | The ending date of a project; must be later than
start_date Format:
YYYY-MM-DD |
project_type string | The type of project; accepts preconfigured and customized project types
Max length: 255
Refer to the preconfigured
project_type list in the Parameters guide. |
value float | Monetary value of the project
|
currency enum: string | |
status enum: string | The status of project.
Possible values:
|
job_number string | Project job number to connect a BIM 360 project to project or job in a financial or ERP system.
Max length: 100
|
address_line_1 string | Project address line 1
Max length: 255
|
address_line_2 string | Project address line 2
Max length: 255
|
city string | City in which project is located
Max length: 255
|
state_or_province enum: string | State or province in which project is located
Max length: 255
Note that the
state_or_province value depends on the selected country value; see the valid values in the state_or_province list in the Parameters guide. |
postal_code string | Postal code for the project location
Max length: 255
|
country enum: string | |
business_unit_id string: UUID | The business unit ID of this project |
timezone string | |
language enum: string | Language of the project; applicable to the BIM 360 Field service only
Possible values:
en : Englishde : German |
construction_type enum: string | |
contract_type enum: string | |
last_sign_in datetime: ISO 8601 | Timestamp of the last sign in, YYYY-MM-DDThh:mm:ss.sssZ format |
Example
[
{
"id": "aca11a7a-bd17-47cd-ab99-6548d0e6fe25",
"account_id": "e3d5ef8d-5c37-4b9d-925d-1e6d24753ace",
"name": "construction_project",
"start_date": "2015-05-02",
"end_date": "2016-04-03",
"project_type": "office",
"value": 3000.0,
"currency": "USD",
"status": "pending",
"job_number": "0219-01",
"address_line_1": "The Fifth Avenue",
"address_line_2": "#301",
"city": "New York",
"state_or_province": "New York",
"postal_code": "10011",
"country": "United States",
"business_unit_id": "c17e6837-96cd-4839-868e-051a2ad65d28",
"timezone": "America/New_York",
"language": "en",
"construction_type": "Renovation",
"contract_type": "Design-Bid",
"last_sign_in": null,
"created_at": "2016-04-05T07:26:20.858Z",
"updated_at": "2016-04-05T07:31:26.290Z"
}
]
Company
BIM 360 provides a master company directory to manage your business partner companies across services.
Schema
A company is represented by a flat JSON object with the following attributes:
id string: UUID | Company ID |
account_id string: UUID | Account ID |
name string | Company name should be unique under an account
Max length: 255
|
trade string | |
address_line_1 string | Comapny address line 1
Max length: 255
|
address_line_2 string | Company address line 2
Max length: 255
|
city string | City in which company is located
Max length: 255
|
state_or_province enum: string | State or province in which company is located
Max length: 255
Note that the
state_or_province value depends on the selected country value; see the valid values in the state_or_province list in the Parameters guide. |
postal_code string | Postal code for the company location
Max length: 255
|
country enum: string | |
phone string | Business phone number for the company
Max length: 255
|
website_url string | Company website
Max length: 255
|
description string | Short description or overview for company
Max length: 255
|
erp_id string | Used to associate a company in BIM 360 with the company data in an ERP system |
tax_id string | Used to associate a company in BIM 360 with the company data from public and industry sources |
Example
{
"id":"fc830fd8-f1ef-4cd6-9163-fb115dc698d7",
"account_id":"80793a28-f9b1-4888-9533-5f00cddcd6fb",
"name":"Autodesk",
"trade":"Concrete",
"address_line_1":"The Fifth Avenue",
"address_line_2":"#301",
"city":"New York",
"postal_code":"10011",
"state_or_province":"New York",
"country":"United States",
"phone":"(503)623-1525",
"website_url":"http://www.autodesk.com",
"description":"Autodesk, Inc., is a leader in 3D design, engineering and entertainment software.",
"created_at":"2016-05-20T02:24:21.400Z",
"updated_at":"2016-05-20T02:24:21.400Z",
"erp_id":"c79bf096-5a3e-41a4-aaf8-a771ed329047",
"tax_id":"213-73-8867"
}
Account User
BIM 360 provides a master member directory to manage account users across all BIM 360 services. The User belongs to a Company and is linked by including the company_id
parameter in the User schema.
Schema
A user is represented by a flat JSON object with the following attributes:
id string: UUID | User ID |
account_id string: UUID | Account ID |
role string | The role of the user in the account
Possible values:
account_admin : user has BIM 360 account administration accessaccount_user : normal project userproject_admin : user has Project administration privileges at a service level |
status string | Status of the user in the system
Possible values:
active : user is active and has logged into the system sucessfullyinactive : user is disabledpending : user is invited and is yet to accept the invitationnot_invited : user is not invited |
company_id string: UUID | The user’s default company ID in BIM 360 |
company_name string | The name of the user’s default company name in BIM 360 |
last_sign_in datetime: ISO 8601 | The time and date of the user’s most recent sign-in, in ISO 8601 format (YYYY-MM-DDThh:mm:ss.sssZ ). Note that this field is not supported by ACC Unified products. The value is updated only when the user logs into one of the following services associated with the specified BIM 360 account: BIM 360 Account Admin, BIM 360 Project Admin, BIM 360 Document Management, BIM 360 Field (Classic), or BIM 360 Plan. |
email string | User’s email
Max length: 255
|
name string | Default display name
Max length: 255
|
nickname string | Nick name for user
Max length: 255
|
first_name string | User’s first name
Max length: 255
|
last_name string | User’s last name
Max length: 255
|
uid string | User’s Autodesk ID
|
image_url string | URL for user’s profile image
Max length: 255
|
address_line_1 string | User’s address line 1
Max length: 255
|
address_line_2 string | User’s address line 2
Max length: 255
|
city string | City in which user is located
Max length: 255
|
state_or_province enum: string | State or province in which user is located
Max length: 255
Note that the
state_or_province value depends on the selected country value; see the valid values in the state_or_province list in the Parameters guide. |
postal_code string | Postal code for the user’s location
Max length: 255
|
country enum: string | |
phone string | Contact phone number for the user
Max length: 255
|
company string | Company information from the Autodesk user profile
Max length: 255
Note that this is different from company in BIM 360.
|
job_title string | User’s job title
Max length: 255
|
industry string | Industry information for user
Max length: 255
|
about_me string | Short description about the user
Max length: 255
|
Example
{
"id":"a75e8769-621e-40b6-a524-0cffdd2f784e",
"account_id":"9dbb160e-b904-458b-bc5c-ed184687592d",
"status":"active",
"role":"account_admin",
"company_id":"28e4e819-8ab2-432c-b3fb-3a94b53a91cd",
"company_name":"Autodesk",
"last_sign_in":"2016-04-05T07:27:20.858Z",
"email":"john.smith@mail.com",
"name":"John Smith",
"nickname":"Johnny",
"first_name":"John",
"last_name":"Smith",
"uid":"L9EBJKCGCXBB",
"image_url": "http://static-dc.autodesk.net/etc/designs/v201412151200/autodesk/adsk-design/images/autodesk_header_logo_140x23.png",
"address_line_1":"The Fifth Avenue",
"address_line_2":"#301",
"city":"New York",
"postal_code":"10011",
"state_or_province":"New York",
"country":"United States",
"phone":"(634)329-2353",
"company":"Autodesk",
"job_title":"Software Developer",
"industry":"IT",
"about_me":"Nothing here",
"created_at":"2015-06-26T14:47:39.458Z",
"updated_at":"2016-04-07T07:15:29.261Z"
}
Project User
BIM 360 provides a master member directory to manage project users across all BIM 360 services. We recommend using version 2.
Schema v1 (we recommend v2 - see below)
A successful response returns a flat JSON object with the following attributes:
id string: UUID | User ID |
account_id string: UUID | Account ID |
project_id string: UUID | Project ID |
role string | The role of the user in the account
Must be
project_admin , meaning that the user has Project administration privileges at a service level. |
status string | Status of the user in the system
Possible values:
active : user is active and has logged into the system sucessfullyinactive : user is disabledpending : user is invited and is yet to accept the invitation |
service_type enum: string | |
company_id string: UUID | The user’s default company ID in BIM 360 |
company_name string | The name of the user’s default company name in BIM 360 |
last_sign_in datetime: ISO 8601 | Timestamp of the last sign in, YYYY-MM-DDThh:mm:ss.sssZ format |
email string | User’s email
Max length: 255
|
name string | Default display name
Max length: 255
|
nickname string | Nick name for user
Max length: 255
|
first_name string | User’s first name
Max length: 255
|
last_name string | User’s last name
Max length: 255
|
uid string | User’s Autodesk ID
|
image_url string | URL for user’s profile image
Max length: 255
|
address_line_1 string | User’s address line 1
Max length: 255
|
address_line_2 string | User’s address line 2
Max length: 255
|
city string | City in which user is located
Max length: 255
|
state_or_province enum: string | State or province in which user is located
Max length: 255
Note that the
state_or_province value depends on the selected country value; see the valid values in the state_or_province list in the Parameters guide. |
postal_code string | Postal code for the user’s location
Max length: 255
|
country enum: string | |
phone string | Contact phone number for the user
Max length: 255
|
company string | Company information from the Autodesk user profile
Max length: 255
Note that this is different from company in BIM 360.
|
job_title string | User’s job title
Max length: 255
|
industry string | Industry information for user
Max length: 255
|
about_me string | Short description about the user
Max length: 255
|
updated_at datetime: ISO 8601 | Timestamp of the last change to the user, YYYY-MM-DDThh:mm:ss.sssZ format |
created_at datetime: ISO 8601 | Timestamp of the when the user was created, YYYY-MM-DDThh:mm:ss.sssZ format |
Example
HTTP/1.1 201 Created
Cache-Control: max-age=0, private, must-revalidate
Content-Encoding: gzip
Content-Type: application/json; charset=utf-8
Date: Tue, 03 May 2016 11:26:10 GMT
ETag: W/"6c2df86209c708aece41aa9e349b7d3d"
Server: Apache
Status: 201 Created
Vary: Accept-Encoding,User-Agent
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-Request-Id: 29627108-a011-4b87-8d06-4d08bfc22ab4
X-XSS-Protection: 1; mode=block
Content-Length: 368
Connection: keep-alive
{
"id":"79b51334-1127-4313-a0e1-4986b3e96c47",
"account_id":"9dbb160e-b904-458b-bc5c-ed184687592d",
"service_type": "field",
"status":"pending",
"role":"project_admin",
"project_id":"1e4bdc48-1bd7-4a4f-a91f-bd238cce5830",
"company_id":"14e95a5e-02eb-49aa-a39a-447d90544873",
"company_name":"Autodesk",
"email":"john.smith@mail.com",
"name":"John Smith",
"nickname":"Johnny",
"first_name":"John",
"last_name":"Smith",
"uid":"L9EBJKCGCXBB",
"image_url":"http://static-dc.autodesk.net/etc/designs/v201412151200/autodesk/adsk-design/images/autodesk_header_logo_140x23.png",
"last_sign_in":null,
"address_line_1":"The Fifth Avenue",
"address_line_2":"#301",
"city":"New York",
"postal_code":"10011",
"state_or_province":"New York",
"country":"United States",
"phone":"(634)329-2353",
"company":"Autodesk",
"job_title":"Software Developer",
"industry":"IT",
"about_me":"Nothing",
"created_at":"2016-04-07T08:45:51.063Z",
"updated_at":"2016-04-07T09:21:06.173Z"
}
Schema v2 (recommended)
A successful response returns a JSON object with the following attributes:
user_id string | The user’s BIM 360 ID.
|
account_id string | The account ID.
|
project_id string | The project ID.
|
access_level enum:string | The access level assigned to the user for the Project
Administration service. Possible value:
admin . |
access_level enum:string | The access level assigned to the user for the Document
Management service. Possible values:
admin , user . |
company_id string | The ID of the company assigned to the user.
For a list of companies for the account,
see GET companies.
|
industry_roles array:string | The IDs of the industry roles assigned to the user for the
project. For a list of industry roles for the project, see
|
Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Tue, 03 May 2016 11:26:10 GMT
{
"user_id": "0b1fb8cc-cb14-44bc-991b-eda0862acd14",
"account_id": "68a12a11-f1ce-4abf-af85-601e8e97b551",
"project_id": "93a26902-e709-43e8-b865-4f216ecfa3ff",
"services": {
"project_administration": {
"access_level": "admin"
},
"document_management": {
"access_level": "admin"
}
},
"company_id": "dc9e8af9-2978-4f6a-90b6-b294ae11c701",
"industry_roles": [
"dc9e8af9-2978-4f6a-90b6-b294ae11c701"
],
"email": "john.doe@autodesk.com"
}
Project Roles
Project roles provide information about the industry roles that can be assigned to users, for example, contractor and architect. Industry roles can be assigned to users for different services for each project.
Schema
A successful response returns an array of JSON objects with the following attributes:
id string | The industry role ID.
|
name string | The name of the industry role.
|
project_id string | The project ID.
|
access_level enum:string | The default access level assigned to the user for the industry
role for the Project Administration service.
Possible values:
admin . |
access_level enum:string | The default access level assigned to the user for the industry
role for the Document Management service.
Possible values:
admin , user . |
Example
HTTP/1.1 200 OK
Cache-Control: max-age=0, private, must-revalidate
Content-Type: application/json; charset=utf-8
Date: Tue, 03 May 2016 11:26:10 GMT
[
{
"id": "5502171c-9e38-427e-a49a-40fa6821dec4",
"project_id": "2c9958f4-722e-47cf-bd6e-6d0a7b20d50e",
"name": "Contractor",
"services": {
"project_administration": {
"access_level": "admin"
},
"document_management": {
"access_level": "admin"
}
}
}
]
Business Units
Business units are logical structures based on regional offices or locations that you use for reporting purposes.
Schema
A business unit is represented by a flat JSON object with the following attributes:
id string: UUID | Business unit ID |
account_id string: UUID | Account ID |
parent_id string: UUID | The ID of the parent business unit |
name string | The name of the business unit |
path string | The path of the business unit in the tree structure |
description string | The description of the business unit |
Example
{
"business_units":[
{
"id": "933df8fd-abb2-4e4e-8f79-95ba2afebc6c",
"account_id": "e3d5ef8d-5c37-4b9d-925d-1e6d24753ace",
"parent_id": null,
"name": "North America",
"description": "USA, Canada",
"path": null,
"created_at": "2016-04-11T03:49:09.176Z",
"updated_at": "2016-04-11T03:49:09.176Z"
},
{
"id": "fda4ab9e-ab82-4ba9-8d6c-ae7dbd7cee31",
"account_id": "e3d5ef8d-5c37-4b9d-925d-1e6d24753ace",
"parent_id": "933df8fd-abb2-4e4e-8f79-95ba2afebc6c",
"name": "USA Western Region",
"description": "California, Nevada, Washington",
"path": "North America",
"created_at": "2016-04-11T03:49:09.176Z",
"updated_at": "2016-04-11T03:49:09.176Z"
}
]
}