campo personalizado uip tm

Sintaxe e opções para "uip tm customfield", que gerencia definições de campos personalizados, linhas de rótulos e linhas de valor em um projeto do Test Manager.

uip tm customfield gerencia definições de campos personalizados em um projeto do Test Manager. Campos personalizados estendem requisitos, casos de teste e conjuntos de teste com metadados específicos do projeto. Esse grupo de comando possui três subgrupos:

• customfield gerencie a própria definição do campo (lista, obter, criar, atualizar, excluir)
• customfield label — gerenciar linhas de campo do tipo Rótulo (um mapa JSON do nome do campo para um ou mais valores de string, por objeto)
• customfield value — gerenciar linhas de campo tipo Texto (um único valor de string por objeto)

Importante:

O identificador principal para definições de campo é --field-id. As linhas de rótulo e valor são identificadas por --label-id / --value-id ou pela chave natural --object-type + --name + --object-id. O sinalizador --customfield-id não existe.

Resumo

# Field definitions
uip tm customfield list --project-key <key> [--object-types <types...>] [--data-types <types...>] [--name <name>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield get --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>)
uip tm customfield create --project-key <key> --name <name> --data-type <Text|Label> (--object-type <type> | --scope-list <types...>) [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --project-key <key> (--field-id <uuid> | --name <name> --object-type <type>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <types...>]
uip tm customfield delete --project-key <key> (--field-ids <uuid...> | --name <name> --object-type <type>) [-y]

# Labels
uip tm customfield label get --project-key <key> --object-type <type> --label-id <uuid>
uip tm customfield label list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield label create --project-key <key> --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <value...> [--replace-existing-values]
uip tm customfield label remove --project-key <key> --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <value...> | --remove-all-values) [-y]

# Values
uip tm customfield value list --project-key <key> --object-type <type> [--object-id <uuid>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm customfield value get --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --project-key <key> --object-type <type> --name <name> --object-id <uuid> --data-type <Text|Label> [--value <text>]
uip tm customfield value update --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [--data-type <Text|Label>] (--value <text> | --clear)
uip tm customfield value delete --project-key <key> --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]

Todos os verbos honram as opções globais e os códigos de saída padrão. Cada verbo aceita --log-level <level> (padrão Information) e -t, --tenant <name> (o padrão é o tenant autenticado).

Observação:

-t, --tenant aqui é uma opção normal e visível.

--object-type (e --object-types/--scope-list onde variável) aceita apenas Requirement, TestCase ou TestSet. --data-type (e --data-types) aceita apenas Text ou Label — não há tipo de dados String, Integer ou Boolean.

---

Comandos de definição de campo

lista de campos personalizados uip tm

Listar definições de campos personalizados em um projeto. --project-key é necessário; todos os outros filtros são opcionais.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-types <types...> — tipos de objetos separados por espaço para filtrar por: Requirement, TestCase, TestSet.
• --data-types <types...> — tipos de dados separados por espaço para filtrar por: Text, Label.
• --name <name> — correspondência de nome exato (filtro do lado do cliente; retorna uma linha por tipo de objeto em que o campo está definido).
• --filter <text> — pesquisa de substring no lado do servidor em campos de definição.
• --sort-by <expr> — classificar expressão, por exemplo name asc.
• --limit <n> — tamanho da página. O padrão é 50.
• --offset <n> — resultados a ignorar. O padrão é 0.

Exemplo

uip tm customfield list \
  --project-key DEMO \
  --object-types TestCase

Formato dos dados

{
  "Code": "CustomFieldDefinitionsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "Name": "Priority",
      "Description": "Test priority",
      "DefaultValue": "Medium",
      "ValueHints": "",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "ScopeList": ["TestCase"]
    }
  ]
}

---

Obtenção de campo personalizado uiip tm

Obtenha uma única definição de campo personalizado. Identificar por --field-id, OU por --name + --object-type.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --field-id <uuid> — UUID do campo.
• --name <name> nome do campo. Usado junto com --object-type.
• --object-type <type> — tipo de objeto ao qual o campo pertence: Requirement, TestCase, TestSet. Usado junto com --name.

Exemplo

uip tm customfield get \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldDefinitionGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

Criação de campo personalizado do uip tm

Crie uma nova definição de campo personalizado. Forneça --object-type para um único escopo OU --scope-list para vários — os dois são mutuamente exclusivos e um é necessário.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --name <name> (necessário) — nome do campo.
• --data-type <type> (necessário) — Text ou Label.
• --object-type <type> — escopo único: Requirement, TestCase, TestSet. mutuamente exclusivo com --scope-list.
• --scope-list <types...> — escopo de vários objetos (separados por espaço): Requirement, TestCase, TestSet. mutuamente exclusivo com --object-type.
• --description <text> descrição do campo.
• --default-value <text> — valor padrão semeado em cada objeto existente do tipo do campo.
• --value-hints <text> — Texto de dica de interface gráfica mostrado ao lado do campo.

Exemplo

uip tm customfield create \
  --project-key DEMO \
  --name Priority \
  --data-type Text \
  --object-type TestCase \
  --description "Test priority" \
  --default-value Medium

