UIP-df-Entitäten

Syntax und Optionen für „uip df entities“, die Data Fabric-Entitätsschemas durchsuchen und ändern.

uip df entities durchsucht und verändert Data Fabric-Entitätsschemas. Eine Entität ist ein typisiertes Datenmodell – eine Zeilenform mit benannten Feldern und Typen. Die Verben decken die Erkennung (list, get), die Erstellung (create, update) und das Entfernen (delete) ab; Vorgänge auf Datensatzebene live auf uip df records.

Zusammenfassung

uip df entities list [--native-only] [--folder-key <key> | --include-folders]
uip df entities get <id> [--folder-key <key>]
uip df entities create <name> (-f <path> | --body <json>) [--folder-key <key>]
uip df entities update <id> (-f <path> | --body <json>) [-y --reason <text>] [--folder-key <key>]
uip df entities delete <id> -y --reason <text> [--folder-key <key>]

Verben

Verb	Zweck
list	Listenentitäten auf. Standardmäßig werden Entitäten auf Mandantenebene verwendet; --folder-key Scopes auf einen Ordner, --include-folders enthält die Entitäten jedes Ordners neben denen auf Mandantenebene.
get	Gibt das Schema (einschließlich aller Felder) einer einzelnen Entität zurück.
create	Erstellen Sie eine neue Entität aus einer JSON-Definition.
update	Aktualisieren Sie die Metadaten oder das Schema einer Entität – fügen Sie Felder hinzu, aktualisieren Sie Feldmetadaten oder entfernen Sie Felder (destruktiv, erfordert -y/--reason).
delete	Eine Entität direkt löschen (destruktiv, erfordert -y/--reason).

--folder-key, --native-only, --include-folders

--folder-key <key> (eine Ordner-GUID) ordnet ein Verb einer Entität auf Ordnerebene anstelle des Mandanten zu. Wird für jedes Verb in dieser Gruppe akzeptiert. Auf list schließt es sich gegenseitig mit --include-folders aus (wodurch Entitäten auf Mandantenebene zusammen mit den Entitäten jedes Ordners in einem Aufruf aufgeführt werden). --native-only (nur auf list) filtert Verbundentitäten heraus – solche, die von einer externen Connectorverbindung unterstützt werden (identifiziert durch ein nicht leeres externalFields -Array).

Liste der UIP-DF-Entitäten

Listen Sie Data Fabric-Entitäten auf.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--native-only	Markieren	aus	Nur native Entitäten anzeigen; Verbundentitäten mit externen Verbindungen ausschließen.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID), um die Auflistung auf einen bestimmten Ordner zu beschränken. Sich gegenseitig mit --include-folders ausschließen.
–	--include-folders	Markieren	aus	Listen Sie Entitäten auf Mandantenebene zusammen mit Entitäten aus jedem Ordner auf, den Sie sehen können. Sich gegenseitig mit --folder-key ausschließen.

Beispiele

uip df entities list --native-only

uip df entities list --folder-key f1000000-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "EntityList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Invoice",
      "displayName": "Invoice",
      "entityType": "Standard",
      "description": "Invoice records",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "isRbacEnabled": false,
      "fields": [
        { "id": "f1000000-0000-0000-0000-000000000001", "name": "amount" }
      ],
      "externalFields": []
    }
  ]
}

Wichtig:

Data Zeilen sind hier die unbearbeiteten SDK-Objekte in BinnenMajuskel – im Gegensatz zur Antwort von get unten gibt list keine PascalCase-Feldnamen an und verändert die Nutzlast nicht. Der folderId jeder Zeile ist der Wert, der bei Folgebefehlen, die auf diese Entität abzielen, als --folder-key übergeben werden soll.

Abrufen von UIP-DF-Entitäten

Gibt das Schema einer einzelnen Entität zurück, einschließlich aller Felder.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID). Finden Sie es mit entities list.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiel

uip df entities get a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "EntitySchema",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "EntityType": "Standard",
    "Description": "Invoice records",
    "IsRbacEnabled": false,
    "Fields": [
      {
        "Id": "f1000000-0000-0000-0000-000000000002",
        "Name": "amount",
        "DisplayName": "Amount",
        "FieldDataType": {
          "Name": "DECIMAL",
          "DecimalPrecision": 2,
          "MinValue": 0,
          "MaxValue": 999999
        },
        "IsRequired": true,
        "IsUnique": false,
        "IsEncrypted": false,
        "IsRbacEnabled": false,
        "IsPrimaryKey": false,
        "IsSystemField": false
      }
    ]
  }
}

