Get iTwin form definitions - Issues

REST API Overview

Reference

Issues

Download API definition:

GET https://qa-api.bentley.com/issues/formDefinitions?iTwinId[&type]

Retrieves a list of Approved form definitions for the project with the given ID. This only returns the definition's name, type, and ID. The full definitions will be returned in the 'Get form definition by ID' endpoint.

Note that in order to create an issue, it must be associated with the ID of one of these form definitions (through the 'formId' property in the 'Create issue' request body). This API cannot be used to create or edit form definitions. They can only be created/edited/imported by project administrators through the Bentley Form Manager webapp, which is accessible at https://connect-formmanager.bentley.com/designer/#/your-itwin-id (replace your-itwin-id with your actual project or iTwin ID).

Note that the 'iTwinId' query string parameter is required. It must be a valid iTwin or project GUID to get form definitions from. Older clients can continue to use 'projectId' as an alias for 'iTwinId'.

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

iTwinId

Yes

The GUID of the iTwin or project to get form definitions for. (Note: projectId is also accepted as an alias for this parameter.)

type

The issue type to get form definitions for. Omit to get all form definitions, regardless of type.

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

json

{
    "formDefinitions": [{
            "id": "e5Ue5Ue5U02hNz19awLcRpwxKq9kmcZEqw123456789",
            "displayName": "Clash Review",
            "type": "Clash"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRnQIKZ9n-5VNql123456789",
            "displayName": "Civil",
            "type": "Civil Design"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRvZ97C-0gldCg7123456789",
            "displayName": "PWDM RFI",
            "type": "RFI"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRk1_FOY1fxhOoL123456789",
            "displayName": "Punch List",
            "type": "Closeout"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRmFoakRibdVAsq123456789",
            "displayName": "Punchlist",
            "type": "Punchlist"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRtnnI7NMyWVCqt123456789",
            "displayName": "Issue",
            "type": "Field Data"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRs_krW5iPFdMhX123456789",
            "displayName": "Design Issue",
            "type": "Issue"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRtfgSsUdmQxLkB123456789",
            "displayName": "Design Task",
            "type": "Task"
        },
        {
            "id": "e5Ue5Ue5U02hNz19awLcRqs7_5zpRFVJpy123456789",
            "displayName": "Design Review",
            "type": "Communication"
        }
    ]
}

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 404 Not Found

This response indicates that the project with the specified ID does not exist or is inaccessible to the user due to insufficient permissions. (For security reasons, the response will not differ between inaccessible and missing projects.)

json

{
    "error": {
        "code": "ProjectNotFound",
        "message": "Requested project is not available.",
        "target": "projectId"
    }
}

Response 422 Unprocessable Entity

This response indicates that there is a problem with the format of the URL. Most likely problem: The 'projectId' parameter is missing or not a valid GUID.

json

{
    "error": {
        "code": "InvalidFormDefRequest",
        "message": "Cannot retrieve form definitions.",
        "details": [{
            "code": "MissingRequiredParameter",
            "message": "The 'projectId' query parameter must be provided.",
            "target": "projectId"
        }]
    }
}

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

Form Definition List

formDefinitions

form-definition-summary[]

Form Definition Summary

String

Unique ID for this form definition.

displayName

String, null

The name of this form definition as it is displayed to users in the Form Manager UI and Issues webapp UI.

type

String

The issue type that can be created from this form definition.

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

Detailed 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

DetailedError

Error Detailed information.