Formato dos dados

{
  "Code": "CustomFieldDefinitionCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "Name": "Priority",
    "Description": "Test priority",
    "DefaultValue": "Medium",
    "ValueHints": "",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "ScopeList": ["TestCase"]
  }
}

---

atualização de campo personalizado do uip tm

Atualize uma definição de campo personalizado existente. Identificar por --field-id, OU por --name + --object-type. Os campos não especificados mantêm seus valores atuais.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --field-id <uuid> — UUID do campo.
• --name <name> — nome do campo (para pesquisa). Usado junto com --object-type.
• --object-type <type> — tipo de objeto ao qual o campo pertence. Usado junto com --name.
• --rename-to <name> novo nome para o campo.
• --description <text> nova descrição.
• --default-value <text> novo valor padrão.
• --value-hints <text> — novo texto de dica de interface gráfica.
• --scope-list <types...> — novo escopo para vários objetos (separado por espaço).

Exemplo

uip tm customfield update \
  --project-key DEMO \
  --field-id a1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to Severity

Formato dos dados

{
  "Code": "CustomFieldDefinitionUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

exclusão de campo personalizado uip tm

Exclua uma ou mais definições de campo personalizado. Identificar por --field-ids (um ou muitos UUIDs), OU por --name + --object-type (simples, por chave natural). Exclusão forçada sem cascata — as linhas de rótulo/valor órfãos não são limpas.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --field-ids <uuid...> — UUIDs de campos separados por espaços a excluir.
• --name <name> — nome do campo (usado com --object-type).
• --object-type <type> — tipo de objeto ao qual o campo pertence (usado com --name).
• -y, --yes — confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip tm customfield delete \
  --project-key DEMO \
  --field-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Formato dos dados

{
  "Code": "CustomFieldDefinitionsDelete",
  "Data": { "Passed": 1, "Failed": 0 }
}

Passed/Failed são contagens, não detalhes por ID — a resposta não retorna quais UUIDs falharam. UUIDs desconhecidos passados por meio de --field-ids são encaminhados para o endpoint em massa e contados como Failed em vez de rejeitados antecipadamente.

---

Comandos de rótulo

As linhas de rótulo carregam um objeto JSON por instância de objeto, mapeando o nome do campo personalizado para uma matriz de valores de string ({"Priority":["High"],"Tags":["smoke","critical"]}).

rótulo de campo personalizado uip tm obter

Obtenha uma linha de rótulo de campo personalizado por --label-id. Para pesquisar por objeto, use customfield label list --object-id <uuid> (retorna a mesma linha que uma matriz de um elemento).

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> (obrigatório) — tipo de objeto ao qual o rótulo pertence: Requirement, TestCase, TestSet.
• --label-id <uuid> necessário) — UUID da linha do rótulo (não o nome do rótulo).

Exemplo

uip tm customfield label get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id f1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-02T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

lista de rótulos de campos personalizados uip tm

Lista linhas de rótulo para um tipo de objeto, opcionalmente reduzida para um objeto específico.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto para o qual listar rótulos.
• --object-id <uuid> filtrar para um UUID de objeto específico.
• --filter <text> — pesquisar linhas de rótulo por valor.
• --sort-by <expr> classificar expressão.
• --limit <n> — tamanho da página. O padrão é 50.
• --offset <n> — resultados a ignorar. O padrão é 0.

Exemplo

uip tm customfield label list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldLabelsList",
  "Data": [
    {
      "Id": "f1b2c3d4-0000-0000-0000-000000000001",
      "ProjectId": "p1",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "Values": { "Priority": ["High"], "Tags": ["smoke", "critical"] },
      "Created": "2025-01-01T00:00:00Z",
      "CreatedBy": "[e-mail]",
      "Updated": "2025-01-02T00:00:00Z",
      "UpdatedBy": "[e-mail]"
    }
  ]
}

---

criação de rótulo personalizado do uip tm

Faça upsert dos valores do rótulo para um objeto. O back-end mescla quaisquer novas chaves de nome de campo em uma linha existente para o mesmo objeto — ele não substitui a linha inteira.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> exigido) — tipo de objeto ao qual anexar os rótulos.
• --object-id <uuid> necessário) — UUID do objeto a ser rotulado.
• --values <json> (obrigatório) — um campo de mapeamento de objeto JSON não vazio nomeia para matrizes de strings, por exemplo {"Priority":["High"],"Tags":["smoke","critical"]}. Uma matriz JSON, ou um valor que não é uma matriz de strings por chave, é rejeitado do lado do cliente.

Exemplo

uip tm customfield label create \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '{"Priority":["High"],"Tags":["smoke"]}'

Formato dos dados

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "Id": "f1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Values": { "Priority": ["High"], "Tags": ["smoke"] },
    "Created": "2025-01-01T00:00:00Z",
    "CreatedBy": "[e-mail]",
    "Updated": "2025-01-01T00:00:00Z",
    "UpdatedBy": "[e-mail]"
  }
}

---

