Request

Response

    Compare Elementgroups Sample Workflow

    Comparing elementgroups can help architects and designers create more effective and functional buildings that meet the needs of their clients and occupants. By evaluating different options and approaches, they can find innovative solutions and create unique and inspiring spaces.

    To run the sample, please review setup instructions.

    Before You Begin

    1. If you do not have an app registered, follow the procedure outlined in Create an App to sign up for an APS account (if required) and obtain a Client ID for your app.

      • Make sure that you add the following as the Callback URL: http://localhost:8080/api/auth/callback
      • Contact us to enable AEC Data Model API for your app and Forma hub.
    2. Install .NET 6
    3. Clone or download the Git Repository. It’s recommended to install GitHub desktop. To clone it via command line, use the following command (Terminal on MacOSX/Linux, Git Shell on Windows):

       git clone https://github.com/autodesk-platform-services/aps-aecdatamodel-samples.git
      

    Setting up the Application

    Define the following environment variables:
    
      Mac OSX/Linux (Terminal)
    
        dotnet restore
        export APS_CLIENT_ID=<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
        export APS_CLIENT_SECRET=<<YOUR CLIENT SECRET>>
        export APS_CALLBACK_URL=http://localhost:8080/api/auth/callback
    
      Windows
    
        dotnet restore
        set APS_CLIENT_ID =<<YOUR CLIENT ID FROM DEVELOPER PORTAL>>
        set APS_CLIENT_SECRET =<<YOUR CLIENT SECRET>>
        set APS_CALLBACK_URL=http://localhost:8080/api/auth/callback
    
    Show More

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

    In Microsoft Visual Studio, you can set the variables through Debug > aps-aecdatamodel-samples Properties and add the three Environment variables as follows: APS_CLIENT_ID=<>,APS_CLIENT_SECRET=<>,APS_CALLBACK_URL=http://localhost:8080/api/auth/callback

    Running the Sample

    To run the sample, you need to execute the following command in the terminal:

      dotnet run
    

    Go to http://localhost:8080, and then select Go to sample for Elementgroups Validation Sample Workflow.

    go to elementgroups validation sample

    Afterwards, you’ll need to login with your Autodesk (Forma) account before proceeding with the next steps.

    Workflow Description

    1. List all Hubs

      After login (top-right), click on List Hubs and take note of the hubId (id). See C# code. In case your hub is not in the first response and you receive a cursor value different that null, you can copy and paste this value inside the cursor input and click List Hubs button once more.

      Step 1

    2. List all Projects

      Use the HubId from step 1 to list all projects and take note of the projectId (id). See C# code. In case your project is not in the first response and you receive a cursor value different that null, you can copy and paste this value inside the cursor input and click List Projects button once more.

      Step 2

    3. List all elementgroups in a Project

      This step uses projectId. Take note of the elementGroupId of the desired file (in this image, House.rvt). See C# code. In case your elementgroup is not in the first response and you receive a cursor value different that null, you can copy and paste this value inside the cursor input and click List all elementgroups button once more.

      Step 3

    4. Generate Versions Elements

      Use the elementGroupId from step 3. Click on generate schedule. You may adjust the version field. See C# code.

      Step 4

      Query used:

       query getVersionProperties($elementGroupId: ID!, $versionNumber: Int!){
       	elementGroupByVersionNumber(elementGroupId:$elementGroupId , versionNumber:$versionNumber ){
       		name
       		elements{
       			pagination{
       				pageSize
       				cursor
       			}
       			results{
       				id
       				name
       				properties{
       					results{
       						name
       						value
       						definition{
       							id
       							name
       							units{
       								name
       							}
       						}
       					}
       				}
       			}
       		}
       	}
       }		
      
      Show More

      Query used in case a valid cursor is provided:

       query getVersionProperties($elementGroupId: ID!, $versionNumber: Int!){
       	elementGroupByVersionNumber(elementGroupId:$elementGroupId , versionNumber:$versionNumber , pagination:{cursor:"cursor"}){
       		name
       		elements{
       			pagination{
       				pageSize
       				cursor
       			}
       			results{
       				id
       				name
       				properties{
       					results{
       						name
       						value
       						definition{
       							id
       							name
       							units{
       								name
       							}
       						}
       					}
       				}
       			}
       		}
       	}
       }		
      
      Show More

      The variables are the same in both cases:

       {
       	elementGroupId = elementGroupId,
       	elementsfilter = elementsfilter,
       	referencefilter = referencefilter
       }
      
    Was this section useful?