Creates a CalculatedProperty for a Group. Each CalculatedProperty defines a property or 'column' which is calculated for each element that is returned by the Group's query.

Calculation Types

---

Calculation types that start with BoundingBox use element aligned bounding boxes. They can be used for approximations of geometric element dimensions when there are no available properties that would have exact dimensions. Some errors may occur due to bounding boxes not being a perfect fit for the surrounded element.

List of all available calculation types:

• Length - calculation of a linear element length or a perimeter of a geometric element that does not have a volume. For elements that have a volume use BoundingBox calculations to approximate the length.
• Area - calculation of a geometric element's surface area.
• Volume - calculation of a geometric element's volume.
• BoundingBoxLongestEdgeLength - calculation that gives the longest edge length of an element aligned bounding box.
• BoundingBoxIntermediateEdgeLength - calculation that gives the edge length that is not the longest nor the shortest of an element aligned bounding box.
• BoundingBoxShortestEdgeLength - calculation that gives the shortest edge length of an element aligned bounding box.
• BoundingBoxDiagonalLength - calculation that gives the distance between 2 opposite corners of the element aligned bounding box.
• BoundingBoxLongestFaceDiagonalLength - calculation that gives the longest distance between 2 opposite corners of a face on the element aligned bounding box.
• BoundingBoxIntermediateFaceDiagonalLength - calculation that gives the distance between 2 opposite corners of a face on the element aligned bounding box that is not the longest nor the shortest.
• BoundingBoxShortestFaceDiagonalLength - calculation that gives the shortest distance between 2 opposite corners of a face on the element aligned bounding box.

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_write permission(s) assigned at the Project 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 Project 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.

"Try it out" Limitations

---

When you run an Extraction with the "Try it out" function on a Mapping that was created or modified by using the "Try it out" function, you are limited to 100 extracted rows for each group. Mapping modification is any POST/DELETE/PATCH/PUT request to any endpoint with the tag "Mappings" or if the URL contains {mappingId}.

{
    "propertyName": "CalculatedVolume",
    "type": "Volume"
}

{
    "property": {
        "id": "1ba1f4dd-efc1-4bd1-86f0-a69a4f0d4743",
        "propertyName": "CustomVolume",
        "quantityType": "Volume",
        "type": "Volume",
        "_links": {
            "imodel": {
                "href": "https://api.bentley.com/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a"
            },
            "mapping": {
                "href": "https://api.bentley.com/insights/reporting/datasources/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a/mappings/f1fe5959-35ab-467e-83b8-a679b722d80f"
            },
            "group": {
                "href": "https://api.bentley.com/insights/reporting/datasources/imodels/70a3d6d3-5385-4bc3-87c4-b6bf106e1c0a/mappings/f1fe5959-35ab-467e-83b8-a679b722d80f/groups/1d9ae44a-2204-4bf6-8397-5c590e04ba3e"
            }
        }
    }
}

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

{
    "error": {
        "code": "CalculatedPropertyNotFound",
        "message": "Requested CalculatedProperty is not available.",
        "target": "groupId"
    }
}

{
    "error": {
        "code": "CalculatedPropertyExists",
        "message": "CalculatedProperty with this 'propertyName' already exists."
    }
}

{
    "error": {
        "code": "InvalidInsightsRequest",
        "message": "Error message."
    }
}

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}