Request

Response

    Installing the SDK

    The Data Exchange Connector SDK is available as a NuGet package and must be installed into your Visual Studio project as a package reference. This setup is a one-time requirement. The build process will handle the package installation and updates automatically. You just need to add a package source in your setup and then proceed to install the package into your project.

    System Requirements

    RequirementSupported Versions
    .NET .NET 10, .NET 8, .NET Framework 4.8
    Platform Windows x64
    Visual Studio 2022 or later

    New in 7.4.0: .NET 10 support added.

    New in 7.4.0: The SDK now ships as a self-contained build. Package sizes: SDK — 264.9 MB, UI — 7.9 MB. A future release will reduce the size through assembly trimming.

    Before You Begin

    Note: The APS authorization page displays permission labels in platform terminology. The following table describes what each scope allows in the context of the Data Exchange SDK:

    ScopeWhat it allows
    data:read Read project files, folders, and exchange data from your Forma account
    data:write Update exchange data and write file content to your Forma projects
    data:create Create new exchanges and upload files to your Forma projects

    Note: When the SDK opens the browser for sign-in, users see an OAuth consent screen listing the permissions described above. This is expected behavior.

    • Verify that you have access to Forma (formerly Autodesk Construction Cloud).
    • To access your BIM 360/Forma account, you must add your application’s client ID to your BIM 360/Forma account. For more instructions, refer to Manage API Access to BIM 360 Services.

    Note: Starting with version 6.3.0, the SDK no longer includes Newtonsoft.Json as a transitive dependency. If your project uses Newtonsoft.Json for your own code, you will need to add it explicitly to your project dependencies.

    Procedure

    Follow these steps to install the Data Exchange SDK (.NET) NuGet package in Visual Studio.

    1. Download and extract the zip of Data Exchange SDK installable from the Feedback portal.
    2. Start Visual Studio > Create a new Project. This will create a new project.
    3. Navigate to the NuGet Package Manager settings through Tools -> NuGet Package Manager -> Package Manager Settings.
    4. Add a new entry under Package Sources and click the … button to select the local directory where the downloaded packages are located. This adds a local Package Source from where the NuGet packages can be installed.
    5. Navigate to your project through Solution Explorer. Select Project > Manage Nuget Packages. This opens the NuGet package manager.
    6. Switch to your new Package source by using the drop-down menu on the right, and then search for the following packages in the upper-left search box.

      • Autodesk.DataExchange
      • Autodesk.DataExchange.UI
      • Autodesk.DataExchange.GeometryDefinitions
    7. In the right pane, select the latest version from the drop-down list. If you want to include pre-release versions in the Version list, select Include prerelease.
    8. Click Install to install the NuGet package. You may be asked to accept license terms or prompted to verify the installation.
    9. Visual Studio installs the package and its dependencies in the project. When installation is complete, the added packages appear on the Installed tab. You can also find packages in the Dependencies > Packages node of your project in Solution Explorer. After you install a package, you can refer to it in the project with a using statement.

    Important: Starting with version 6.3.0, the Data Exchange SDK has migrated to Autodesk.Newtonsoft.Json from Newtonsoft.Json. If your connector or client application requires Newtonsoft.Json for JSON serialization, install it explicitly from NuGet.org. Do not use Autodesk.Newtonsoft.Json in your connector or client applications.

    Important: The Data Exchange SDK (.NET) and the associated support DLLs are 64-bit system. By default, Visual Studio automatically configures the newly created C# projects to Any CPU. You must make sure to set your projects to x64 platform to maintain a stable runtime behavior.