Get Groups - Grouping and Mapping

Grouping and Mapping

Download API definition:

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

GET https://dev-api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/{mappingId}/groups[?$top][&$continuationToken]

Gets all groups of a mapping.

Notes

The Prefer header can be used to specify how much result metadata is desired by the client. The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports "return=representation" and "return=minimal" preferences.

The "return=representation" preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request. The "return=minimal" preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer header is not specified.

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.

If different queries are needed for a single output table, then create multiple groups with those different queries but with the same name for each group. That will cause results of all these queries to be concatenated into a single output table. The output table will have column list equal to a union of all properties of groups with the same name. The result rows will be concatenated one after another. If groups are overlapping and multiple groups select the same element the result will contain duplicates.

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 imodels_read permission(s) assigned at the iTwin level. iModel specific permissions may also be applied at the iModel level if iModel level permissions are enabled.

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.

Request

Request parameters

mappingId

Yes

The mapping Id.

$top

Optional max items to be sent in response.

$continuationToken

Optional token to retrieve next page in paginated response.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Prefer

Indicates a level of details in the response. This operation supports 'return=representation' and 'return=minimal' preferences.

Response

Response 200 OK

json

{
    "groups": [{
        "id": "08f252c4-ee78-4e2b-9280-f7365400b932",
        "groupName": "PhysicalElements",
        "description": "A group of physical elements",
        "query": "SELECT ECInstanceId, ECClassId FROM BisCore.PhysicalElement",
        "_links": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a"
            },
            "mapping": {
                "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/groups?$top=100&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/grouping-and-mapping/datasources/imodel-mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/groups?$top=100"
        }
    }
}

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

Specified Mapping was not found.

json

{
    "error": {
        "code": "MappingNotFound",
        "message": "Requested Mapping is not available.",
        "target": "mappingId"
    }
}

Response 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidGroupingAndMappingRequest",
        "message": "Cannot retrieve Groups.",
        "details": [{
            "code": "InvalidParameter",
            "message": "Provided '$top' query parameter value is not valid. A single value must be provided.",
            "target": "$top"
        }]
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

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

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Group Minimal

A group is a collection of design elements from an iModel represented by an ECSQL query. When used for reporting a group represents a single output data table in a report.

String

The group Id.

groupName

String

Name of the group (OData v4 SimpleIdentifier).

description

String

Description of the group. The default value is empty string.

query

String

An ECSQL query that represents a collection of iModel elements.

_links

GroupLinks

Contains contextual hyperlinks to related data.

json

{
    "title": "Group Minimal",
    "type": "object",
    "description": "A group is a collection of design elements from an iModel represented by an ECSQL query. When used for reporting a group represents a single output data table in a report.",
    "properties": {
        "id": {
            "type": "string",
            "description": "The group Id."
        },
        "groupName": {
            "type": "string",
            "description": "Name of the group (OData v4 SimpleIdentifier)."
        },
        "description": {
            "type": "string",
            "description": "Description of the group. The default value is empty string."
        },
        "query": {
            "type": "string",
            "description": "An ECSQL query that represents a collection of iModel elements."
        },
        "_links": {
            "$ref": "#/components/schemas/GroupLinks",
            "description": "Contains contextual hyperlinks to related data."
        }
    },
    "required": [
        "id",
        "groupName",
        "description",
        "query",
        "_links"
    ],
    "additionalProperties": false
}

Groups (prefer return=minimal)

List of groups.

groups

GroupMinimal[]

List of groups.

_links

PagedResponseLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Groups (prefer return=minimal)",
    "type": "object",
    "description": "List of groups.",
    "properties": {
        "groups": {
            "type": "array",
            "description": "List of groups.",
            "items": {
                "$ref": "#/components/schemas/GroupMinimal"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "required": [
        "groups",
        "_links"
    ],
    "additionalProperties": false
}

Metadata

Group

A group is a collection of design elements from an iModel represented by an ECSQL query. When used for reporting a group represents a single output data table in a report.

String

The group Id.

groupName

String

Name of the group (OData v4 SimpleIdentifier).

description

String

Description of the group. The default value is empty string.

query

String

An ECSQL query that represents a collection of iModel elements.

metadata

Metadata

An array of unique key value pairs.

_links

GroupLinks

Contains contextual hyperlinks to related data.

json

{
    "title": "Group",
    "type": "object",
    "description": "A group is a collection of design elements from an iModel represented by an ECSQL query. When used for reporting a group represents a single output data table in a report.",
    "properties": {
        "id": {
            "type": "string",
            "description": "The group Id."
        },
        "groupName": {
            "type": "string",
            "description": "Name of the group (OData v4 SimpleIdentifier)."
        },
        "description": {
            "type": "string",
            "description": "Description of the group. The default value is empty string."
        },
        "query": {
            "type": "string",
            "description": "An ECSQL query that represents a collection of iModel elements."
        },
        "metadata": {
            "$ref": "#/components/schemas/Metadata",
            "description": "An array of unique key value pairs."
        },
        "_links": {
            "$ref": "#/components/schemas/GroupLinks",
            "description": "Contains contextual hyperlinks to related data."
        }
    },
    "required": [
        "id",
        "groupName",
        "description",
        "query",
        "_links"
    ],
    "additionalProperties": false
}

Group Links

Hyperlinks to related data which complements this entity.

iModel

Link

Link to retrieve the related iModel.

mapping

Link

Link to retrieve the related mapping.

json

{
    "title": "Group Links",
    "type": "object",
    "description": "Hyperlinks to related data which complements this entity.",
    "properties": {
        "iModel": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve the related iModel."
        },
        "mapping": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve the related mapping."
        }
    },
    "required": [
        "iModel",
        "mapping"
    ],
    "additionalProperties": false
}

Groups (prefer return=representation)

List of groups.

groups

Group[]

List of groups.

_links

PagedResponseLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Groups (prefer return=representation)",
    "type": "object",
    "description": "List of groups.",
    "properties": {
        "groups": {
            "type": "array",
            "description": "List of groups.",
            "items": {
                "$ref": "#/components/schemas/Group"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "required": [
        "groups",
        "_links"
    ],
    "additionalProperties": false
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "title": "Link",
    "type": "object",
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "required": [
        "href"
    ],
    "additionalProperties": false
}

Paged Response Links

URLs for redoing the current request and/or getting the next page of results if applicable.

Link, null

URL to get the next page of results.

self

Link

URL to repeat the current request.

json

{
    "title": "Paged Response Links",
    "type": "object",
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable.",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to get the next page of results.",
            "nullable": true
        },
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to repeat the current request."
        }
    },
    "required": [
        "self"
    ],
    "additionalProperties": false
}

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.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

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.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?