Get iTwin list groups - Forms

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/iTwins/{iTwinId}/listGroups[?search]

Retrieves the list of list groups in the chosen iTwin. List groups govern the options that appear for the user to select in cascading list controls. These are a series of dropdown list controls in a form definition where the options available in each control beyond the first vary depending on which options were selected in the preceding controls.

By default, this endpoint gets all list groups in the iTwin. If search is specified, only list groups whose names include the given search string (case-insensitive) will be returned.

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 ID of the iTwin to get list groups for.

If specified, only list groups whose display names contain the given string will be returned in the results.

Request headers

Prefer

Indicates whether to get just basic information about the list groups, like name and created date (return=minimal) or to get the options tree of each list group (return=representation).

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

{
    "listGroups": [{
            "id": "876f3da1-ae96-4ab5-84b4-9fa059b6e2d4",
            "displayName": "Sample AB",
            "createdDateTime": "2024-08-21T15:44:09Z",
            "lists": [
                "Letter",
                "Number"
            ]
        },
        {
            "id": "c2b67110-f1f1-4c72-9d89-18a5d666dcd8",
            "displayName": "Football Teams",
            "createdDateTime": "2024-07-25T21:18:09Z",
            "lists": [
                "Conference",
                "Division",
                "Team"
            ]
        }
    ]
}

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 iTwin 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": "iTwinNotFound",
        "message": "Requested iTwin is not available.",
        "target": "iTwinId"
    }
}

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

List Groups Minimal Response

listGroups

list-group-summary[]

json

{
    "type": "object",
    "title": "List Groups Minimal Response",
    "properties": {
        "listGroups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/list-group-summary"
            }
        }
    },
    "required": [
        "listGroups"
    ],
    "additionalProperties": false
}

List Groups Representation Response

listGroups

list-group-details[]

json

{
    "type": "object",
    "title": "List Groups Representation Response",
    "properties": {
        "listGroups": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/list-group-details"
            }
        }
    },
    "required": [
        "listGroups"
    ],
    "additionalProperties": false
}

List Group Summary

String

The unique ID of this list group.

displayName

String

The name of this list group, as entered by its creator.

createdDateTime

Date-time, null

The date and time (UTC) when this list group's file was uploaded.

lists

String[], null

The names of the lists defined by this list group, from outermost (first) to innermost (last).

json

{
    "type": "object",
    "title": "List Group Summary",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique ID of this list group."
        },
        "displayName": {
            "type": "string",
            "description": "The name of this list group, as entered by its creator."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time (UTC) when this list group's file was uploaded.",
            "nullable": true
        },
        "lists": {
            "type": "array",
            "description": "The names of the lists defined by this list group, from outermost (first) to innermost (last).",
            "items": {
                "type": "string"
            },
            "nullable": true
        }
    },
    "required": [
        "id",
        "displayName"
    ],
    "additionalProperties": false
}

List Group Summary

String

The unique ID of this list group.

displayName

String

The name of this list group, as entered by its creator.

createdDateTime

Date-time, null

The date and time (UTC) when this list group's file was uploaded.

lists

String[], null

The names of the lists defined by this list group, from outermost (first) to innermost (last).

optionsTree

dynamic-object

A recursive data structure defining the options available in these lists. Its properties can have any name. For each property in the outermost object, its key should be used as the name of an option in the first list, and its value is an object whose keys correspond to the options that become available in the second list when that particular first-list option is chosen, and so forth. This pattern continues down to the last list, whose options will be represented by properties with empty object values.

json

{
    "type": "object",
    "title": "List Group Summary",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique ID of this list group."
        },
        "displayName": {
            "type": "string",
            "description": "The name of this list group, as entered by its creator."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time (UTC) when this list group's file was uploaded.",
            "nullable": true
        },
        "lists": {
            "type": "array",
            "description": "The names of the lists defined by this list group, from outermost (first) to innermost (last).",
            "items": {
                "type": "string"
            },
            "nullable": true
        },
        "optionsTree": {
            "$ref": "#/components/schemas/dynamic-object",
            "description": "A recursive data structure defining the options available in these lists. Its properties can have any name. For each property in the outermost object, its key should be used as the name of an option in the first list, and its value is an object whose keys correspond to the options that become available in the second list when that particular first-list option is chosen, and so forth. This pattern continues down to the last list, whose options will be represented by properties with empty object values."
        }
    },
    "required": [
        "id",
        "displayName"
    ],
    "additionalProperties": false
}

Dynamic Object

An object whose properties can vary depending on user customization within the project.

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?