Im Gegensatz zu list ist diese Antwort PascalCase. Der Typname eines Felds und seine Einschränkungen (DecimalPrecision, MinValue, MaxValue, LengthLimit usw., je nach Typ) sind unter FieldDataType geschachtelt, nicht als flache Eigenschaften auf dem Feld.

uip-df-Entitäten erstellen

Eine neue Entität erstellen. Der Entitätsname muss mit einem Buchstaben beginnen und darf nur Buchstaben, Ziffern und Unterstriche enthalten. Übergeben Sie die Definition entweder inline (--body) oder aus einer Datei (--file).

Argumente

Name	Erforderlich	Zweck
<name>	ja	Entitätsname (beginnt mit einem Buchstaben; nur Buchstaben, Ziffern, Unterstriche).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	–	Pfad zu einer JSON-Datei mit der Entitätsdefinition (fields -Array erforderlich; displayName, description, isRbacEnabled, isAnalyticsEnabled optional).
–	--body	JSON	–	Inline-Definition der JSON-Entität, gleiche Form wie --file.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Zielordners, um eine Entität mit Ordner-Scope anstelle einer Entität auf Mandantenebene zu erstellen.

Entitätsdefinitionsobjekt:

{
  "displayName": "Invoice",
  "description": "Invoice records",
  "isRbacEnabled": false,
  "fields": [
    { "name": "title", "type": "STRING" }
  ]
}

Wichtig:

Jedes Feldobjekt erfordert name, nicht fieldName – das Übergeben von fieldName schlägt mit dem Validierungsfehler Each field must include a 'name' string fehl. Ein Feldobjekt, das wörtlich aus der Ausgabe von entities get kopiert wurde (die Name/FieldDataType, PascalCase verwendet), wird hier ebenfalls akzeptiert und automatisch in diese einfache Schreibform normalisiert.

Gültige type -Werte stammen aus der EntityFieldDataType -Aufzählung des SDK – ein ungültiger Typ schlägt mit einer ValidationError -Aufzählung des vollständigen zulässigen Satzes fehl. Neben den einfachen Skalartypen (STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME, …) bieten mehrere Typen zusätzliche erforderliche Eigenschaften für das Feldobjekt:

Typ	Zusätzliche erforderliche Eigenschaften
CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE	choiceSetId – UUID von df choice-sets list.
RELATIONSHIP	referenceEntityId (UUID der Zielentität, von entities list) und referenceFieldId (UUID eines Felds in der Zielentität, von entities get <target-id>). Optional referenceFolderKey, wenn sich die Zielentität in einem anderen Ordner befindet.
FILE	Nur name und type – der Server verkettet automatisch die interne Anhangsreferenz. Füllen Sie den Wert später mit uip df files upload aus.
MULTILINE_MAX	Optional lengthLimit (UTF 16-Byte-Budget, 1–131072; Standardwert ist etwa 65.536 Zeichen). Nicht filterbar oder sortierbar; records list/query geben nur einen Größenmarker dafür zurück – lesen Sie den vollständigen Inhalt mit records get. Gruppiert durch das Feature-Flag MultilineMax des Mandanten.

In einer RELATIONSHIP -Spalte in einem Datensatz wird immer die Id des Zieldatensatzes (eine UUID) gespeichert, unabhängig davon, welche referenceFieldId die Verknüpfung konfiguriert hat – records insert finden Sie weitere Informationen zum Schreiben des Werts.

Beispiele

uip df entities create Invoice --file ./invoice.entity.json

uip df entities create Invoice \
    --body '{"displayName":"Invoice","fields":[{"name":"amount","type":"DECIMAL"}]}'

# choice-set, relationship, file, and large-text fields
uip df entities create Expense \
    --body '{"displayName":"Expense","fields":[{"name":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"name":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"name":"receipt","type":"FILE"},{"name":"notes","type":"MULTILINE_MAX"}]}'

Datenform (--output json)

