Create 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 itwin-platform.

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.

{
    "reportId": "f7dc5506-84c4-4505-9995-66d81e6fd907",
    "displayName": "Mapping upload",
    "description": "Mapping schema for iModel upload to EC3",
    "labels": [{
        "name": "Columns",
        "reportTable": "EntityName",
        "elementNameColumn": "UserLabel",
        "elementQuantityColumn": "Quantity",
        "materials": [{
            "nameColumn": "Material"
        }]
    }]
}

{
    "iTwinId": "929fd670-30db-4e36-9e85-b12efeb84d48",
    "iModelId": "f00fcda5-5fc7-4566-80e3-18f91c57a22d",
    "displayName": "Mapping upload",
    "description": "Mapping schema for iModel upload to EC3",
    "labels": [{
        "name": "Columns",
        "groupName": "group_name",
        "mappingId": "ea5f2265-1eef-4340-a0f7-d0bdc5cf4533",
        "elementNameColumn": "UserLabel",
        "elementQuantityColumn": "Quantity",
        "materials": [{
            "nameColumn": "Material"
        }]
    }]
}

{
    "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",
        "createdBy": "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"
            }
        }
    }
}

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

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

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