adição de rótulo personalizado do uip tm

Adicione valores de rótulo a um campo personalizado nomeado em vários objetos em uma única chamada.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• ( --custom-field-name <name> ) — nome de uma definição de campo personalizado existente para esse tipo de objeto.
• --object-ids <uuid...> (necessário) — UUIDs de objetos separados por espaço para aplicar o rótulo.
• --values <value...> necessário) — valores de rótulo separados por espaço a adicionar.
• --replace-existing-values — substitua os valores existentes em vez de mesclar (padrão: mesclar).

Exemplo

uip tm customfield label add \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values High Critical

Formato dos dados

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Added"
  }
}

---

remover rótulo de campo personalizado do uip tm

Remova valores de rótulo de um campo personalizado nomeado em vários objetos. Esta é uma operação destrutiva — requer -y, --yes; a CLI nunca solicita.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --custom-field-name <name> necessário) — nome do campo personalizado.
• --object-ids <uuid...> (necessário) — UUIDs de objeto separados por espaço.
• --values <value...> — valores de rótulo separados por espaço a remover. Obrigatório, a menos que --remove-all-values esteja definido.
• --remove-all-values — limpe todos os valores para esse campo nos objetos listados. Mutualmente exclusivo com --values.
• -y, --yes — confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip tm customfield label remove \
  --project-key DEMO \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids id1 id2 \
  --values Critical \
  --yes

Formato dos dados

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "CustomFieldName": "Priority",
    "ObjectCount": 2,
    "Result": "Removed"
  }
}

---

Comandos de valor

As linhas de valor carregam um único valor do tipo Texto por objeto.

lista de valores de campo personalizado do uip tm

Lista valores de campos personalizados para um tipo de objeto. Os resultados estão vazios, a menos que --object-id seja fornecido.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --object-id <uuid> — o UUID do objeto com valores a serem listados. Obrigatório na prática — os resultados são vazios quando omitidos.
• --filter <text> — pesquise valores por conteúdo.
• --sort-by <expr> classificar expressão.
• --limit <n> — tamanho da página. O padrão é 50.
• --offset <n> — resultados a ignorar. O padrão é 0.

Exemplo

uip tm customfield value list \
  --project-key DEMO \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldValuesList",
  "Data": [
    {
      "Id": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjectType": "TestCase",
      "DataType": "Text",
      "Updated": "2025-01-02T00:00:00Z"
    }
  ]
}

---

obter o valor do campo personalizado uip tm

Obtenha uma única linha de valor do campo personalizado. Identificar por --value-id, OU por --name + --object-id.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> — UUID da linha de valor.
• --name <name> nome do campo. Usado junto com --object-id.
• --object-id <uuid> — UUID do objeto. Usado junto com --name.

Exemplo

uip tm customfield value get \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

criação de valor personalizado do uip tm

Crie uma linha de valor de campo personalizado em um objeto.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• ( --name <name> ) — nome do campo personalizado (deve corresponder a uma definição existente).
• --object-id <uuid> (exigido) — o UUID do objeto ao qual esse valor é anexado.
• --data-type <type> (necessário) — Text ou Label (deve corresponder à definição).
• --value <text> — conteúdo de valor. Opcional — omita para criar uma linha vazia.

Exemplo

uip tm customfield value create \
  --project-key DEMO \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type Text \
  --value High

Formato dos dados

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High",
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "DataType": "Text",
    "Updated": "2025-01-02T00:00:00Z"
  }
}

---

atualização do valor do campo personalizado uip tm

Atualize uma linha de valor de campo personalizado existente. Identificar por --value-id, OU por --name + --object-id. --value é necessário, a menos que --clear seja aprovado.

Observação:

Um --value vazio pode fazer com que a linha seja excluída em vez de atualizada quando seu nome de campo não mapear mais para uma definição. Passe --clear para reconhecer essa intenção.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> — UUID da linha de valor.
• --name <name> nome do campo. Usado junto com --object-id.
• --object-id <uuid> — UUID do objeto. Usado junto com --name.
• --data-type <type> — Text ou Label. O padrão é o tipo de dados atual da linha.
• --value <text> — o novo valor. Obrigatório a menos que --clear seja passado.
• --clear — confirme que um vazio --value pode excluir a linha.

Exemplo

uip tm customfield value update \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --value Critical

Formato dos dados

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Updated"
  }
}

---

exclusão do valor do campo personalizado uip tm

Exclui uma linha de valor de campo personalizado. Identificar por --value-id, OU por --name + --object-id.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> — UUID da linha de valor.
• --name <name> nome do campo. Usado junto com --object-id.
• --object-id <uuid> — UUID do objeto. Usado junto com --name.
• -y, --yes — confirme esta operação irreversível. Necessário — a CLI nunca solicita.

Exemplo

uip tm customfield value delete \
  --project-key DEMO \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Formato dos dados

{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "Id": "v1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

Relacionado

• requisitos — os requisitos podem carregar valores de campo personalizados.
• casos de teste — os casos de teste podem carregar valores de campo personalizados.

Veja também

• Visão geral do Test Manager