uip df choice-sets

Syntax and options for `uip df choice-sets` and `uip df choice-set-values`, which manage Data Fabric's enumerated value lists.

uip df choice-sets and uip df choice-set-values manage Data Fabric choice sets — the enumerated value lists referenced by CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE fields on an entity. choice-sets manages the set itself (its metadata and the list of allowed values); choice-set-values manages the individual values within a set.

Resumo

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

Every verb also accepts --folder-key <key> (a folder GUID, for a folder-scoped choice set).

uip df choice-sets

uip df choice-sets list

List choice sets. Defaults to tenant-level choice sets; --folder-key scopes to one folder, --include-folders includes every folder's choice sets alongside tenant-level ones.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Folder key (GUID) to scope the listing to a specific folder. Mutually exclusive with --include-folders.
—	--include-folders	Bandeira	desativada	List tenant-level choice sets together with choice sets from every folder you can see. Mutually exclusive with --folder-key.

Exemplo

uip df choice-sets list

Formato dos dados (--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 rows are raw, camelCase SDK objects. Each row's id is the value to pass as choiceSetId on a CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE entity field, or to list-values below.

uip df choice-sets list-values

List the values of a choice set. Supports cursor-based pagination.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Number of values to return per page.
-o	--offset	Número	—	Comece da página que contém esse índice de registro (arredondado para baixo para um limite de página). mutuamente exclusivo com --cursor.
—	--cursor	Cursor	—	Pagination cursor value from a previous response's nextCursor.value.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set, for folder-scoped choice sets.

Exemplo

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

Formato dos dados (--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 is the integer to pass when inserting or updating a record into a CHOICE_SET_SINGLE field — or in an array, for CHOICE_SET_MULTIPLE.

uip df choice-sets create

Create a new choice set.

Argumentos

Name	Required	Finalidade
<name>	sim	Choice set name (starts with a letter; letters, numbers, and underscores only).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Human-readable display name.
—	--description	text	—	Choice set description.
—	--folder-key	uuid	—	Folder to place the choice set in. Defaults to the tenant-level folder.

Exemplo

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

Formato dos dados (--output json)

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

The returned ID is used as choiceSetId on CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE entity fields. Add values to it with choice-set-values create, below.

uip df choice-sets update

Update a choice set's display name and description.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Required. New display name.
—	--description	text	—	Required. New description.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set, for folder-scoped choice sets.

Importante:

--display-name and --description must both be passed together — there is no partial update. The server rejects a description-only update with DisplayName is required., and rejects a display-name-only update with an Internal Server Error. To change just one field, first read the other's current value with choice-sets list, then resend both.

Exemplo

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

Formato dos dados (--output json)

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

uip df choice-sets delete

Delete a choice set outright. This is irreversible.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Required. Acknowledges this is an irreversible operation.
—	--reason	text	—	Required. Reason for the deletion — echoed back in the response so the caller can log it.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set, for folder-scoped choice sets.

Exemplo

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

Formato dos dados (--output json)

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

uip df choice-set-values

uip df choice-set-values create

Add a value to a choice set.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).
<name>	sim	Value name (starts with a letter; letters and numbers only).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Human-readable display name.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set. Required when the choice set is folder-scoped.

Exemplo

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

Formato dos dados (--output json)

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

The returned numberId is the integer to pass when inserting or updating records into a CHOICE_SET_SINGLE field (or in an array, for CHOICE_SET_MULTIPLE).

uip df choice-set-values update

Update the display name of an existing choice set value.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).
<value-id>	sim	Choice set value ID (UUID). Find it with choice-sets list-values <choice-set-id>.
<display-name>	sim	New display name for the value.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set. Required when the choice set is folder-scoped.

Exemplo

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

Formato dos dados (--output json)

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

uip df choice-set-values delete

Delete one or more values from a choice set. This is irreversible.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	Choice set ID (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--ids	id,id,...	—	Required. Comma-separated list of value IDs to delete.
-y	--yes	Bandeira	—	Required. Acknowledges this is an irreversible operation.
—	--reason	text	—	Required. Reason for the deletion — echoed back in the response so the caller can log it.
—	--folder-key	chave	—	Folder key (GUID) of the folder containing the choice set. Required when the choice set is folder-scoped.

Exemplo

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"

Formato dos dados (--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"
  }
}

Relacionado

• uip df entities — CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE fields reference a choice set by choiceSetId.
• uip df records — insert/update record values using a choice value's numberId.

Veja também

• Visão geral da ferramenta Data Fabric
• Opções globais
• Códigos de saída