Lifecycle Twin API¶

The Lifecycle Twin API enables you to create and manage various objects in the Lifecycle Twin.

The Lifecycle Twin API is organized around:

Portfolio, Companies, Sites, Buildings
User, User Groups, Roles
Assets, Documents, Jobs
Model, View, Import, Export
Issues, Tags, Surveys

Concepts & Glossary¶

Term	Description
Portfolio	A customer subscription to Lifecycle Twin. A portfolio brings together your configurations, sites, and building data.
Company	The contact information of an organization. A company is tied to a user or used as a manufacturer for equipment.
Site	A grouping of multiple buildings and outside spaces. Typically a site is physically represented by a fence, vegetation, or street. It can be a contiguous area like a fenced-in airport or a looser aggregation like a government district consisting of multiple individual buildings.
Document	A file directly related to a site, building, or other asset. Documents include drawings, operations manuals, instructions, floor plans, and 3D models.
Building	A structure built for a purpose that has a roof and walls and stands more or less permanently in one place. Typical examples are a house, factory, or shop; but if necessary also a cave, tower, tent, or even a ship or bridge could be called a building.
Zone	Zones represent the spatial aspect of building automation, combining functional and spatial aspects. Examples include comfort zones, fire alarm zones, and lighting zones.
Floor	A horizontal level of a building with a surface that people can use for living, work, storage, or recreation. Depending on context, floors are also called storeys, levels, or decks. Multiple floors can be stacked vertically to form a multi-floor building.
Room	An indoor space enclosed by walls and a roof or ceiling, accessible by a door or similar opening that connects it to a passageway, another room, or the outdoors. Rooms are typically large enough for several persons to enter and move about or conduct the intended activity.
Room Segment	A subdivision of a floor that may later become a room by adding walls. Segments often contain technical preparations for possible rooms (e.g. pillars, grids, window arrangements, piping, or wiring).
Type	A set of common specifications for a component, such as physical dimensions, color, and manufacturer. A type provides the definition of a model and does not represent a physical instance.
Component	A physical instance of a device or piece of equipment. Examples include walls, pipes, pipe segments, and doors.
Category	A property of a component or type that groups them by functional purpose.
System	A collection of machinery and heavy equipment installed for the operation of a service. A system consists of partial systems, aggregates, and components.
Sub System	A part of a system that represents a smaller section of it.
Task	Depending on the use case, a task represents an issue, work order, or activity related to a component, room, or document. Tasks can also record events or emergencies in a building or construction site. Every task follows a workflow with assigned responsible parties.
Inspection	An order to examine a component or space. An inspection uses a digital form that you populate during execution.
Survey	A digital form for collecting information about a component on a mobile device during construction or operations. You create surveys in the web application and execute them on a mobile device.
Reminder	An escalation mechanism for overdue tasks that generates downloadable PDF reports with the status and details of each task.