campo personalizado uip tm

Sintaxe e opções para "uip tm customfield", que gerencia definições de campos personalizados, rótulos de exibição e valores permitidos em um tenant do Test Manager.

uip tm customfield gerencia definições de campos personalizados em um tenant do Test Manager. Os campos personalizados estendem entidades de caso de teste e requisito 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 as atribuições de rótulos aplicadas a objetos
• — customfield value os valores permitidos para um campo

Importante:

O identificador principal para definições de campo é --field-id. Rótulo e valorize o escopo de comandos por --object-type combinado com --object-id, --label-id ou --value-id. O sinalizador --customfield-id não existe na v1.196.

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 --object-type <type> (--field-id <uuid> | --name <name>)
uip tm customfield create --project-key <key> --name <name> --object-type <type> --data-type <type> [--scope-list <list>] [--description <text>] [--default-value <value>] [--value-hints <hints>]
uip tm customfield update --object-type <type> (--field-id <uuid> | --name <name>) [--rename-to <name>] [--description <text>] [--default-value <value>] [--value-hints <hints>] [--scope-list <list>]
uip tm customfield delete --object-type <type> (--field-ids <uuid...> | --name <name>) [-y]

# Labels
uip tm customfield label get --object-type <type> --label-id <uuid>
uip tm customfield label list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield label create --object-type <type> --object-id <uuid> --values <json>
uip tm customfield label add --object-type <type> --custom-field-name <name> --object-ids <uuid...> --values <values...>
uip tm customfield label remove --object-type <type> --custom-field-name <name> --object-ids <uuid...> (--values <values...> | --remove-all-values)

# Values
uip tm customfield value list --object-type <type> [--object-id <uuid>] [--limit <n>] [--offset <n>]
uip tm customfield value get --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>)
uip tm customfield value create --object-type <type> --name <name> --object-id <uuid> --data-type <type> --value <value>
uip tm customfield value update --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) --value <value> [--clear]
uip tm customfield value delete --object-type <type> (--value-id <uuid> | --name <name> --object-id <uuid>) [-y]

All verbs honor the global options and the standard exit codes. Every verb accepts --log-level <level> (default Information).

---

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.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --object-types <types...> tipos de objetos separados por espaço para usar para filtrar.
• --data-types <types...> tipos de dados separados por espaço para filtrar.
• --name <name> — filtrar pelo nome de campo exato.
• --filter <text> pesquisa de texto livre.
• --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 list \
  --project-key DEMO \
  --object-types TestCase

Formato dos dados

{
  "Code": "CustomFieldList",
  "Data": [
    {
      "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "ObjectType": "TestCase",
      "DataType": "String"
    }
  ]
}

---

Obtenção de campo personalizado uiip tm

Obtenha uma única definição de campo personalizado.

Opções

• --object-type <type> exigido) — tipo de objeto ao qual o campo pertence.
• --field-id <uuid> — UUID do campo. Mutualmente exclusivo com --name.
• --name <name> nome do campo. Mutualmente exclusivo com --field-id.

Exemplo

uip tm customfield get \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldGet",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

Criação de campo personalizado do uip tm

Crie uma nova definição de campo personalizado.

Opções

• --project-key <key> (necessário) — possuindo projeto.
• --name <name> (necessário) — nome do campo.
• --object-type <type> (necessário) — tipo de objeto ao qual anexar o campo (por exemplo, TestCase, TestSet).
• --data-type <type> (necessário) — tipo de dados do campo (por exemplo, String, Integer, Boolean).
• --scope-list <list> restrições de escopo para o campo.
• --description <text> descrição do campo.
• --default-value <value> valor padrão para novos objetos.
• --value-hints <hints> dicas de valor permitidas ou enumeração para o campo.

Exemplo

uip tm customfield create \
  --project-key DEMO \
  --name "Priority" \
  --object-type TestCase \
  --data-type String \
  --value-hints "Low,Medium,High"

Formato dos dados

{
  "Code": "CustomFieldCreate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "ObjectType": "TestCase",
    "DataType": "String"
  }
}

---

atualização de campo personalizado do uip tm

Atualize uma definição de campo personalizado existente.

Opções

• --object-type <type> exigido) — tipo de objeto ao qual o campo pertence.
• --field-id <uuid> — UUID do campo. Mutualmente exclusivo com --name.
• --name <name> nome do campo (para pesquisa). Mutualmente exclusivo com --field-id.
• --rename-to <name> novo nome para o campo.
• --description <text> nova descrição.
• --default-value <value> novo valor padrão.
• --value-hints <hints> novas dicas de valor permitidos.
• --scope-list <list> novas restrições de escopo.

Exemplo

uip tm customfield update \
  --object-type TestCase \
  --field-id c1b2c3d4-0000-0000-0000-000000000001 \
  --rename-to "Severity"

Formato dos dados

{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Severity",
    "Result": "Updated"
  }
}

---

exclusão de campo personalizado uip tm

Exclua uma ou mais definições de campo personalizado.

Opções

• --object-type <type> exigido) — tipo de objeto ao qual os campos pertencem.
• --field-ids <uuid...> — UUIDs de campos separados por espaços a excluir. Mutualmente exclusivo com --name.
• --name <name> — nome do campo a excluir. Mutualmente exclusivo com --field-ids.
• -y, --yes ignore o prompt de confirmação.

Exemplo

