Forms

Export

Download API definition:

GET https://sampleHostName/forms/storageExport?ids[&includeHeader][&fileType][&folderId]

Requests that anywhere from 1 to 5 forms be exported to a file and saved in cloud-based project storage (accessible through the Storage API). Currently 'pdf' is the only supported file type. The IDs of the forms must be specified in a query string parameter named "ids", separated by commas if there is more than one. A sample request URL that exports 3 forms to a PDF is as follows--

https://api.bentley.com/forms/exportPdfToStorage?fileType=pdf&ids=abab23524535,89458jjlij,32636wtewtwt&folderId=090909877987&includeHeader=true

Note that unlike most GET requests, this is not an idempotent operation; each time it is called, a new file will be generated. The response will not contain the file itself, but links to download it from Storage.

All forms specified in the request must come from the same project, or the request will fail. The client may also specify the ID of a destination folder where the file should be saved; otherwise, it will be saved in the project's root folder. They can also specify whether to include a textual header with form metadata at the top of each page (default) or exclude it.

Authentication

Requires Authorization header with valid Bearer token for scope forms:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.