Forms
Download API definition:
GET https://dev-api.bentley.com/forms/templates[?type][&discipline]

Gets a list of form definition templates. These are publicly available form definitions created by Bentley that you can import into any iTwin in your organization through the Import template endpoint. These templates are not editable in the public repository, but importing a template will create a local copy if it in your iTwin, private to your organization, that you can customize to your needs and use for filling out forms.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

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

Request parameters

Name
Required?
Description
type
No

If set, gets only templates of the chosen type. A template's type determines what its form definition type will be once imported.

discipline
No

If set, gets only templates of the chosen discipline. A template's discipline determines what its form definition discipline will be once imported.

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v2+json is recommended.

Response 200 OK

A list of the available templates, filtered by form type if a type was specified.

json
{
    "templates": [{
            "name": "Area Work Package",
            "type": "Work Package"
        },
        {
            "name": "Daily Log",
            "type": "Daily Log"
        },
        {
            "name": "Safety Checklist",
            "type": "Other"
        }
    ]
}

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.

json
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json
{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

Template List

Name
Type
Description
templates

Template Summary

Name
Type
Description
name
String

The display name of this form definition template. This is used to identify it when importing in place of an ID.

type
String

The form type of this template. Determines what type of form data instances will be created if it's imported and used as a form definition.

discipline
String

Describes the discipline to associate to this template.

Error

Contains error information.

Name
Type
Description
code
String

One of a server-defined set of error codes.

message
String

A human-readable representation of the error.

target
String, null

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.

Name
Type
Description
error

Error information.

Was this page helpful?