Get EC3 Configuration - Carbon Calculation

REST API Overview

Reference

Changelog

Carbon Calculation

Download API definition:

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

Get EC3 Configuration

GET https://api.bentley.com/insights/carbon-calculation/ec3/configurations/{configurationId}

Get EC3 upload configuration.

EC3

Embodied Carbon in Construction Calculator (EC3), is a free database of construction EPDs with a matching building impact calculator for use in design and material procurement. EC3 is built by Building Transparency with a core mission to provide open access data and the tools necessary to enable broad and swift action across the building industry addressing embodied carbon's role in climate change. Bentley's iTwin platform integration with EC3 allows you to take Quantity Takeoff Reports created using the iTwin Reporting platform and export them to EC3 for convenient Life Cycle Analysis for both infrastructure projects and buildings. The iTwin platform enables the incorporation of engineering data created by various design tools. A summary of the design data is exported through this integration, allowing you to gain insights into the environmental impacts of your infrastructure project.

For guidance on creating a report, see iTwin Reporting Platform documentation.

For guidance on how to use EC3, terminology and data requirements, see EC3 User Guide.

An account with EC3 is required to use this integration. User accounts are created at EC3. For guidance on EC3, please contact EC3 support.

Bentley is not responsible or liable for third-party resources' content, products, services, or practices and does not make any representations regarding their quality, availability or accuracy. Access and use of EC3 resources are subject to the terms and conditions set forth by EC3.

Authentication

Requires Authorization header with valid Bearer token for scope insights:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must have carbon_calculate permission(s) assigned at the Project level.

Alternatively the user should be an Organization Administrator for the Organization that owns a given Project.

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.

Request

Request parameters

configurationId

template

Yes

Id of EC3 Configuration.

Request headers

Authorization

Yes

OAuth access token with scope insights:read

Yes

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

Response

Response 200 OK

json

{
    "configuration": {
        "id": "7f0a9da2-bb7f-45fa-9b90-d6e132a5fee7",
        "displayName": "Mapping upload",
        "description": "Mapping schema for iModel upload to EC3",
        "labels": [{
            "name": "Columns",
            "reportTable": "EntityName",
            "elementNameColumn": "UserLabel",
            "elementQuantityColumn": "Quantity",
            "materials": [{
                "nameColumn": "Material"
            }]
        }],
        "createdOn": "2022-08-19T07:12:17+00:00",
        "createdByUser": "user@bentley.com",
        "modifiedOn": "2022-08-19T07:12:17+00:00",
        "modifiedBy": "user@bentley.com",
        "_links": {
            "report": {
                "href": "https://api.bentley.com/insights/reporting/reports/f7dc5506-84c4-4505-9995-66d81e6fd907"
            }
        }
    }
}

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 EC3 Configuration was not found.

json

{
    "error": {
        "code": "ConfigurationNotFound",
        "message": "Requested EC3 Configuration is not available.",
        "target": "configurationId"
    }
}

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

EC3 Configuration Response

Container for EC3 Configuration object.

TableSchema

configuration

EC3Configuration

Container for EC3 Configuration.

EC3 Configuration

Container for EC3 Configuration object.

TableSchema

String

Id of EC3 Configuration.

displayName

String

Name of EC3 Configuration.

description

String

Description of EC3 Configuration.

labels

EC3ConfigurationLabel[]

Array of Labels to be created in EC3 Project.

createdOn

String

Creation time of EC3 Configuration.

createdBy

String

User who created EC3 Configuration.

modifiedOn

String

Last modification time of EC3 Configuration.

modifiedBy

String

User who last modified EC3 Configuration.

_links

EC3ConfigurationLinks

Contains the hyperlinks to the related data of the EC3 Configuration.

EC3 Configuration Label

EC3 Configuration Label, equivalent to an Assembly in EC3.

TableSchema

name

String

Name of the Label in EC3 Project.

reportTable

String

Name of the Report table containing Label data.

elementNameColumn

String

Column containing Element names.

elementQuantityColumn

String

Column containing Element quantities.

materials

EC3ConfigurationMaterial[]

Array of columns containing Material names.

EC3 Configuration Material

EC3 Configuration Material.

TableSchema

nameColumn

String

Column containing Material names.

EC3 Configuration links

URLs for getting related data.

TableSchema

report

Link

Link to retrieve report.

Link

Hyperlink container.

TableSchema

href

String

Hyperlink to the specific entity.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

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.

TableSchema

error

Error

Error information.