Response 200 OK

OK

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

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 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.)

{
    "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 'iTwinId' parameter is missing or not a valid GUID.

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

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."
    }
}

Response headers

Whether this form definition is available for use. Possible values: Draft or Maintenance means users can edit its layout, but not fill out issues from it. Approved means users can fill it out, but not edit its layout. Archived allows neither.

Whether this form definition is available for use. Possible values: Draft or Maintenance means users can edit its layout, but not fill out issues from it. Approved means users can fill it out, but not edit its layout. Archived allows neither.

Whether this form definition can be used in multiple iTwins. A value of null means it cannot. 'ReadOnly' and 'ReadWrite' mean it can. 'ReadOnly' means its layout can only be edited from its original iTwin, and 'ReadWrite' means its layout can be edited from any iTwin in the organization.

String describing whether the form definition has problems that could prevent it from displaying (Warning) or functioning (Error or Critical) correctly. Possible values: 'None', 'Warning', 'Error', 'Critical', 'Unknown'.

If this form definition is in an editable state and you have permission to edit form definitions, this link sends you to the Form Manager webapp where you can edit its layout. Otherwise, this link will not appear.

Contains error information and an array of more specific errors.

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.

Contains error information.

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.