Ensembles de choix df uip

Syntaxe et options pour `uip df Choicesets` et `uip df Choice-set-values`, qui gèrent les listes de valeurs énumérées de Data Fabric.

uip df choice-sets et uip df choice-set-values gèrent les ensembles de choix Data Fabric - les listes de valeurs énumérées référencées par CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE champs sur une entité. choice-sets gère l'ensemble lui-même (ses métadonnées et la liste des valeurs autorisées); choice-set-values gère les valeurs individuelles au sein d'un ensemble.

Synthèse

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>]

Chaque verbe accepte également --folder-key <key> (un GUID de dossier, pour un ensemble de choix à l'échelle du dossier).

Ensembles de choix df uip

liste d'ensembles de choix uip df

Lister des ensembles de choix. La valeur par défaut est des ensembles de choix au niveau du locataire; --folder-key s'étend à un seul dossier, --include-folders inclut les ensembles de choix de chaque dossier ainsi que ceux au niveau du locataire.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-key	touche	—	Clé de dossier pour étendre la liste à un dossier spécifique. Capture mutuellement exclusive avec --include-folders.
—	--include-folders	Drapeau	désactivé	Répertoriez les ensembles de choix au niveau du locataire ainsi que les ensembles de choix de chaque dossier visible. Capture mutuellement exclusive avec --folder-key.

Exemple

uip df choice-sets list

Format des données (--sortie 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 lignes sont des objets SDK camelCase bruts. La valeur id de chaque ligne correspond à la valeur à transmettre en tant que choiceSetId sur un champ d'entité CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE , ou au list-values ci-dessous.

uip df Ensembles de choix - Valeurs de liste

Répertorie les valeurs d'un ensemble de choix. Prend en charge la pagination basée sur des curseurs.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.

Options

Short	Long	Valeur (Value)	Default	Description
-l	--limit	Numérique	50	Nombre de valeurs à renvoyer par page.
-o	--offset	Numérique	—	Commencez par la page contenant cet index d’enregistrement (arrondi à une limite de page). Capture mutuellement exclusive avec --cursor
—	--cursor	Curseur	—	Valeur du curseur de pagination de la valeur nextCursor.value d'une réponse précédente.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix, pour les ensembles de choix à l'échelle du dossier.

Exemple

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

Format des données (--sortie 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 est l'entier à transmettre lors de l'insertion ou de la mise à jour d'un enregistrement dans un champ CHOICE_SET_SINGLE — ou dans un tableau, pour CHOICE_SET_MULTIPLE

Création d'ensembles de choix uip df

Créez un nouvel ensemble de choix.

Arguments

Nom	Requis	Objectif
<name>	oui	Nom de l'ensemble de choix (commence par une lettre; lettres, chiffres et traits de soulignement uniquement).

Options

Short	Long	Valeur (Value)	Default	Description
—	--display-name	text	—	Nom complet lisible par un humain.
—	--description	text	—	Description de l'ensemble de choix.
—	--folder-key	UUID	—	Dossier dans lequel placer l'ensemble de choix. La valeur par défaut est le dossier au niveau du locataire.

Exemple

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

Format des données (--sortie json)

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

Le ID renvoyé est utilisé comme choiceSetId pour les champs d’entité CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE. Ajoutez-y des valeurs avec choice-set-values create, ci-dessous.

Mise à jour des ensembles de choix uip df

Mettez à jour le nom complet et la description d'un ensemble de choix.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.

Options

Short	Long	Valeur (Value)	Default	Description
—	--display-name	text	—	Requis. Nouveau nom complet.
—	--description	text	—	Requis. Nouvelle description.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix, pour les ensembles de choix à l'échelle du dossier.

Important :

--display-name et --description doivent être tous deux transmis ensemble — il n'y a pas de mise à jour partielle. Le serveur rejette une mise à jour de la description uniquement avec DisplayName is required. et rejette une mise à jour du nom d'affichage uniquement avec une erreur interne du serveur. Pour modifier un seul champ, lisez d'abord la valeur actuelle de l'autre avec choice-sets list, puis renvoyez les deux.

Exemple

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

Format des données (--sortie json)

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

suppression des ensembles de choix uip df

Supprimez un ensemble de choix. Ceci est irréversible.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Requis. Confirme que cette opération est irréversible.
—	--reason	text	—	Requis. Motif de la suppression — renvoyé dans la réponse afin que l'appelant puisse la consigner.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix, pour les ensembles de choix à l'échelle du dossier.

Exemple

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

Format des données (--sortie json)

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

uip Choice-set-values

création de valeurs d'ensemble de choix uip df

Ajoutez une valeur à un ensemble de choix.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.
<name>	oui	Nom de la valeur (commence par une lettre; lettres et chiffres uniquement).

Options

Short	Long	Valeur (Value)	Default	Description
—	--display-name	text	—	Nom complet lisible par un humain.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix. Obligatoire lorsque l'ensemble de choix est défini sur l'étendue du dossier.

Exemple

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

Format des données (--sortie json)

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

Le numberId renvoyé est l'entier à transmettre lors de l'insertion ou de la mise à jour des enregistrements dans un champ CHOICE_SET_SINGLE (ou dans un tableau, pour CHOICE_SET_MULTIPLE).

mise à jour des valeurs de l'ensemble de choix uip

Mettez à jour le nom d'affichage d'une valeur d'ensemble de choix existante.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.
<value-id>	oui	ID de la valeur de l’ensemble de choix. Trouvez-le avec choice-sets list-values <choice-set-id>.
<display-name>	oui	Nouveau nom complet de la valeur.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix. Obligatoire lorsque l'ensemble de choix est défini sur l'étendue du dossier.

Exemple

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

Format des données (--sortie json)

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

suppression des valeurs d’ensemble de choix uip

Supprimez une ou plusieurs valeurs d'un ensemble de choix. Ceci est irréversible.

Arguments

Nom	Requis	Objectif
<choice-set-id>	oui	ID d’ensemble de choix.

Options

Short	Long	Valeur (Value)	Default	Description
—	--ids	id, id,...	—	Requis. Liste des ID de valeur séparés par des virgules à supprimer.
-y	--yes	Drapeau	—	Requis. Confirme que cette opération est irréversible.
—	--reason	text	—	Requis. Motif de la suppression — renvoyé dans la réponse afin que l'appelant puisse la consigner.
—	--folder-key	touche	—	Clé de dossier (GUID) du dossier contenant l'ensemble de choix. Obligatoire lorsque l'ensemble de choix est défini sur l'étendue du dossier.

Exemple

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"

Format des données (--sortie json)

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

Associé

• Les champs uip df entities — CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE font référence à un choix défini par choiceSetId.
• uip df records — insérer/mettre à jour les valeurs d'enregistrement en utilisant la valeur numberId d'une valeur de choix.

Voir également

• Présentation de l’outil Data Fabric
• Options globales
• Codes de sortie