HQ API: Get Companies Under a Specific Project

The latest update for HQ includes an API enhancement; you can get a list of companies that are related to a specific project. The documentation is found here:

GET projects/:project_id/companies

In UI, you can find corresponding information under Project icon >> {a_given_project} >> Companies tab (see the image below).

I just gave it a try. Nothing complex. But thought keeping some snapshots (while I have it at hand) might help understand what this functionality is about more easily.

Activating API Access to Docs

Updated 2/20/2024: Autodesk Construction Cloud (ACC) has a new UI for provisioning. To provision, go to “Account Admin” >> “Custom integrations” in the left pane >> “+ Add custom integrations”, then fill your client id and app name.

Updated 3/17/2021: revised to include Autodesk Construction Cloud unified products, a.k.a. ACC unified.

Updated 1/16/2018: updated with new UI.

BIM 360 and Autodesk Construction Cloud (ACC) unified products’ Account Administration (or Account Admin for short) has a feature to control API access. I have described about this in my earlier post. As a part of recent update, this feature was extended to include the control over API access to Docs. The owner of Docs account can now activate API access to Docs and invite a developer to grant API access. 

HQ API Intro Node.js

Prompted by an inquiry through the forum post, I made a minimum sample that uses HQ API. I wanted to do “Intro Labs” series for Forge API for a while any way. He gave me a little push to start something along the line of Intro Labs. (So thank you for asking.)  Not quite to the level of Labs, yet. I hope I will be accumulating how-to materials as I write in small chunks at a time.

The Intro sample is intended for people who is new to HQ API. The sample demonstrates the following workflow:

1. Get a token using two-legged authentication
2. Get the list of companies
3. Updates a company info

Development Sandbox for BIM 360 API

7/30/2020 Update: If you are wondering if this process is still valid as it has been a while since this is written.  The answer is “Yes”.  

As I wrote earlier, BIM 360 account level API is now available as preview beta. One of the first questions we receive is about development sandbox which is suggested on the documentation. Currently, while we are still on preview mode, the sandbox or development environment is offered to the following licensees:

A member of ADN (Autodesk Developer Network) 

If you are a member of ADN (Autodesk Developer Network), you can order NFR (Not for Resale) version of license. Software and Web services for ADN membership is solely for development purpose. You can use it for your development. If you don’t have an access, but you know your company is an ADN member, please contact your company’s Account Manager. He/she can order the web services for you or if he/she has ordered one already, he/she can invite you as an BIM 360 enterprise account admin to use the API.

BIM 360 Account Level API Available As Preview Beta

BIM 360 account level API is released as preview beta. BIM 360 account level API, which is also referred as HQ (Headquarter) API, offers account management functionalities, such as the creation of projects and member controls. Currently the API is accessible for the owner of following license types:

• BIM 360 Enterprise account
• NFR (Not for Resale) version that the member of ADN (Autodesk Developer Network) can order for development purpose (*1)

I may call BIM 360 API as “HQ API” interchangeably for the sake of clarification and not to confuse audience who uses different BIM 360 product family, such as Glue and Field.

You can find the detailed explanation about HQ API on Forge documentation page:

https://developer.autodesk.com/en/docs/bim360/v1/overview/ 

BIM 360 Account ID – Where Can I Find It?

Update on 1/8/2018. Replaced with new UI.

Occasionally, you may be asked to provide Account ID of your BIM 360 account by Autodesk support personnel.

You can find it by following:

1. Log into BIM 360 Enterprise: https://admin.b360.autodesk.com/
2. Go to “SETTINGS” tab.
3. Go to “Profile” tab
4. Click on “View Account ID” button

The image below illustrates where those tabs and the button are. One marked in circle in purple is the Account Name (“Autodesk Forge Partner Development” in this example):

Mikako