Project Browsing

In this step we'll extend our server so that we can browse the projects of Autodesk Construction Cloud. We will basically get the hierarchy of hubs, projects using Data Management APIs:

Browsing hubs

First, let's add a couple of helper methods for browsing through the hubs, projects:

Node.js & VSCode

Let's implement the logic for browsing through the individual hubs, projects.

First, let's include the Data Management SDK, add the @aps_sdk/data-management library, and also create an instance of SDK client of DataManagementClient at the beginning of services/aps.js file:

services/aps.js

const { SdkManagerBuilder } = require('@aps_sdk/autodesk-sdkmanager');
const { AuthenticationClient, Scopes, ResponseType } = require('@aps_sdk/authentication');
const { DataManagementClient } = require('@aps_sdk/data-management');
const { APS_CLIENT_ID, APS_CLIENT_SECRET, APS_CALLBACK_URL } = require('../config.js');

const service = module.exports = {};

const sdk = SdkManagerBuilder.create().build();
const authenticationClient = new AuthenticationClient(sdk);
const dataManagementClient = new DataManagementClient(sdk);

And then append the following code to the end of the services/aps.js file:

services/aps.js

// Data Management APIs
service.getHubs = async (token) => {
    const resp = await dataManagementClient.getHubs({ accessToken: token.access_token });
    return resp.data.filter((item)=>{
        return item.id.startsWith('b.');
    })
};

service.getProjects = async (hubId, token) => {
    const resp = await dataManagementClient.getHubProjects(hubId, { accessToken: token.access_token});
    return resp.data.filter( (item)=>{
        return item.attributes.extension.data.projectType == 'ACC';
    } )
};

tip

The method dataManagementClient.getHubProjects() returns these projects that the current user is involed, it's different from the ACC Admin GET Projects API which returns all the projects including those the user is not involved.

.NET & VSCode

Create a APS.Hubs.cs under the Models subfolder with the following content:

Models/APS.Hubs.cs

using System.Collections.Generic;
using System.Threading.Tasks;
using Autodesk.DataManagement;
using Autodesk.DataManagement.Model;
using System;
using System.Linq;

public partial class APS
{
    public async Task<IEnumerable<dynamic>> GetHubs(Tokens tokens)
    {
        DataManagementClient dataManagementClient = new DataManagementClient(_SDKManager);
        var getHubs = await dataManagementClient.GetHubsAsync(accessToken: tokens.AccessToken);
        var hubsData = getHubs.Data.Where(hub => hub.Id.StartsWith("b."));
        return hubsData;
    }

    public async Task<IEnumerable<dynamic>> GetProjects(string hubId, Tokens tokens)
    {
        DataManagementClient dataManagementClient = new DataManagementClient(_SDKManager);
        var hubProjects = await dataManagementClient.GetHubProjectsAsync(hubId: hubId, accessToken: tokens.AccessToken);
        return hubProjects.Data
        .Where(project => project.Attributes.Extension.Data.TryGetValue("projectType", out var projectType) &&
                          projectType?.ToString() == "ACC")
        .ToList();
    }   
}

.NET & VS2022

Create a APS.Hubs.cs under the Models subfolder with the following content:

Models/APS.Hubs.cs

using System.Collections.Generic;
using System.Threading.Tasks;
using Autodesk.DataManagement;
using Autodesk.DataManagement.Model;
using System;
using System.Linq;

public partial class APS
{
    public async Task<IEnumerable<dynamic>> GetHubs(Tokens tokens)
    {
        DataManagementClient dataManagementClient = new DataManagementClient(_SDKManager);
        var getHubs = await dataManagementClient.GetHubsAsync(accessToken: tokens.AccessToken);
        var hubsData = getHubs.Data.Where(hub => hub.Id.StartsWith("b."));
        return hubsData;
    }

    public async Task<IEnumerable<dynamic>> GetProjects(string hubId, Tokens tokens)
    {
        DataManagementClient dataManagementClient = new DataManagementClient(_SDKManager);
        var hubProjects = await dataManagementClient.GetHubProjectsAsync(hubId: hubId, accessToken: tokens.AccessToken);
        return hubProjects.Data
        .Where(project => project.Attributes.Extension.Data.TryGetValue("projectType", out var projectType) &&
                          projectType?.ToString() == "ACC")
        .ToList();
    }   
}

Server endpoints

Next, let's expose the new functionality to the client-side code through another set of endpoints.

Node.js & VSCode

Create a hubs.js file under the routes subfolder with the following content:

