Get templates - Forms | iTwin Platform

Forms

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://api.bentley.com/forms/templates[?type]

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

Request parameters

type

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

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

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 user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Template List

templates

template-summary[]

json

{
    "type": "object",
    "title": "Template List",
    "properties": {
        "templates": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/template-summary"
            }
        }
    },
    "required": [
        "templates"
    ],
    "additionalProperties": false
}

Template Summary

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.

json

{
    "type": "object",
    "title": "Template Summary",
    "properties": {
        "name": {
            "type": "string",
            "description": "The display name of this form definition template. This is used to identify it when importing in place of an ID."
        },
        "type": {
            "type": "string",
            "description": "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."
        }
    },
    "required": [
        "name",
        "type"
    ],
    "additionalProperties": false
}

Error

Contains error information.

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.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "description": "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?