Get One Click LCA Configurations - 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/oneclicklca/configurations?iTwinId[&$top][&$continuationToken]

Get One Click LCA upload configurations.

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

iTwinId

Yes

The iTwin Id.

$top

Optional max items to be sent in response.

$continuationToken

Optional token to retrieve next page in paginated response.

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

{
    "configurations": [{
        "id": "7f0a9da2-bb7f-45fa-9b90-d6e132a5fee7",
        "displayName": "Mapping upload",
        "description": "Mapping schema for iModel upload to One Click LCA",
        "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": {
            "iModel": {
                "href": "https://api.bentley.com/imodels/31fe1c27-350f-425f-b6c7-41f55cdb3998"
            },
            "iTwin": {
                "href": "https://api.bentley.com/itwins/07776d1e-2e12-48f9-9ac0-943ad5b923cf"
            }
        }
    }],
    "_links": {
        "next": {
            "href": "https://api.bentley.com/insights/reporting/carbon-calculation/oneclicklca/configurations/?iTwinId=3fa85f64-5717-4562-b3fc-2c963f66afa6&$continuationToken=ddac51e3-3d37-4407-816e-52b9fc80d70a"
        },
        "self": {
            "href": "https://api.bentley.com/insights/reporting/carbon-calculation/oneclicklca/configurations/?iTwinId=3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
    }
}

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 One Click LCA Configuration was not found.

json

{
    "error": {
        "code": "ConfigurationNotFound",
        "message": "Requested One Click LCA Configuration is not available.",
        "target": "iTwinId"
    }
}

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 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
}

PagedResponseLinks

Link

Link to retrieve next page.

self

Link

Link to retrieve current page.

json

{
    "type": "object",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve next page."
        },
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve current page."
        }
    },
    "additionalProperties": false
}

One Click LCA Configuration Collection Response

Container for One Click LCA Configuration objects.

configurations

OneClickLCAConfigurationMinimal[]

Container for One Click LCA Configurations.

_links

PagedResponseLinks

json

{
    "title": "One Click LCA Configuration Collection Response",
    "type": "object",
    "description": "Container for One Click LCA Configuration objects.",
    "properties": {
        "configurations": {
            "type": "array",
            "description": "Container for One Click LCA Configurations.",
            "items": {
                "$ref": "#/components/schemas/OneClickLCAConfigurationMinimal"
            }
        },
        "_links": {
            "$ref": "#/components/schemas/PagedResponseLinks"
        }
    },
    "additionalProperties": false
}

One Click LCA Configuration

Container for One Click LCA Configuration object.

String

displayName

String

Name of One Click LCA Configuration.

description

String

Description of One Click LCA Configuration.

createdOn

String

Creation time of One Click LCA Configuration.

createdBy

String

User who created One Click LCA Configuration.

modifiedOn

String

Last modification time of One Click LCA Configuration.

modifiedBy

String

User who last modified One Click LCA Configuration.

_links

OneClickLCAConfigurationLinks

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

json

{
    "title": "One Click LCA Configuration",
    "type": "object",
    "description": "Container for One Click LCA Configuration object.",
    "properties": {
        "id": {
            "type": "string"
        },
        "displayName": {
            "type": "string",
            "description": "Name of One Click LCA Configuration."
        },
        "description": {
            "type": "string",
            "description": "Description of One Click LCA Configuration."
        },
        "createdOn": {
            "type": "string",
            "description": "Creation time of One Click LCA Configuration."
        },
        "createdBy": {
            "type": "string",
            "description": "User who created One Click LCA Configuration."
        },
        "modifiedOn": {
            "type": "string",
            "description": "Last modification time of One Click LCA Configuration."
        },
        "modifiedBy": {
            "type": "string",
            "description": "User who last modified One Click LCA Configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/OneClickLCAConfigurationLinks",
            "description": "Contains the hyperlinks to the related data of the One Click LCA Configuration."
        }
    },
    "additionalProperties": false
}

One Click LCA Configuration links

URLs for getting related data.

iTwin

Link

Link to retrieve iTwin.

iModel

Link

Link to retrieve iModel.

json

{
    "title": "One Click LCA Configuration links",
    "type": "object",
    "description": "URLs for getting related data.",
    "properties": {
        "iTwin": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve iTwin."
        },
        "iModel": {
            "$ref": "#/components/schemas/Link",
            "description": "Link to retrieve iModel."
        }
    },
    "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?