routes/hubs.js

const express = require('express');
const { authRefreshMiddleware, getHubs, getProjects } = require('../services/aps.js');

let router = express.Router();

router.use('/api/hubs', authRefreshMiddleware);

router.get('/api/hubs', async function (req, res, next) {
    try {
        const hubs = await getHubs(req.oAuthToken);
        res.json(hubs);
    } catch (err) {
        next(err);
    }
});

router.get('/api/hubs/:hub_id/projects', async function (req, res, next) {
    try {
        const projects = await getProjects(req.params.hub_id, req.oAuthToken);
        res.json(projects);
    } catch (err) {
        next(err);
    }
});

module.exports = router;

And mount the router to our server application by modifying server.js:

server.js

const express = require('express');
const session = require('cookie-session');
const { PORT, SERVER_SESSION_SECRET } = require('./config.js');

let app = express();
app.use(express.static('wwwroot'));
app.use(session({ secret: SERVER_SESSION_SECRET, maxAge: 24 * 60 * 60 * 1000 }));
app.use(require('./routes/auth.js'));
app.use(require('./routes/hubs.js'));
app.listen(PORT, () => console.log(`Server listening on port ${PORT}...`));

.NET & VSCode

Create a HubsController.cs file under the Controllers subfolder with the following content:

Controllers/HubsController.cs

using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

[ApiController]
[Route("api/[controller]")]
public class HubsController : ControllerBase
{
    private readonly ILogger<HubsController> _logger;
    private readonly APS _aps;

    public HubsController(ILogger<HubsController> logger, APS aps)
    {
        _logger = logger;
        _aps = aps;
    }

    [HttpGet()]
    public async Task<ActionResult<string>> ListHubs()
    {
        var tokens = await AuthController.PrepareTokens(Request, Response, _aps);
        if (tokens == null)
        {
            return Unauthorized();
        }
        var hubs = await _aps.GetHubs(tokens);
        return JsonConvert.SerializeObject(hubs);
    }

    [HttpGet("{hub}/projects")]
    public async Task<ActionResult<string>> ListProjects(string hub)
    {
        var tokens = await AuthController.PrepareTokens(Request, Response, _aps);
        if (tokens == null)
        {
            return Unauthorized();
        }
        var projects = await _aps.GetProjects(hub, tokens);
        return JsonConvert.SerializeObject(projects);
    }
}

The controller handles several endpoints for browsing the content in other APS-based applications such as BIM 360 Docs and ACC. We will make use of these endpoints when building the UI part of the application.

.NET & VS2022

Create a HubsController.cs file under the Controllers subfolder with the following content:

Controllers/HubsController.cs

using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

[ApiController]
[Route("api/[controller]")]
public class HubsController : ControllerBase
{
    private readonly ILogger<HubsController> _logger;
    private readonly APS _aps;

    public HubsController(ILogger<HubsController> logger, APS aps)
    {
        _logger = logger;
        _aps = aps;
    }

    [HttpGet()]
    public async Task<ActionResult<string>> ListHubs()
    {
        var tokens = await AuthController.PrepareTokens(Request, Response, _aps);
        if (tokens == null)
        {
            return Unauthorized();
        }
        var hubs = await _aps.GetHubs(tokens);
        return JsonConvert.SerializeObject(hubs);
    }

    [HttpGet("{hub}/projects")]
    public async Task<ActionResult<string>> ListProjects(string hub)
    {
        var tokens = await AuthController.PrepareTokens(Request, Response, _aps);
        if (tokens == null)
        {
            return Unauthorized();
        }
        var projects = await _aps.GetProjects(hub, tokens);
        return JsonConvert.SerializeObject(projects);
    }
}

The controller handles several endpoints for browsing the content in other APS-based applications such as BIM 360 Docs and ACC. We will make use of these endpoints when building the UI part of the application.

Try it out

Start (or restart) the app from Visual Studio Code as usual, and navigate to http://localhost:8080/api/hubs in the browser. The server should respond with a JSON list of all the hubs you have access to. Try copying the ID of one of the hubs, and use it in another address: http://localhost:8080/api/hubs/your-hub-id/projects. In this case the server application should respond with a JSON list of all projects available under the specified hub.

info

If you skipped the login procedure in the previous step, or restarted your server application, you may need to go to http://localhost:8080/api/auth/login again to make sure that all the authentication data is available in cookies before testing the /api/hubs endpoint.

tip

If you are using Google Chrome, consider installing JSON Formatter or a similar extension to automatically format JSON responses.