Get EC3 Job Status - Carbon Calculation

Carbon Calculation

Download API definition:

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

GET https://api.bentley.com/insights/carbon-calculation/ec3/jobs/{jobId}

Queries EC3 upload job status.

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.

Request

Request parameters

jobId

Yes

Id of EC3 upload Job

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

json

{
    "job": {
        "status": "Succeeded",
        "message": null,
        "_links": {
            "ec3Project": {
                "href": "https://buildingtransparency.org/ec3/buildings/0ee7070d20e743b6993fcef689711ddc?view=custom"
            }
        }
    }
}

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": "JobNotFound",
        "message": "Requested EC3 Job is not available.",
        "target": "jobId"
    }
}

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

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

EC3JobStatus status

Current EC3 upload job status.

Queued

String

Running

String

Succeeded

String

Failed

String

json

{
    "type": "string",
    "description": "Current EC3 upload job status.",
    "enum": [
        "Queued",
        "Running",
        "Succeeded",
        "Failed"
    ],
    "title": "EC3JobStatus status"
}

EC3JobStatus

EC3JobStatus status

EC3JobStatus-status

Current EC3 upload job status.

message

String, null

EC3 upload job failure message.

_links

EC3JobStatusLinks

Contains the hyperlinks to the related data of the EC3 Job Status.

json

{
    "type": "object",
    "properties": {
        "status": {
            "type": "string",
            "description": "Current EC3 upload job status.",
            "enum": [
                "Queued",
                "Running",
                "Succeeded",
                "Failed"
            ],
            "title": "EC3JobStatus status",
            "$ref": "#/components/schemas/EC3JobStatus-status"
        },
        "message": {
            "type": "string",
            "nullable": true,
            "description": "EC3 upload job failure message."
        },
        "_links": {
            "$ref": "#/components/schemas/EC3JobStatusLinks",
            "description": "Contains the hyperlinks to the related data of the EC3 Job Status."
        }
    },
    "additionalProperties": false
}

EC3 Job Status links

URLs for getting related data.

ec3Project

Link

Link to created EC3 Project.

json

{
    "title": "EC3 Job Status links",
    "type": "object",
    "description": "URLs for getting related data.",
    "properties": {
        "ec3Project": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to created EC3 Project."
        }
    },
    "additionalProperties": false
}

EC3JobStatusResponse

job

EC3JobStatus

json

{
    "type": "object",
    "properties": {
        "job": {
            "$ref": "#/components/schemas/EC3JobStatus"
        }
    },
    "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

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

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?