Export
Gets the specified form exported to the specified file format. Currently, the default--and only supported format--is PDF. The form with the specified ID will be laid out in the PDF according to its associated form definition.
The generated PDF will have a header at the top of each page with metadata about the form (such as its name and creation date) unless the 'includeHeader' query parameter is set to false.
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.
Request parameters
ID of form to download as a file.
The type of file to download the form as. Currently the default, and only supported value, is 'PDF'.
If downloading as PDF, sets whether to include form metadata on the top of each page. Default is true.
Request headers
OAuth access token with scope forms:read
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
Indicates that the file was successfully generated in the requested format. The response body consists of the generated file.
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified form data instance does not exist or is inaccessible.
{ "error": { "code": "FormDataNotFound", "message": "Requested form data is not available.", "target": "id" } }
Response 422 Unprocessable Entity
This response indicates that there is a problem with the format of the URL. Most likely problem: The 'fileType' parameter is set to an unsupported file type, or the 'includeHeader' parameter is set to a non-boolean value.
{ "error": { "code": "InvalidDownloadRequest", "message": "Cannot retrieve downloaded file.", "details": [{ "code": "InvalidValue", "message": "If set, the 'includeHeader' parameter's value must be 'true' or 'false'.", "target": "includeHeader" }] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
The number of requests exceeds the rate-limit for the client subscription.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
Short string indicating the general category of error that occurred, such as '{Resource}NotFound'.
Longer string explaining to developers why the error occurred.
If relevant, this is the name of the property, URL template parameter, or query parameter that caused the error.
Detailed error-response
Indicates that a request failed and provides a list of details, explaining which properties or parameters in the request were incorrect. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
Short string indicating the general category of error that occurred, such as 'Invalid{resource}Request'.
Longer string explaining to developers why the error occurred.
If relevant, this is the name of the property, URL template parameter, or query parameter that caused the error.
Error
Contains error information and an optional array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Details
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.