campo personalizado de uip tm

Sintaxis y opciones para `uip tm customfield`, que gestiona las definiciones de campo personalizadas, las etiquetas de visualización y los valores permitidos en un tenant de Test Manager.

uip tm customfield las definiciones de campo personalizadas en un tenant de Test Manager. Los campos personalizados amplían las entidades de casos de prueba y requisitos 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 las asignaciones de etiquetas aplicadas a los objetos
• customfield value — gestionar los valores permitidos para un campo

Importante:

El identificador principal para las definiciones de campo es --field-id. Etiquetar y valorar el ámbito de los comandos por --object-type combinado con --object-id, --label-id o --value-id. El marcador --customfield-id no existe en v1.196.

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 --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 definición de campo

lista de campos personalizados de uip tm

Enumerar definiciones de campo personalizadas en un proyecto. --project-key es obligatorio.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-types <types...> : tipos de objetos separados por espacios por los que filtrar.
• --data-types <types...> : tipos de datos separados por espacios por los que filtrar.
• --name <name> : filtrar por nombre de campo exacto.
• --filter <text> : búsqueda de texto libre.
• --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 list \
  --project-key DEMO \
  --object-types TestCase

Forma de datos

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

---

obtención de campo personalizado de uip tm

Obtenga una única definición de campo personalizada.

Opciones

• --object-type <type> obligatorio) : tipo de objeto al que pertenece el campo.
• --field-id <uuid> : UUID de campo. Mutuamente excluyente con --name.
• --name <name> — nombre del campo. Mutuamente excluyente con --field-id.

Ejemplo

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

Forma de datos

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

---

creación de campo personalizado de uip tm

Cree una nueva definición de campo personalizada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --name <name> (obligatorio) : nombre del campo.
• --object-type <type> (obligatorio) : tipo de objeto al que adjuntar el campo (por ejemplo, TestCase, TestSet).
• --data-type <type> (obligatorio) : tipo de datos del campo (por ejemplo, String, Integer, Boolean).
• --scope-list <list> — restricciones de ámbito para el campo.
• --description <text> — descripción del campo.
• --default-value <value> : valor predeterminado para nuevos objetos.
• --value-hints <hints> — sugerencias de valor permitidas o enumeración para el campo.

Ejemplo

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

Forma de datos

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

---

actualización de campo personalizado de uip tm

Actualizar una definición de campo personalizado existente.

Opciones

• --object-type <type> obligatorio) : tipo de objeto al que pertenece el campo.
• --field-id <uuid> : UUID de campo. Mutuamente excluyente con --name.
• --name <name> — nombre del campo (para búsqueda). Mutuamente excluyente con --field-id.
• --rename-to <name> — nuevo nombre para el campo.
• --description <text> — nueva descripción.
• --default-value <value> — nuevo valor predeterminado.
• --value-hints <hints> — nuevas sugerencias de valor permitidas.
• --scope-list <list> — nuevas restricciones de ámbito.

Ejemplo

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

Forma de datos

{
  "Code": "CustomFieldUpdate",
  "Data": {
    "FieldId": "c1b2c3d4-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.

Opciones

• --object-type <type> obligatorio) : tipo de objeto al que pertenecen los campos.
• --field-ids <uuid...> : UUID de campos separados por espacios que se eliminarán. Mutuamente excluyente con --name.
• --name <name> — nombre del campo a eliminar. Mutuamente excluyente con --field-ids.
• -y, --yes : omite la solicitud de confirmación.

Ejemplo

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

Forma de datos

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

---

Comandos de etiqueta

Obtener etiqueta de campo personalizado de uip tm

Obtener una única asignación de etiqueta por su UUID.

Opciones

• --object-type <type> obligatorio) : tipo de objeto al que pertenece la etiqueta.
• --label-id <uuid> obligatorio) : UUID de la asignación de etiquetas (no el nombre de la etiqueta).

Ejemplo

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

Forma de datos

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

---

lista de etiquetas de campo personalizado de uip tm

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

Opciones

• --object-type <type> obligatorio) : tipo de objeto para el que enumerar etiquetas.
• --object-id <uuid> : filtrar a un UUID de objeto específico.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos

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

---

creación de etiqueta de campo personalizado de uip tm

Crear una nueva etiqueta en un objeto.

Opciones

• --object-type <type> obligatorio) : tipo de objeto al que adjuntar la etiqueta.
• --object-id <uuid> obligatorio) : UUID del objeto a etiquetar.
• --values <json> obligatorio) : matriz JSON de valores de etiqueta a aplicar.

Ejemplo

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

Forma de datos

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

---

adición de etiqueta de campo personalizado de uip tm

Añada valores de etiqueta a uno o más objetos para un campo personalizado con nombre.

Opciones

• --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 a los que aplicar la etiqueta.
• --values <values...> obligatorio) : valores de etiqueta separados por espacios para añadir.

Ejemplo

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

Forma de datos

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

---

eliminación de etiqueta de campo personalizado de uip tm

Elimine los valores de etiqueta de uno o más objetos para un campo personalizado con nombre.

Opciones

• --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 <values...> : valores de etiqueta separados por espacios para eliminar.
• --remove-all-values — elimina todos los valores de etiqueta para este campo de los objetos especificados. Mutuamente excluyente con --values.

Ejemplo

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

Forma de datos

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

---

Comandos de valor

lista de valores de campo personalizado de uip tm

Enumerar valores de campo personalizados para un tipo de objeto, opcionalmente reducidos a un objeto específico.

Opciones

• --object-type <type> (obligatorio) : tipo de objeto.
• --object-id <uuid> : filtrar a un UUID de objeto específico.
• --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 \
  --object-type TestCase \
  --object-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos

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

---

Obtener valor de campo personalizado de uip tm

Obtenga un único valor de campo personalizado.

Opciones

• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid> : valor UUID. Mutuamente exclusivo con --name + --object-id.
• --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 \
  --object-type TestCase \
  --value-id v1b2c3d4-0000-0000-0000-000000000001

Forma de datos

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

---

creación de valor de campo personalizado de uip tm

Establece un valor de campo personalizado en un objeto.

Opciones

• --object-type <type> (obligatorio) : tipo de objeto.
• --name <name> (obligatorio) : nombre del campo personalizado.
• --object-id <uuid> requerido) — UUID del objeto.
• --data-type <type> (obligatorio) : tipo de datos del valor (por ejemplo, String, Integer).
• --value <value> obligatorio) : el valor a establecer.

Ejemplo

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

Forma de datos

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

---

actualización del valor del campo personalizado de uip tm

Actualizar un valor de campo personalizado existente.

Opciones

• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid> : valor UUID. Mutuamente exclusivo con --name + --object-id.
• --name <name> — nombre del campo. Se utiliza junto con --object-id.
• --object-id <uuid> : UUID del objeto. Se utiliza junto con --name.
• --value <value> (obligatorio) : el nuevo valor.
• --clear : borra el valor en lugar de establecerlo.

Ejemplo

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

Forma de datos

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

---

eliminación de valor de campo personalizado de uip tm

Eliminar un valor de campo personalizado.

Opciones

• --object-type <type> (obligatorio) : tipo de objeto.
• --value-id <uuid> : valor UUID. Mutuamente exclusivo con --name + --object-id.
• --name <name> — nombre del campo. Se utiliza junto con --object-id.
• --object-id <uuid> : UUID del objeto. Se utiliza junto con --name.
• -y, --yes : omite la solicitud de confirmación.

Ejemplo

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

Forma de datos

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