Construction Kit

Der Construction Kit definiert das Schema und die Struktur Ihres Datenmodells. Anders als das Runtime-Modell, das die tatsächlichen Dateninstanzen speichert, enthält der Construction Kit die Metadaten, die festlegen, welche Arten von Entitäten existieren können, sowie deren Attribute, Beziehungen und Einschränkungen.

Die GraphQL-API bietet Lesezugriff auf den Construction Kit und ermöglicht es Ihnen, die Modellstruktur zur Laufzeit zu inspizieren.

Überblick

Der Construction Kit besteht aus den folgenden Komponenten:

Komponente	Beschreibung	Dokumentation
Models	Container, die verwandte Typen, Attribute und Enums gruppieren	Models
Types	Entitätsdefinitionen mit Attributen und Assoziationen	Types
Attributes	Wiederverwendbare Attributdefinitionen mit Wertetypen	Attributes
Enums	Enumerationsdefinitionen mit zulässigen Werten	Enums
Records	Zusammengesetzte Wertetypen (eingebettete Strukturen)	Records
Association Roles	Beziehungsdefinitionen zwischen Typen	Association Roles

Identifier-Typen

CkModelId

Identifiziert ein Modell im Construction Kit.

Feld	Typ	Beschreibung
name	String	Der Modellname (z. B. Industry.Energy)
version	Int	Die Versionsnummer des Modells
fullName	String	Kombinierter Name und Version (z. B. Industry.Energy-1)
semanticVersionedFullName	String	Vollständiger Name mit semantischer Version

CkTypeId

Identifiziert einen Typ im Construction Kit.

Feld	Typ	Beschreibung
fullName	String	Vollständiger Typ-Identifier mit Versionen (z. B. Industry.Energy-1.0.0/EnergyMeter-1)
semanticVersionedFullName	String	Semantischer Name ohne Versionen (z. B. Industry.Energy/EnergyMeter)

CkAttributeId

Identifiziert ein Attribut im Construction Kit.

Feld	Typ	Beschreibung
fullName	String	Vollständiger Attribut-Identifier mit Versionen (z. B. Industry.Energy-1.0.0/Voltage-1)
semanticVersionedFullName	String	Semantischer Name ohne Versionen (z. B. Industry.Energy/Voltage)

CkEnumId

Identifiziert ein Enum im Construction Kit.

Feld	Typ	Beschreibung
fullName	String	Vollständiger Enum-Identifier mit Versionen (z. B. Industry.Energy-1.0.0/EnergyMeterState-1)
semanticVersionedFullName	String	Semantischer Name ohne Versionen (z. B. Industry.Energy/EnergyMeterState)

CkRecordId

Identifiziert einen Record-Typ im Construction Kit.

Feld	Typ	Beschreibung
fullName	String	Vollständiger Record-Identifier mit Versionen (z. B. Basic-1.0.0/Contact-1)
semanticVersionedFullName	String	Semantischer Name ohne Versionen (z. B. Basic/Contact)

CkAssociationRoleId

Identifiziert eine Association Role im Construction Kit.

Feld	Typ	Beschreibung
fullName	String	Vollständiger Role-Identifier mit Versionen (z. B. System-1.0.3/Parent-1)
semanticVersionedFullName	String	Semantischer Name ohne Versionen (z. B. System/Parent)

Allgemeine Query-Parameter

Alle Construction-Kit-Abfragen unterstützen die folgenden Parameter:

Parameter	Typ	Beschreibung
after	String	Cursor für die Paginierung (Elemente nach diesem Cursor abrufen)
first	Int	Maximale Anzahl der zurückzugebenden Elemente
searchFilter	SearchFilter	Textsuchfilter
fieldFilter	[FieldFilter]	Attributbasierte Filter
sortOrder	[Sort]	Sortierkonfiguration
ckId	String	Nach einem bestimmten CK-Identifier filtern
ckModelIds	[String]	Nach Modell(en) filtern

Siehe Retrieve für eine ausführliche Dokumentation der Query-Parameter.

Attribut-Wertetypen

Das Feld attributeValueType gibt den Datentyp eines Attributs an:

Wert	Beschreibung
STRING	Textwert
INT32	32-Bit-Ganzzahl
INT64	64-Bit-Ganzzahl
FLOAT	Gleitkommazahl
DOUBLE	Gleitkommazahl mit doppelter Genauigkeit
BOOLEAN	Wahr/Falsch-Wert
DATE_TIME	Datums- und Zeitwert
BINARY	Binärdaten (Base64-kodiert)
OBJECT_ID	MongoDB-ObjectId-Referenz
ENUM	Enumerationswert (siehe verknüpftes ckEnum)
RECORD	Eingebetteter Record (siehe verknüpftes ckRecord)
GEO_JSON	Geodaten im GeoJSON-Format

Model State

Modelle können die folgenden Zustände haben:

Wert	Beschreibung
AVAILABLE	Modell ist aktiv und kann verwendet werden
DEPRECATED	Modell ist zur Entfernung in künftigen Versionen vorgesehen
RETIRED	Modell ist nicht mehr verfügbar