Get One Click LCA job status - 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 One Click LCA job status

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

Queries One Click LCA job status.

One Click LCA

One Click LCA is a third-party construction LCA and EPD software company. Bentley's iTwin platform integration with One Click LCA allows you to take Quantity Takeoff Reports created using the iTwin Reporting platform and export them to One Click LCA 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.

An account with One Click LCA is required to use this integration. User accounts are created at One Click LCA. For guidance on One Click LCA, please contact One Click LCA support: support@oneclicklca.com.

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 One Click LCA resources are subject to the terms and conditions set forth by One Click LCA.

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

The Job Id.

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": {
        "id": "f7dc5506-84c4-4505-9995-66d81e6fd907",
        "fileToken": "9c3174754c02",
        "status": "Queued",
        "message": null,
        "_links": {
            "report": {
                "href": null
            },
            "oneclicklca": {
                "href": "https://www.oneclicklcaapp.com/app/sec/importMapper/index?applicationId=IFC&importMapperId=IFCFromSimpleBIM&importFilePath=9c3174754c02"
            }
        }
    }
}

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

json

{
    "error": {
        "code": "JobNotFound",
        "message": "Requested 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.

One Click LCA job status response

Container for One Click LCA job object.

job

OneClickLCAJobStatus

Container for One Click LCA job status.

One Click LCA job status status

Indicates state of the One Click LCA job.

Queued

String

Running

String

Succeeded

String

Failed

String

One Click LCA job status

Representation of One Click LCA job status.

String

Globally Unique Identifier of the One Click LCA job.

fileToken

String

Unique Identifier used in One Click LCA webpage to reach uploaded report data.

message

String, null

Representation of error message.

One Click LCA job status status

OneClickLCAJobStatus-status

Indicates state of the One Click LCA job.

_links

OneClickLCAJobStatusLinks

Contains the hyperlinks to the related data of the One Click LCA job.

One Click LCA job status links

URLs for getting related data.

report

Link

Link to retrieve report.

oneclicklca

Link

Link to open One Click LCA webpage.

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.

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.