UIP-DF-Auswahlsätze

Syntax und Optionen für „uip df wählen-sets“ und „uip df wählen-set-values“, die die Aufzählungswerte von Data Fabric verwalten.

uip df choice-sets und uip df choice-set-values verwalten Data Fabric-Auswahlsätze – die aufgezählten Wertlisten, auf die von CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE -Feldern auf einer Entität verwiesen wird. choice-sets verwaltet den Satz selbst (seine Metadaten und die Liste der zulässigen Werte); choice-set-values verwaltet die einzelnen Werte innerhalb eines Satzes.

Zusammenfassung

uip df choice-sets list [--folder-key <key> | --include-folders]
uip df choice-sets list-values <choice-set-id> [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df choice-sets create <name> [--display-name <name>] [--description <text>] [--folder-key <key>]
uip df choice-sets update <choice-set-id> --display-name <name> --description <text> [--folder-key <key>]
uip df choice-sets delete <choice-set-id> -y --reason <text> [--folder-key <key>]

uip df choice-set-values create <choice-set-id> <name> [--display-name <name>] [--folder-key <key>]
uip df choice-set-values update <choice-set-id> <value-id> <display-name> [--folder-key <key>]
uip df choice-set-values delete <choice-set-id> --ids <id,id,...> -y --reason <text> [--folder-key <key>]

Jedes Verb akzeptiert auch --folder-key <key> (eine Ordner-GUID für einen Auswahlsatz mit Ordner-Scope).

UIP-DF-Auswahlsätze

UIP-df-Auswahlsatzliste

Auswahlsätze auflisten. Standardeinstellung sind Auswahlsätze auf Mandantenebene; --folder-key bezieht sich auf einen Ordner, --include-folders enthält die Auswahlsätze jedes Ordners neben denen auf Mandantenebene.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--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 die Auswahlsätze auf Mandantenebene zusammen mit den Auswahlsätzen aus jedem Ordner auf, den Sie sehen können. Sich gegenseitig mit --folder-key ausschließen.

Beispiel

uip df choice-sets list

Datenform (--output json)

{
  "Code": "ChoiceSetList",
  "Data": [
    {
      "id": "c1d2e3f4-0000-0000-0000-000000000001",
      "name": "ExpenseTypes",
      "displayName": "Expense Types",
      "description": "Categories of expenses",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "createdBy": "u1000000-0000-0000-0000-000000000001",
      "updatedBy": "u1000000-0000-0000-0000-000000000001",
      "createdTime": "2026-01-01T00:00:00Z",
      "updatedTime": "2026-01-02T00:00:00Z"
    }
  ]
}

Data Zeilen sind unbearbeitete BinnenMajuskel-SDK-Objekte. id jeder Zeile ist der Wert, der als choiceSetId an ein CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE -Entitätsfeld oder an list-values unten übergeben werden soll.

UIP-df-Auswahlsätze-Listenwerte

Listen Sie die Werte eines Auswahlsatzes auf. Unterstützt die Cursor-basierte Paginierung.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
-l	--limit	Nummer	50	Anzahl der Werte, die pro Seite zurückgegeben werden sollen.
-o	--offset	Nummer	–	Beginnen Sie mit der Seite, die diesen Datensatzindex enthält (abgerundet auf eine Seitengrenze). Sich gegenseitig mit --cursor ausschließen.
–	--cursor	Cursor	–	Paginierungscursorwert aus nextCursor.value einer vorherigen Antwort.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der den Auswahlsatz enthält, für Auswahlsätze mit Ordner-Scope.

Beispiel

uip df choice-sets list-values c1d2e3f4-0000-0000-0000-000000000001 --limit 2

Datenform (--output json)

{
  "Code": "ChoiceSetValues",
  "Data": {
    "items": [
      { "id": "v1000000-0000-0000-0000-000000000001", "name": "travel", "displayName": "Travel", "numberId": 0 },
      { "id": "v1000000-0000-0000-0000-000000000002", "name": "meals", "displayName": "Meals", "numberId": 1 }
    ],
    "totalCount": 2,
    "hasNextPage": false
  }
}

numberId ist der Integer, der beim Einfügen oder Aktualisieren eines Datensatzes in ein CHOICE_SET_SINGLE -Feld – oder in einem Array für CHOICE_SET_MULTIPLE übergeben werden soll.

UIP-DF-Auswahlsätze erstellen

Erstellen Sie einen neuen Auswahlsatz.

Argumente

Name	Erforderlich	Zweck
<name>	ja	Auswahlsatzname (beginnt mit einem Buchstaben; nur Buchstaben, Ziffern und Unterstriche).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--display-name	text	–	Für Menschen lesbarer Anzeigename.
–	--description	text	–	Beschreibung des Auswahlsatzes.
–	--folder-key	UUID	–	Ordner, in dem der Auswahlsatz platziert werden soll. Standardmäßig der Ordner auf Mandantenebene.

Beispiel

uip df choice-sets create ExpenseTypes \
    --display-name "Expense Types" \
    --description "Categories of expenses"

Datenform (--output json)

{
  "Code": "ChoiceSetCreated",
  "Data": { "ID": "c1d2e3f4-0000-0000-0000-000000000001" }
}

Das zurückgegebene ID wird als choiceSetId in CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE -Entitätsfeldern verwendet. Fügen Sie unten mit choice-set-values create Werte hinzu.

Aktualisierung der UIP-DF-Auswahlsätze

Aktualisieren Sie den Anzeigenamen und die Beschreibung eines Auswahlsatzes.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--display-name	text	–	Erforderlich. Neuer Anzeigename.
–	--description	text	–	Erforderlich. Neue Beschreibung.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der den Auswahlsatz enthält, für Auswahlsätze mit Ordner-Scope.

Wichtig:

--display-name und --description müssen beide zusammen übergeben werden – es gibt keine teilweise Aktualisierung. Der Server weist eine Aktualisierung nur auf der Beschreibung mit DisplayName is required. zurück und eine Aktualisierung nur auf dem Anzeigenamen mit einem internen Serverfehler. Um nur ein Feld zu ändern, lesen Sie zuerst den aktuellen Wert des anderen Felds mit choice-sets list und senden Sie dann beide erneut.

Beispiel

uip df choice-sets update c1d2e3f4-0000-0000-0000-000000000001 \
    --display-name "Expense Categories" \
    --description "Categories of expenses"

Datenform (--output json)

{
  "Code": "ChoiceSetUpdated",
  "Data": { "ID": "c1d2e3f4-0000-0000-0000-000000000001" }
}

UIP-DF-Auswahlsätze löschen

Einen Auswahlsatz direkt löschen. Dies kann nicht rückgängig gemacht werden.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-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 den Auswahlsatz enthält, für Auswahlsätze mit Ordner-Scope.

Beispiel

uip df choice-sets delete c1d2e3f4-0000-0000-0000-000000000001 \
    --yes --reason "no longer used"

Datenform (--output json)

{
  "Code": "ChoiceSetDeleted",
  "Data": {
    "ID": "c1d2e3f4-0000-0000-0000-000000000001",
    "Reason": "no longer used"
  }
}

uip-df-Auswahlsatzwerte

Erstellung von UIP-DF-Auswahlsatzwerten

Fügen Sie einen Wert zu einem Auswahlsatz hinzu.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-ID (UUID).
<name>	ja	Wertname (beginnt mit einem Buchstaben; nur Buchstaben und Zahlen).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--display-name	text	–	Für Menschen lesbarer Anzeigename.
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der den Auswahlsatz enthält. Erforderlich, wenn der Auswahlsatz einen Ordner-Scope hat.

Beispiel

uip df choice-set-values create c1d2e3f4-0000-0000-0000-000000000001 travel \
    --display-name "Travel"

Datenform (--output json)

{
  "Code": "ChoiceSetValueCreated",
  "Data": {
    "id": "v1000000-0000-0000-0000-000000000001",
    "name": "travel",
    "displayName": "Travel",
    "numberId": 0
  }
}

Das zurückgegebene numberId ist der Integer, der beim Einfügen oder Aktualisieren von Datensätzen in ein CHOICE_SET_SINGLE -Feld (oder in einem Array, für CHOICE_SET_MULTIPLE) übergeben werden soll.

Aktualisierung der UIP-df-Auswahlsatzwerte

Aktualisieren Sie den Anzeigenamen eines vorhandenen Auswahlsatzwerts.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-ID (UUID).
<value-id>	ja	Auswahlsatzwert-ID (UUID). Finden Sie es mit choice-sets list-values <choice-set-id>.
<display-name>	ja	Neuer Anzeigename für den Wert.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-key	Schlüssel	–	Ordnerschlüssel (GUID) des Ordners, der den Auswahlsatz enthält. Erforderlich, wenn der Auswahlsatz einen Ordner-Scope hat.

Beispiel

uip df choice-set-values update c1d2e3f4-0000-0000-0000-000000000001 \
    v1000000-0000-0000-0000-000000000001 "Business Travel"

Datenform (--output json)

{
  "Code": "ChoiceSetValueUpdated",
  "Data": {
    "id": "v1000000-0000-0000-0000-000000000001",
    "name": "travel",
    "displayName": "Business Travel",
    "numberId": 0
  }
}

UIP-DF-Auswahlsatzwerte löschen

Löschen Sie einen oder mehrere Werte aus einem Auswahlsatz. Dies kann nicht rückgängig gemacht werden.

Argumente

Name	Erforderlich	Zweck
<choice-set-id>	ja	Auswahlsatz-ID (UUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--ids	Id, ID, …	–	Erforderlich. Kommagetrennte Liste der zu löschenden Wert-IDs.
-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 den Auswahlsatz enthält. Erforderlich, wenn der Auswahlsatz einen Ordner-Scope hat.

Beispiel

uip df choice-set-values delete c1d2e3f4-0000-0000-0000-000000000001 \
    --ids v1000000-0000-0000-0000-000000000001,v1000000-0000-0000-0000-000000000002 \
    --yes --reason "deprecated categories"

Datenform (--output json)

{
  "Code": "ChoiceSetValuesDeleted",
  "Data": {
    "ChoiceSetId": "c1d2e3f4-0000-0000-0000-000000000001",
    "DeletedIds": [
      "v1000000-0000-0000-0000-000000000001",
      "v1000000-0000-0000-0000-000000000002"
    ],
    "Reason": "deprecated categories"
  }
}

Zugehörig

• uip df entities – CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE Felder verweisen auf eine Auswahl, die von choiceSetId festgelegt wurde.
• uip df records – Datensatzwerte mithilfe des numberId eines Auswahlwerts einfügen/aktualisieren.

Siehe auch

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