');}.md-tag.md-tag--api{--md-tag-icon:url('data:image/svg+xml;charset=utf-8,');}.md-tag.md-tag--internal{--md-tag-icon:url('data:image/svg+xml;charset=utf-8,');}.md-tag.md-tag--public{--md-tag-icon:url('data:image/svg+xml;charset=utf-8,');}.md-tag.md-tag--product-weather{--md-tag-icon:url('data:image/svg+xml;charset=utf-8,');} The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
The GET method is used to query information from Lifecycle Twin.
GET method without {id} parameter returns all the resources of the requested type. In the example below, the GET API returns all the Sites (Projects) from the requested Portfolio (Client).
Note
The clientname and authorization HTTP headers are mandatory for all the API requests. Refer Quick Start to generate authorization token.
User can specify the list of fields/ properties they would like to include in the response using select HTTP header to improve the performance and reduce the number of data to be transferred.
Some of the fields are returned in the result, regardless if they specified in the select header or not.
The good practice is do not include the fields you don't need for the certain scenario. Especially the referenced fields and collections. On the backend side it generates JOIN query, and in some cases may significantly impact to the performance.
The select header supports fields of the nesting properties as well.
The syntax of the select header is close to the JSON.
User can specify the filter condition to filter the objects using filter HTTP header. It is the powerful mechanism allow user to restrict the query results and find the required information.
Filters are used not only for to search the objects, but also to fetch the related entities. For example, to get the list of components which belong to a room, the /assets endpoint must be used with the filter by room (location)
The following filter clauses are supported:
Clause
Description
contains
any
ends_with
equals
greater_than
greater_than_or_equals
is_empty
less_than
less_than_or_equals
starts_with
in
Note
Usage of proper clause may significantly affect to the performance. Use equals instead of contains may increase the performance up to 10 times. Correct clause based on your use cases.
It is required to use sorting if you fetch the data by pages. In case if you fetch all the data, it is required to use sorting by the unique field, for example, Id. Otherwise the data on the different pages can be duplicated and not all records will be returned.
It is recommended do not use the large page size especially with the large number of referenced fields in the select header as it may impact to the performance. Normally, the page size should not exceed 1000 records