Skip to main content

TwinGet

A twin as returned by the service — by getTwin and getTwinVersion, and by the write methods (createOrUpdateTwin, deleteTwin, restoreTwin), which answer with the same shape. Writing a twin and re-rendering it therefore needs no second fetch.

Hierarchy

Index

Properties

Properties

optionalaggregatedSpaces

aggregatedSpaces?: string[]

Spaces that are not part of any facility

aggregatedTwins

aggregatedTwins: string[]

Ids of the Twins nested within this Twin, derived by the service from its twin references.

optionalcomputedPropertySets

computedPropertySets?: PropertySet[]

createdBy

createdBy: string

createdUtc

createdUtc: string

effectivePermissions

effectivePermissions: TwinBoundCapabilityName[]

Everything the calling principal may do with this twin: the capabilities its own scopes confer, unioned with the twin-bound asset ones held customer-wide. Calculated by the service on every read, never stored, and never accepted in a TwinPut body.

The verdict, without its provenance — a fetched twin says no more than a listing row does. Which capabilities are granted here and which come from elsewhere is answered by listTwinPermissions(twinId), where they are administered. Never the twin's access-control list either: this describes the caller, not every principal.

optionalelementQuantities

elementQuantities?: ElementQuantities[]

entities

entities: EntityCollection

Collection of entities that are part of the twin

etag

etag: string

optionalfilePatches

filePatches?: {}

Per-file patch operations applied to model products before merge

Type declaration

fileReferences

fileReferences: TwinFileReference[]

id

id: string

Unique identifier for the twin

optionalisDeleted

isDeleted?: boolean

optionallocation

location?: Location

Full WGS84 location of the Twin (including elevation and trueNorth), derived by the service from the root entity. Read-only; not part of the stored specification.

modifiedBy

modifiedBy: string

modifiedUtc

modifiedUtc: string

name

name: string

Name of the Twin, derived by the service from the root entity. Read-only; not part of the stored specification.

optionalparentTwin

parentTwin?: string

Id of the Twin that references this Twin (its parent), or omitted for a root Twin.

optionalpropertySets

propertySets?: PropertySet[]

relatedContainerIds

relatedContainerIds: string[]

rootEntity

rootEntity: string

Id of the entity that is the root (top) node of the Twin's entity tree. Must reference a site or facility present in the EntityCollection.

optionalsite

site?: string

Legacy. The site of the Twin. Deprecated: use rootEntity, which is authoritative for the root of the Twin's entity tree.

version

version: number
Page Options