campo personalizado de uip tm

Sintaxis y opciones para `uip tm customfield`, que gestiona definiciones de campos personalizados, filas de etiquetas y filas de valores en un proyecto de Test Manager.

uip tm customfield gestiona las definiciones de campo personalizadas en un proyecto de Test Manager. Los campos personalizados amplían los requisitos, los casos de prueba y los conjuntos de pruebas con metadatos específicos del proyecto. Este grupo de comandos tiene tres subgrupos:

• customfield — gestionar la propia definición del campo (enumerar, obtener, crear, actualizar, eliminar)
• customfield label — gestionar filas de campo de tipo etiqueta (un mapa JSON de nombre de campo a uno o más valores de cadena, por objeto)
• customfield value — gestionar filas de campo de tipo texto (un único valor de string, por objeto)

Importante:

El identificador principal para las definiciones de campo es --field-id. Las filas de etiqueta y valor se identifican por --label-id / --value-id, o por la clave natural --object-type + --name + --object-id. El marcador --customfield-id no existe.

Sinopsis

# 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 los verbos respetan las opciones globales y los códigos de salida estándar. Cada verbo acepta --log-level <level> (predeterminado Information) y -t, --tenant <name> (predeterminado al tenant autenticado).

Nota:

-t, --tenant aquí hay una opción normal y visible.

--object-type (y --object-types/--scope-list donde variadic) solo acepta Requirement, TestCase o TestSet. --data-type (y --data-types) solo acepta Text o Label — no hay ningún tipo de datos String, Integer o Boolean.

---

Comandos de definición de campo

lista de campos personalizados de uip tm

Enumerar definiciones de campo personalizadas en un proyecto. --project-key es obligatorio; cualquier otro filtro es opcional.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-types <types...>: tipos de objetos separados por espacios por los que filtrar: Requirement, TestCase, TestSet.
• --data-types <types...>: tipos de datos separados por espacios para filtrar: Text, Label.
• --name <name> — coincidencia de nombre exacto (filtro del lado del cliente; devuelve una fila por tipo de objeto en el que se define el campo).
• --filter <text>: búsqueda de subcadenas del lado del servidor en los campos de definición.
• --sort-by <expr> — expresión de ordenación, por ejemplo name asc.
• --limit <n> — tamaño de la página. El valor predeterminado es 50.
• --offset <n> : resultados a omitir. El valor predeterminado es 0.

Ejemplo

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

Forma de datos

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

---

obtención de campo personalizado de uip tm

Obtenga una única definición de campo personalizada. Identificar por --field-id, O por --name + --object-type.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --field-id <uuid>: UUID de campo.
• --name <name> — nombre del campo. Se utiliza junto con --object-type.
• --object-type <type>: tipo de objeto al que pertenece el campo: Requirement, TestCase, TestSet. Se utiliza junto con --name.

Ejemplo

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

Forma de datos

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

---

creación de campo personalizado de uip tm

Cree una nueva definición de campo personalizada. Proporciona --object-type para un solo ámbito, O --scope-list para varios: los dos son mutuamente excluyentes y se requiere uno.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --name <name> (obligatorio) : nombre del campo.
• --data-type <type> (requerido) — Text o Label.
• --object-type <type> — ámbito único: Requirement, TestCase, TestSet. Mutuamente excluyente con --scope-list.
• --scope-list <types...>: ámbito de objetos múltiples (separados por espacios): Requirement, TestCase, TestSet. Mutuamente excluyente con --object-type.
• --description <text> — descripción del campo.
• --default-value <text>: valor predeterminado sembrado en cada objeto existente del tipo de campo.
• --value-hints <text> — Texto de sugerencia de IU que se muestra junto al campo.

Ejemplo

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

Forma de datos

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

---

actualización de campo personalizado de uip tm

