Retrieves a group.

Group Query

---

The query parameter of a Group must be a valid ECSQL query.

If a valid ECSQL query is given and the selected class is bis.Element, or if it is a descendant of the class bis.Element, the only required column is ECInstanceId. However, it is recommended to always select at least ECInstanceId and ECClassId columns.

• SELECT * FROM bis.Element is a valid query
• Assuming that class Building.Beam is a descendant of the class bis.Element, the query SELECT * FROM Building.Beam is a valid query
• SELECT ECInstanceId, ECClassId FROM bis.Element is a valid query
• Assuming that class Building.Beam is a descendant of the class bis.Element, the query SELECT ECInstanceId, ECClassId FROM Building.Beam is valid
• SELECT ECClassId FROM bis.Element is not a valid query because ECInstanceId column is missing
• Assuming that class Building.Beam is a descendant of the class bis.Element, the query SELECT ECClassId FROM Building.Beam is not valid because ECInstanceId column is missing
• Assuming that Building.BeamAspect is an aspect, the query SELECT A.ECInstanceId ECInstanceId FROM bis.Element E JOIN Building.BeamAspect A ON A.Element.id = E.ECInstanceId is not valid because the selected ECInstanceId is of the aspect, not the element
• Assuming that Building.BeamAspect is an aspect, the query SELECT Element.id FROM Building.BeamAspect is not valid because the selected column's name is not ECInstanceId
• Assuming that Building.BeamAspect is an aspect, the query SELECT Element.id ECInstanceId FROM Building.BeamAspect is valid

In all other cases the provided ECSQL query is required to select ECInstanceId and ECClassId. If ECClassId is omitted, the service assumes that query selects elements from the bis.Element class or its descendants. In some cases the results might be unexpected, e.g., you assume that you are querying bis.ElementAspect but you only select ECInstanceId so the service only selects the elements that have a matching ECInstanceId. Because of this it is always recommended to select both ECInstanceId and ECClassId.

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.

Authorization

---

User must have insights_view permission(s) assigned at the iTwin level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given iTwin or iModel.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

---

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

{
    "group": {
        "id": "08f252c4-ee78-4e2b-9280-f7365400b932",
        "displayName": "PhysicalElements",
        "description": "A group of physical elements",
        "query": "SELECT ECInstanceId, ECClassId FROM BisCore.PhysicalElement",
        "metadata": [{
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value2"
            }
        ],
        "createdDateTime": "2021-09-03T10:48:45+00:00",
        "modifiedDateTime": "2022-01-10T13:44:56+00:00",
        "_links": {
            "iTwin": {
                "href": "https://api.bentley.com/itwins/3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
        }
    }
}

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

{
    "error": {
        "code": "GroupNotFound",
        "message": "Requested Group is not available.",
        "target": "groupId"
    }
}

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