{
  "Code": "EntityCreated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

Aktualisierung der UIP-DF-Entitäten

Aktualisieren Sie die Metadaten oder das Schema einer Entität. Der Textkörper akzeptiert addFields, updateFields, removeFields, displayName, description und isAnalyticsEnabled/isRbacEnabled. Die Entität name selbst ist unveränderlich – sie kann nicht in den Aktualisierungstext aufgenommen werden.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-f	--file	Pfad	–	Pfad zur JSON-Datei mit Aktualisierungsoptionen.
–	--body	JSON	–	Inline-JSON-Aktualisierungsoptionen.
-y	--yes	Markieren	–	Erforderlich, wenn removeFields nicht leer ist – bestätigt, dass das Löschen des Felds nicht rückgängig gemacht werden kann.
–	--reason	text	–	Erforderlich, wenn removeFields nicht leer ist – wird in der Antwort zurückgegeben, damit der Aufrufer sie protokollieren kann.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

• addFields – Array neuer Felder, flache Schreibform (name + type sowie typspezifische Extras – siehe Abschnitt create oben). Ein aus entities get kopiertes Feldobjekt wird ebenfalls akzeptiert und normalisiert.
• updateFields – Array mit dem Schlüssel id (von entities get), wobei die Metadateneigenschaften geändert werden (z. B. displayName, description, isRequired, isRbacEnabled, isEncrypted, isHiddenField, defaultValue, Einschränkungen). Fügen Sie hier kein vollständig kopiertes Feldobjekt ein – übergeben Sie id plus nur die einfachen Eigenschaften, die geändert werden. updateFields kann die Einstellung type oder isUnique eines Felds nicht ändern.
• removeFields – Array von {"name": "<fieldName>"} Objekten, identifiziert durch Name, nicht durch ID. Erfordert -y/--yes und --reason "<text>" – der Vorgang löscht die gespeicherten Werte des Felds und kann nicht rückgängig gemacht werden.
• Das Aktualisieren von Entitätsmetadaten (description, isRbacEnabled, isAnalyticsEnabled) erfordert, dass displayName auch im selben Textkörper vorhanden ist, auch wenn er unverändert ist – rufen Sie zuerst das aktuelle displayName mit entities get ab, wenn nicht haben es bereits.

Beispiele

# Add a field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"addFields":[{"name":"note","type":"STRING","lengthLimit":200}]}'

# Rename an existing field's display name
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Amount (USD)","isRequired":true}]}'

# Remove a field — destructive, requires --yes and --reason
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"removeFields":[{"name":"oldColumn"}]}' \
    --yes --reason "quarterly cleanup"

Datenform (--output json)

{
  "Code": "EntityUpdated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

Wenn die Aktualisierung removeFields enthält, spiegelt die Antwort auch das wider, was entfernt wurde:

{
  "Code": "EntityUpdated",
  "Data": {
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedFields": ["oldColumn"],
    "Reason": "quarterly cleanup"
  }
}

UIP-DF-Entitäten löschen

Löschen Sie eine Entität direkt. Dies kann nicht rückgängig gemacht werden und entfernt das Schema der Entität zusammen mit allen ihren Datensätzen.

Argumente

Name	Erforderlich	Zweck
<id>	ja	Entitäts-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-y	--yes	Markieren	–	Erforderlich. Bestätigt, dass dies ein nicht rückgängig zu machender Vorgang ist.
–	--reason	text	–	Erforderlich. Grund für das Löschen – wird in der Antwort zurückgegeben, damit der Aufrufer ihn protokollieren kann.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der die Entität enthält, für Entitäten mit Ordner-Scope.

Beispiel

uip df entities delete a1b2c3d4-0000-0000-0000-000000000001 \
    --yes --reason "test entity cleanup"

Datenform (--output json)

{
  "Code": "EntityDeleted",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Reason": "test entity cleanup"
  }
}

Zugehörig

• uip df records – Verwalten Sie die von diesen Entitäten gehaltenen Zeilen.
• uip df files – Dateianhänge zu Datensätzen.
• uip df choice-sets – die Auswahlsätze, auf die die Felder CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE verweisen.
• uip vss generate – Generieren Sie TypeScript-Typen aus einem Data Fabric-Schemaexport.

Siehe auch

• Übersicht über das Data Fabric-Tool
• Globale Optionen
• Exitcodes