Actualizar una definición de campo personalizado existente. Identificar por --field-id, O por --name + --object-type. Los campos no especificados mantienen sus valores actuales.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --field-id <uuid>: UUID de campo.
• --name <name> — nombre del campo (para búsqueda). Se utiliza junto con --object-type.
• --object-type <type>: tipo de objeto al que pertenece el campo. Se utiliza junto con --name.
• --rename-to <name> — nuevo nombre para el campo.
• --description <text> — nueva descripción.
• --default-value <text> — nuevo valor predeterminado.
• --value-hints <text> — nuevo texto de sugerencia de IU.
• --scope-list <types...> — nuevo ámbito de objetos múltiples (separados por espacios).

Ejemplo

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

Forma de datos

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

---

eliminación de campo personalizado de uip tm

Elimine una o más definiciones de campo personalizadas. Identificar por --field-ids (uno o varios UUID), O por --name + --object-type (único, por clave natural). Eliminación definitiva sin cascada: las filas de etiquetas/valores huérfanos no se limpian.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --field-ids <uuid...>: UUID de campos separados por espacios que se eliminarán.
• --name <name>: nombre del campo (utilizado --object-type con).
• --object-type <type> — tipo de objeto al que pertenece el campo (usado con --name).
• -y, --yes — confirma esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo

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

Forma de datos

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

Passed/Failed son recuentos, no detalles por ID: la respuesta no muestra qué UUID han fallado. Los UUID desconocidos pasados a través de --field-ids se reenvían al punto final masivo y se cuentan como Failed en lugar de rechazarse por adelantado.

---

Comandos de etiqueta

Las filas de etiquetas llevan un objeto JSON por instancia de objeto, asignando el nombre del campo personalizado a una matriz de valores de cadena ({"Priority":["High"],"Tags":["smoke","critical"]}).

Obtener etiqueta de campo personalizado de uip tm

Obtener una fila de etiqueta de campo personalizada antes del --label-id. Para buscar por objeto, utiliza customfield label list --object-id <uuid> (devuelve la misma fila que una matriz de un elemento).

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto al que pertenece la etiqueta: Requirement, TestCase, TestSet.
• --label-id <uuid> obligatorio) : UUID de la fila de la etiqueta (no el nombre de la etiqueta).

Ejemplo

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

Forma de datos

{
  "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 etiquetas de campo personalizado de uip tm

Enumerar filas de etiquetas para un tipo de objeto, opcionalmente reducido a un objeto específico.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> obligatorio) : tipo de objeto para el que enumerar etiquetas.
• --object-id <uuid> : filtrar a un UUID de objeto específico.
• --filter <text>: busca filas de etiquetas por valor.
• --sort-by <expr> — expresión de ordenación.
• --limit <n> — tamaño de la página. El valor predeterminado es 50.
• --offset <n> : resultados a omitir. El valor predeterminado es 0.

Ejemplo

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

Forma de datos

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

---

creación de etiqueta de campo personalizado de uip tm

Actualizar valores de etiqueta para un objeto. El backend fusiona cualquier nueva clave de nombre de campo en una fila existente para el mismo objeto; no reemplaza toda la fila.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> obligatorio) : tipo de objeto al que adjuntar las etiquetas.
• --object-id <uuid> obligatorio) : UUID del objeto a etiquetar.
• --values <json> (obligatorio) : un objeto JSON no vacío que asigna nombres de campo a matrices de cadenas, por ejemplo {"Priority":["High"],"Tags":["smoke","critical"]}. Una matriz JSON, o un valor que no es una matriz de cadenas por clave, se rechaza en el lado del cliente.

Ejemplo

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

Forma de datos

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

---

adición de etiqueta de campo personalizado de uip tm

Añade valores de etiqueta a un campo personalizado con nombre en varios objetos en una sola llamada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --custom-field-name <name> obligatorio) : nombre de una definición de campo personalizado existente para este tipo de objeto.
• --object-ids <uuid...> obligatorio) : UUID de objetos separados por espacios a los que aplicar la etiqueta.
• --values <value...> obligatorio) : valores de etiqueta separados por espacios para añadir.
• --replace-existing-values — reemplaza los valores existentes en lugar de fusionarlos (predeterminado: fusionar).

