conjuntos de escolhas uip df

Sintaxe e opções para "uip df Choice-sets" e "uip df Choice-set-values", que gerenciam as listas de valores enumerados do Data Fabric.

uip df choice-sets e uip df choice-set-values gerenciam conjuntos de escolhas Data Fabric — as listas de valores enumerados referenciadas por campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE em uma entidade. choice-sets gerencia o próprio conjunto (seus metadados e a lista de valores permitidos); choice-set-values gerencia os valores individuais dentro de um conjunto.

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

Cada verbo também aceita --folder-key <key> (um GUID de pasta, para um conjunto de escolhas com escopo de pasta).

conjuntos de escolhas uip df

lista de conjuntos de escolhas uip df

Listar conjuntos de escolhas. O padrão é o conjunto de escolhas no nível do tenant; --folder-key escopos para uma pasta, --include-folders inclui os conjuntos de escolhas de cada pasta junto com aqueles no nível do tenant.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Chave de pasta (GUID) para delimitar a listagem para uma pasta específica. mutuamente exclusivo com --include-folders.
—	--include-folders	Bandeira	desativada	Liste conjuntos de escolhas no nível do tenant junto com conjuntos de escolhas de cada pasta que você puder visualizar. mutuamente exclusivo com --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"
    }
  ]
}

As linhas Data são objetos do SDK CamelCase brutos. id de cada linha é o valor a ser passado como choiceSetId em um campo de entidade CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE ou para list-values abaixo.

conjuntos de escolhas uipath df lista-valores

Liste os valores de um conjunto de escolhas. Suporta paginação baseada em cursor.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Número de valores a serem retornados por página.
-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	—	Valor do cursor de paginação de nextCursor.value de uma resposta anterior.
—	--folder-key	chave	—	Chave da pasta (GUID) da pasta que contém o conjunto de escolhas, para conjuntos de escolhas com escopo de pasta.

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 é o número inteiro a passar ao inserir ou atualizar um registro em um campo CHOICE_SET_SINGLE — ou em uma matriz, para CHOICE_SET_MULTIPLE.

criação de conjuntos de escolhas uip df

Crie um novo conjunto de escolhas.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do conjunto de escolhas (começa com uma letra; apenas letras, números e sublinhados).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Nome de exibição legível por humanos.
—	--description	text	—	Descrição do conjunto de escolhas.
—	--folder-key	UUID	—	Pasta na qual colocar o conjunto de escolhas. O padrão para a pasta no nível do tenant.

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

O ID retornado é usado como choiceSetId nos campos de entidade CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE. Adicione valores a ele com choice-set-values create, abaixo.

atualização de conjuntos de escolhas uip df

Atualizar o nome de exibição e a descrição de um conjunto de escolhas.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Obrigatório. Novo nome de exibição.
—	--description	text	—	Obrigatório. Nova descrição.
—	--folder-key	chave	—	Chave da pasta (GUID) da pasta que contém o conjunto de escolhas, para conjuntos de escolhas com escopo de pasta.

Importante:

--display-name e --description devem ser passados juntos — não há atualização parcial. O servidor rejeita uma atualização apenas de descrição com DisplayName is required. e rejeita uma atualização apenas de nome de exibição com um Erro Interno do Servidor. Para alterar apenas um campo, primeiro leia o valor atual do outro com choice-sets list e, em seguida, reenvie ambos.

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

exclusão de conjuntos de escolhas uip df

Excluir um conjunto de escolhas imediatamente. Isso é irreversível.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma que esta é uma operação irreversível.
—	--reason	text	—	Obrigatório. Motivo da exclusão — retornado na resposta para que o chamador possa registrá-lo.
—	--folder-key	chave	—	Chave da pasta (GUID) da pasta que contém o conjunto de escolhas, para conjuntos de escolhas com escopo de pasta.

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

valores-conjunto-de-opções de uip df

criação de valores-conjunto-de-opção de uip df

Adicione um valor a um conjunto de escolhas.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).
<name>	sim	Nome do valor (começa com uma letra; somente letras e números).

Opções

Short	Long	Valor	Padrão	Description
—	--display-name	text	—	Nome de exibição legível por humanos.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém o conjunto de escolhas. Obrigatório quando o conjunto de escolhas tem o escopo de pasta.

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

O numberId retornado é o número inteiro a ser passado ao inserir ou atualizar registros em um campo CHOICE_SET_SINGLE (ou em uma matriz, para CHOICE_SET_MULTIPLE).

atualização de valores de conjunto de escolhas uip df

Atualize o nome de exibição de um valor de conjunto de escolhas existente.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).
<value-id>	sim	ID do valor do conjunto de escolhas (UUID). Encontre-o com choice-sets list-values <choice-set-id>.
<display-name>	sim	Novo nome de exibição para o valor.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém o conjunto de escolhas. Obrigatório quando o conjunto de escolhas tem o escopo de pasta.

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

exclusão de valores de escolha-conjunto-de-valores do uiip df

Exclua um ou mais valores de um conjunto de escolhas. Isso é irreversível.

Argumentos

Name	Required	Finalidade
<choice-set-id>	sim	ID do conjunto de escolhas (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--ids	id, id,...	—	Obrigatório. Lista separada por vírgulas de IDs de valores a serem excluídos.
-y	--yes	Bandeira	—	Obrigatório. Confirma que esta é uma operação irreversível.
—	--reason	text	—	Obrigatório. Motivo da exclusão — retornado na resposta para que o chamador possa registrá-lo.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém o conjunto de escolhas. Obrigatório quando o conjunto de escolhas tem o escopo de pasta.

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 campos fazem referência a uma escolha definida por choiceSetId.
• uip df records — inserir/atualizar valores de registro usando o numberId de um valor de escolha.

Veja também

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