https://github.com/autodesk-platform-services/aps-dx-explorer

APS Data Exchange Explorer:The sample is using this GraphiQL project that makes it easy to take advantage of GraphQL for data Exchange
https://github.com/autodesk-platform-services/aps-dx-explorer

data-exchange sample

Last synced: about 1 year ago
JSON representation

APS Data Exchange Explorer:The sample is using this GraphiQL project that makes it easy to take advantage of GraphQL for data Exchange

• Host: GitHub
• URL: https://github.com/autodesk-platform-services/aps-dx-explorer
• Owner: autodesk-platform-services
• License: mit
• Created: 2022-12-14T13:17:30.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-18T18:42:25.000Z (about 1 year ago)
• Last Synced: 2025-04-22T17:14:45.654Z (about 1 year ago)
• Topics: data-exchange, sample
• Language: HTML
• Homepage: https://aps-dx-explorer.autodesk.io
• Size: 62.3 MB
• Stars: 3
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Aps Data Exchange Explorer

The sample is using this [GraphiQL project](https://github.com/graphql/graphiql) that makes it really easy to discover the Data Exchange API through GraphQL.

It also integrates with the Viewer in order contextualize the query results.

# Thumbnail

![Thumbnail](./thumbnail.png)

## Setting up the app

- clone this repository or download

- restore the packages

- replace the variable values at appsettings.Development.json with your own

```json

{

  "APS_CLIENT_ID": "YOUR CLIENT ID",

  "APS_CLIENT_SECRET": "YOUR CLIENT SECRET",

  "APS_CALLBACK_URL": "http://localhost:8080/api/auth/callback"

}

```

**Make sure your APS app also uses the same callback url!**

## Running the app

As instructed in the console, you'll need to open a web browser and navigate to http://localhost:8080 in order to log into your Autodesk account

## Output

Once you logged in with your Autodesk account in the browser, this should appear:

![GraphiQL](./readme/GraphiQL.png)

This sample comes by default with the step-by-step tutorial queries in multiple tabs. You can run the queries available in these tabs and add your own.

![Queries](./readme/Queries.png)

You can also check the documentation

![Docs](./readme/Docs.png)

Viewer is controlled by the toggle switch in the header. It will load the model based on the item or version Id specified by the input.

![workflow](./readme/workflow.gif)

---

## Known issues

1. The Viewer might have some trouble on resizing on Safari. Please use it with Chrome or Edge.

## Tips & Tricks

![Tips](./readme/Tips.png)

1. **You need to be logged in order to use any feature in this sample.**

2. **Exchange URN field accepts URN of an exchange. From there, it'll load the view in the Viewer based on the exchange's contract**

3. **Make sure the Exchange Id and URN are related to the same exchange.**

4. **The filter extension looks for `externalElementId` in the last query response, then look for externalIds in the loaded model to isolate them.**

## Troubleshooting

1. **Cannot load viewer**: Make sure you're logged in and using a valid exchange Id.

2. **Filter Extension doesn't highlight elements**: Make sure you're using the exchange urn compatible with the exchange id used in the queries.

## Written and updated by

- João Martins [@JooPaulodeOrne2](http://twitter.com/JooPaulodeOrne2), [Developer Advocate and Support](http://aps.autodesk.com)

- Suraj Kumar [@suraj0223](https://www.linkedin.com/in/suraj0223/), [Software Developer]

- Denis Grigor  [Developer Advocate and Support](http://aps.autodesk.com)