Skip to content

Latest commit

 

History

History
 
 

PostmanCollection

README.md

Create App, Define Activity, Call the WorkItem

Description

Postman collection to create App, define activity, and call the WorkItem.

Setup

Before start with Design Automaiton workflow, I strongly recommend you to read throught all the details at Design Automation for Revit Documenation, and check the following steps if you already have basic understanding.

  1. Download or update Postman from here.

  2. Create a Forge App. If you have already created a Forge App then you can skip this and proceed to the next step.

  3. From your local clone of the repository, import our Postman collections Design Automation V3 Samples Collection into the Postman application. You can find more details about collections here

  4. From your local clone of the repository, import our Postman environment Design Automation V3 Samples Environment into the Postman application. You can find more details about managing and editing environment variables here.

  5. Select the environment and enter your Forge App's Client ID and Client Secret. This is used for authentication. In the environment variables give your app an easy to manage unique nickname.

  6. Compile and package the sample applications as noted here. You will need this to upload the app to Design Automation. Alternatively you may also download the packages from CreateWindowApp.zip.

  7. Create a nickname for your Forge App.

  8. Publish your Design Automation appbundle.

  9. Publish your Design Automation activity.

  10. Prepare your input url of parameter and output url using the Postman APIs under folder Data. You need to upload a window family template as input Url, you can use the Window Family Template if you don't have one. And the JSON input of window parameters at Window Parameters

  11. Post your Design Automation workitem.

Usage

These Postman samples will allow you to easily issue REST API calls without using cumbersome cURL commands.

Note that you will have to carefully read through the requests - DELETE-ing an app or activity will delete all its associated versions!

Note that for all workitems kindly provide signed URL for the expected output file. Else the workitem post will result with failedUpload.

REST API documentation on Design Automation V3 can be found here.

Reference

A step by step instructional video can be found here, the main steps should be similar.

Written by

Design Automation Postman collection and environment, Updated by Zhong Wu, Forge Partner Development