README.md

Sample - APS Parameters Assets Custom Attributes Converter

Description

This sample demonstrated the capabilities of importing categories and parameter definitions from Autodesk Parameter Services to Autodesk Build Assets' categories and custom fields using Autodesk APS API, especially ACC Assets API and Parameters API.

This simple application is built by following the Hubs Browser tutorial from hhttps://aps.autodesk.com/tutorials.

Demonstration

Here is the video demonstrating how this sample works quickly.

Development

Prerequisites

• APS application
• Provisioned access to Autodesk Docs or Autodesk Construction Cloud
• Node.js (we recommend the Long Term Support version)
• Terminal (for example, Windows Command Prompt or macOS Terminal)

Setup & Run

• Clone this repository
• Install dependencies: yarn install or npm install
• Setup environment variables:
  • APS_CLIENT_ID - your APS application client ID
  • APS_CLIENT_SECRET - your APS application client secret
  • APS_CALLBACK_URL - URL for your users to be redirected to after they successfully log in with their Autodesk account
    • For local development, the callback URL is http://localhost:8080/api/auth/callback
    • For applications deployed to a custom domain, the callback URL is http://<your-domain>/api/auth/callback or https://<your-domain>/api/auth/callback
    • Do not forget to update the callback URL for your application in https://aps.autodesk.com/myapps as well
  • SERVER_SESSION_SECRET - arbitrary phrase used to encrypt/decrypt server session cookies
• Run the server: yarn start or npm start

When using Visual Studio Code, you can specify the env. variables listed above in a .env file in this folder, and run & debug the application directly from the editor.

Troubleshooting

Please contact us via https://aps.autodesk.com/en/support/get-help.

Further Reading

Documentation:

• Parameter API
• ACC/BIM360 Assets API Field Guide
• ACC API and App Provisioning
• Data Management API

Tutorials:

• Setup ACC/BIM360 Assets Project Settings
• Retrieve ACC/BIM360 Assets Data
• Managing ACC/BIM360 Assets
• APS Tutorial - Hubs Viewer

Blogs:

• APS Blog
• Field of View, a BIM focused blog

License

This sample is licensed under the terms of the MIT License. Please see the LICENSE file for more details.

Written by

Eason Kang in/eason-kang-b4398492/, Developer Advocacy and Support Team