Ejemplo

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

Forma de datos

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

---

eliminación de etiqueta de campo personalizado de uip tm

Eliminar valores de etiqueta de un campo personalizado con nombre en varios objetos. Esta es una operación destructiva : requiere -y, --yes; la CLI nunca solicita.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --custom-field-name <name> obligatorio) : nombre del campo personalizado.
• --object-ids <uuid...> obligatorio) : UUID de objetos separados por espacios.
• --values <value...>: valores de etiqueta separados por espacios para eliminar. Obligatorio a menos que se establezca --remove-all-values.
• --remove-all-values: borra todos los valores de este campo en los objetos enumerados. Mutuamente exclusivo con --values.
• -y, --yes — confirma esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo

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

Forma de datos

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

---

Comandos de valor

Las filas de valor contienen un único valor de tipo Texto por objeto.

lista de valores de campo personalizado de uip tm

Enumerar valores de campo personalizados para un tipo de objeto. Los resultados están vacíos a menos que se proporcione --object-id.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --object-id <uuid>: UUID del objeto cuyos valores enumerar. Obligatorio en la práctica: los resultados están vacíos cuando se omite.
• --filter <text>: valores de búsqueda por contenido.
• --sort-by <expr> — expresión de ordenación.
• --limit <n> — tamaño de la página. El valor predeterminado es 50.
• --offset <n> : resultados a omitir. El valor predeterminado es 0.

Ejemplo

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

Forma de datos

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

---

Obtener valor de campo personalizado de uip tm

Obtener una única fila de valor de campo personalizado. Identificar por --value-id, O por --name + --object-id.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid>: UUID de fila de valor.
• --name <name> — nombre del campo. Se utiliza junto con --object-id.
• --object-id <uuid> : UUID del objeto. Se utiliza junto con --name.

Ejemplo

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

Forma de datos

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

---

creación de valor de campo personalizado de uip tm

Crea una fila de valor de campo personalizado en un objeto.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --name <name> obligatorio) : nombre del campo personalizado (debe coincidir con una definición existente).
• --object-id <uuid> obligatorio) : UUID del objeto al que se adjunta este valor.
• --data-type <type> (requerido) — Text o Label (debe coincidir con la definición).
• --value <text>: contenido de valor. Opcional: omitir para crear una fila vacía.

Ejemplo

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

Forma de datos

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

---

actualización del valor del campo personalizado de uip tm

Actualizar una fila de valor de campo personalizado existente. Identificar por --value-id, O por --name + --object-id. --value es obligatorio a menos que se pase --clear.

Nota:

Un --value vacío puede hacer que la fila se elimine en lugar de actualizarse cuando su nombre de campo ya no se asigna a una definición. Pasa --clear para reconocer esa intención.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid>: UUID de fila de valor.
• --name <name> — nombre del campo. Se utiliza junto con --object-id.
• --object-id <uuid> : UUID del objeto. Se utiliza junto con --name.
• --data-type <type> — Text o Label. El valor predeterminado es el tipo de datos actual de la fila.
• --value <text>: el nuevo valor. Obligatorio a menos que se pase --clear.
• --clear: reconoce que un --value vacío puede eliminar la fila.

Ejemplo

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

Forma de datos

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

---

eliminación de valor de campo personalizado de uip tm

Eliminar una fila de valor de campo personalizado. Identificar por --value-id, O por --name + --object-id.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid>: UUID de fila de valor.
• --name <name> — nombre del campo. Se utiliza junto con --object-id.
• --object-id <uuid> : UUID del objeto. Se utiliza junto con --name.
• -y, --yes — confirma esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo

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

Forma de datos

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

---

Relacionado

• requisitos : los requisitos pueden llevar valores de campo personalizados.
• casos de prueba : los casos de prueba pueden llevar valores de campo personalizados.

Ver también

• Descripción general de Test Manager