conjuntos de opciones de uip df

Sintaxis y opciones para `conjuntos de opciones de uip df` y `valores de conjuntos de opciones de uip df`, que gestionan las listas de valores enumerados de Data Fabric.

uip df choice-sets y uip df choice-set-values gestionan conjuntos de opciones de Data Fabric: las listas de valores enumerados a las que hacen referencia los campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE en una entidad. choice-sets gestiona el propio conjunto (sus metadatos y la lista de valores permitidos); choice-set-values gestiona los valores individuales dentro de un conjunto.

Sinopsis

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

Cada verbo también acepta --folder-key <key> (un GUID de carpeta, para un conjunto de opciones de ámbito de carpeta).

conjuntos de opciones de uip df

lista de conjuntos de opciones de uip df

Enumerar conjuntos de opciones. Los valores predeterminados son conjuntos de opciones a nivel de tenant; --folder-key ámbitos a una carpeta, --include-folders incluye los conjuntos de opciones de cada carpeta junto con los de nivel de tenant.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-key	clave	—	Clave de carpeta (GUID) para establecer el ámbito del listado en una carpeta específica. Mutuamente exclusivo con --include-folders.
—	--include-folders	Marca	Desactivado	Enumera los conjuntos de opciones a nivel de tenant junto con los conjuntos de opciones de cada carpeta que puedas ver. Mutuamente exclusivo con --folder-key.

Ejemplo

uip df choice-sets list

Forma de datos (--json de salida)

{
  "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"
    }
  ]
}

Las Data filas son objetos SDK de camelCase sin procesar. El id de cada fila es el valor a pasar como choiceSetId en un campo de entidad CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE , o a list-values a continuación.

uip df conjuntos de opciones valores-de-lista

Enumerar los valores de un conjunto de opciones. Admite la paginación basada en cursores.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-l	--limit	Número	50	Número de valores a devolver por página.
-o	--offset	Número	—	Comience desde la página que contiene este índice de registro (redondeado a un límite de página). Mutuamente excluyente con --cursor.
—	--cursor	Cursor	—	Valor del cursor de paginación de un nextCursor.value de respuesta anterior.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones, para conjuntos de opciones de ámbito de carpeta.

Ejemplo

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

Forma de datos (--json de salida)

{
  "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 es el número entero que se pasa al insertar o actualizar un registro en un campo CHOICE_SET_SINGLE — o en una matriz, para CHOICE_SET_MULTIPLE.

creación de conjuntos de opciones de uip df

Crear un nuevo conjunto de opciones.

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre del conjunto de opciones (comienza con una letra; solo letras, números y guiones bajos).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--display-name	text	—	Nombre para mostrar legible por humanos.
—	--description	text	—	Descripción del conjunto de opciones.
—	--folder-key	Uuid	—	Carpeta en la que colocar el conjunto de opciones. El valor predeterminado es la carpeta en el nivel de tenant.

Ejemplo

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

Forma de datos (--json de salida)

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

El ID devuelto se utiliza como choiceSetId en los campos de entidad CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE. Añádele valores con choice-set-values create, a continuación.

actualización de conjuntos de opciones de uip df

Actualizar el nombre para mostrar y la descripción de un conjunto de opciones.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--display-name	text	—	Obligatorio. Nuevo nombre para mostrar.
—	--description	text	—	Obligatorio. Nueva descripción.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones, para conjuntos de opciones de ámbito de carpeta.

Importante:

--display-name y --description deben pasarse juntos: no hay actualización parcial. El servidor rechaza una actualización solo de descripción con DisplayName is required., y rechaza una actualización solo de nombre para mostrar con un Error interno del servidor. Para cambiar solo un campo, primero lee el valor actual del otro con choice-sets list y luego vuelve a enviar ambos.

Ejemplo

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

Forma de datos (--json de salida)

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

eliminación de conjuntos de opciones de uip df

Eliminar un conjunto de opciones directamente. Esto es irreversible.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-y	--yes	Marca	—	Obligatorio. Confirma que se trata de una operación irreversible.
—	--reason	text	—	Obligatorio. Motivo de la eliminación: se repite en la respuesta para que la persona que llama pueda registrarlo.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones, para conjuntos de opciones de ámbito de carpeta.

Ejemplo

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

Forma de datos (--json de salida)

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

valores-de-elección-de-conjunto-de-elección-de-uip-df

creación de valores de conjunto de opciones de uip df

Añade un valor a un conjunto de opciones.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).
<name>	Sí	Nombre del valor (comienza con una letra; solo letras y números).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--display-name	text	—	Nombre para mostrar legible por humanos.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones. Obligatorio cuando el conjunto de opciones tiene ámbito de carpeta.

Ejemplo

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

Forma de datos (--json de salida)

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

El numberId devuelto es el entero que se pasa al insertar o actualizar registros en un campo CHOICE_SET_SINGLE (o en una matriz, para CHOICE_SET_MULTIPLE).

actualización de valores de conjunto de opciones de uip df

Actualizar el nombre para mostrar de un valor de conjunto de opciones existente.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).
<value-id>	Sí	ID de valor de conjunto de opciones (UUID). Encuéntralo con choice-sets list-values <choice-set-id>.
<display-name>	Sí	Nuevo nombre para mostrar del valor.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones. Obligatorio cuando el conjunto de opciones tiene ámbito de carpeta.

Ejemplo

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

Forma de datos (--json de salida)

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

Eliminar valores de conjunto de opciones de uip df

Eliminar uno o más valores de un conjunto de opciones. Esto es irreversible.

Argumentos

Nombre	Obligatorio	Propósito
<choice-set-id>	Sí	ID de conjunto de opciones (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--ids	id,id,...	—	Obligatorio. Lista separada por comas de ID de valor para eliminar.
-y	--yes	Marca	—	Obligatorio. Confirma que se trata de una operación irreversible.
—	--reason	text	—	Obligatorio. Motivo de la eliminación: se repite en la respuesta para que la persona que llama pueda registrarlo.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene el conjunto de opciones. Obligatorio cuando el conjunto de opciones tiene ámbito de carpeta.

Ejemplo

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"

Forma de datos (--json de salida)

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

Relacionado

• uip df entities — Los campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE hacen referencia a una opción establecida por choiceSetId.
• uip df records — insertar/actualizar valores de registro utilizando numberId de un valor de elección.

Ver también

• Descripción general de la herramienta Data Fabric
• Opciones globales
• Códigos de salida