uip tm customfield delete \
  --object-type TestCase \
  --field-ids c1b2c3d4-0000-0000-0000-000000000001 \
  --yes

Formato dos dados

{
  "Code": "CustomFieldDelete",
  "Data": {
    "FieldId": "c1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Deleted"
  }
}

---

Comandos de rótulo

rótulo de campo personalizado uip tm obter

Obter uma única atribuição de rótulo por seu UUID.

Opções

• --object-type <type> obrigatório) — tipo de objeto ao qual o rótulo pertence.
• --label-id <uuid> necessário) — UUID da atribuição do rótulo (não o nome do rótulo).

Exemplo

uip tm customfield label get \
  --object-type TestCase \
  --label-id l1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldLabelGet",
  "Data": {
    "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Label": "Priority"
  }
}

---

lista de rótulos de campos personalizados uip tm

Lista atribuições de rótulos para um tipo de objeto, opcionalmente restrita a um objeto específico.

Opções

• --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.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldLabelList",
  "Data": [
    {
      "LabelId": "l1b2c3d4-0000-0000-0000-000000000001",
      "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Label": "Priority"
    }
  ]
}

---

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

Crie um novo rótulo em um objeto.

Opções

• --object-type <type> exigido) — tipo de objeto ao qual anexar o rótulo.
• --object-id <uuid> necessário) — UUID do objeto a ser rotulado.
• --values <json> (necessário) — Matriz JSON de valores de rótulo a serem aplicados.

Exemplo

uip tm customfield label create \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --values '[{"name":"Priority","value":"High"}]'

Formato dos dados

{
  "Code": "CustomFieldLabelCreate",
  "Data": {
    "ObjectId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Result": "Created"
  }
}

---

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

Adicione valores de rótulo a um ou mais objetos para um campo personalizado nomeado.

Opções

• --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 objetos separados por espaço para aplicar o rótulo.
• --values <values...> necessário) — valores de rótulo separados por espaço a adicionar.

Exemplo

uip tm customfield label add \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

Formato dos dados

{
  "Code": "CustomFieldLabelAdd",
  "Data": {
    "Result": "Added"
  }
}

---

remover rótulo de campo personalizado do uip tm

Remova valores de rótulo de um ou mais objetos para um campo personalizado nomeado.

Opções

• --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 <values...> valores de rótulo separados por espaço a remover.
• --remove-all-values remova todos os valores de rótulo para este campo dos objetos especificados. Mutualmente exclusivo com --values.

Exemplo

uip tm customfield label remove \
  --object-type TestCase \
  --custom-field-name Priority \
  --object-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --values High

Formato dos dados

{
  "Code": "CustomFieldLabelRemove",
  "Data": {
    "Result": "Removed"
  }
}

---

Comandos de valor

lista de valores de campo personalizado do uip tm

Listar valores de campos personalizados para um tipo de objeto, opcionalmente restrito a um objeto específico.

Opções

• --object-type <type> necessário) — tipo de objeto.
• --object-id <uuid> filtrar para um UUID de objeto específico.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldValueList",
  "Data": [
    {
      "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Priority",
      "Value": "High"
    }
  ]
}

---

obter o valor do campo personalizado uip tm

Obtenha um único valor de campo personalizado.

Opções

• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> UUID do valor. mutuamente exclusivo com --name + --object-id.
• --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 \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

Formato dos dados

{
  "Code": "CustomFieldValueGet",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

criação de valor personalizado do uip tm

Definir um valor de campo personalizado em um objeto.

Opções

• --object-type <type> necessário) — tipo de objeto.
• --name <name> necessário) — nome do campo personalizado.
• --object-id <uuid> (necessário) — UUID do objeto.
• --data-type <type> (necessário) — tipo de dados do valor (por exemplo, String, Integer).
• --value <value> necessário) — o valor a definir.

Exemplo

uip tm customfield value create \
  --object-type TestCase \
  --name Priority \
  --object-id a1b2c3d4-0000-0000-0000-000000000001 \
  --data-type String \
  --value High

Formato dos dados

{
  "Code": "CustomFieldValueCreate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Priority",
    "Value": "High"
  }
}

---

atualização do valor do campo personalizado uip tm

Atualize um valor de campo personalizado existente.

Opções

• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> UUID do valor. mutuamente exclusivo com --name + --object-id.
• --name <name> nome do campo. Usado junto com --object-id.
• --object-id <uuid> — UUID do objeto. Usado junto com --name.
• --value <value> necessário) — o novo valor.
• --clear limpe o valor em vez de defini-lo.

Exemplo

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

Formato dos dados

{
  "Code": "CustomFieldValueUpdate",
  "Data": {
    "ValueId": "v1b2c3d4-0000-0000-0000-000000000001",
    "Value": "Critical",
    "Result": "Updated"
  }
}

---

exclusão do valor do campo personalizado uip tm

Excluir um valor de campo personalizado.

Opções

• --object-type <type> necessário) — tipo de objeto.
• --value-id <uuid> UUID do valor. mutuamente exclusivo com --name + --object-id.
• --name <name> nome do campo. Usado junto com --object-id.
• --object-id <uuid> — UUID do objeto. Usado junto com --name.
• -y, --yes ignore o prompt de confirmação.

Exemplo

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

Formato dos dados

{
  "Code": "CustomFieldValueDelete",
  "Data": {
    "ValueId": "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