Create One Click LCA job - 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.

Create One Click LCA job

POST https://qa-api.bentley.com/insights/carbon-calculation/oneclicklca/jobs

Uploads report data to One Click LCA.

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 headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

OneClickLCAJobExtractionCreate (Extraction)

configurationId

String

Yes

Id of Configuration to upload into One Click LCA.

extractionId

String

Yes

Id of the Extraction to upload into One Click LCA

token

String

Yes

One Click LCA token. Acquiring a token is possible using One Click LCA APIs. Contact api@oneclicklca.com for support.

Example

json

{
    "extractionId": "ea5f2265-1eef-4340-a0f7-d0bdc5cf4533",
    "configurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "token": "string"
}

OneClickLCAJobReportCreate (Report)

reportId

String

Yes

Report identifier used to upload report data to One Click LCA.

token

String

Yes

One Click LCA token. Acquiring a token is possible using One Click LCA APIs. Contact api@oneclicklca.com for support.

Example

json

{
    "reportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "token": "string"
}

Response

Response 200 OK

json

{
    "job": {
        "id": "f7dc5506-84c4-4505-9995-66d81e6fd907",
        "_links": {
            "report": {
                "href": null
            },
            "job": {
                "href": "https://api.bentley.com/insights/carbon-calculation/oneclicklca/jobs/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 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

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

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

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

One Click LCA Job (create)

Properties of One Click LCA job to be created.

reportId

String

Report identifier used to upload report data to One Click LCA.

token

String

One Click LCA token. Acquiring a token is possible using One Click LCA APIs. Contact api@oneclicklca.com for support.

One Click LCA Job (create)

Properties of One Click LCA job to be created.

configurationId

String

Id of Configuration to upload into One Click LCA.

extractionId

String

Id of the Extraction to upload into One Click LCA

token

String

One Click LCA token. Acquiring a token is possible using One Click LCA APIs. Contact api@oneclicklca.com for support.

One Click LCA job response

Container for One Click LCA job object.

job

OneClickLCAJobCreateResponse

Container for One Click LCA job.

One Click LCA job

Representation of One Click LCA job.

String

One Click LCA job id.

_links

OneClickLCAJobLinks

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

One Click LCA job links

URLs for getting related data.

report

Link

Link to retrieve report.

job

Link

Link to retrieve job.

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.