etiqueta de objeto de uip tm

Sintaxis y opciones para `uip tm objectlabel`, que gestiona las etiquetas adjuntas a los objetos de Test Manager, como casos de prueba y requisitos.

uip tm objectlabel gestiona las etiquetas adjuntas a los objetos de Test Manager (requisitos, casos de prueba, conjuntos de pruebas, ejecuciones de prueba y registros de casos de prueba). Las etiquetas son cadenas de forma libre que se utilizan para etiquetar y agrupar objetos para filtrar y buscar.

Importante:

--project-key y --object-type son necesarios en todos los verbos de este grupo, incluido get. --object-ids y --labels están en plural y separados por espacios; las formas singulares --object-id y --label no existen.

Sinopsis

uip tm objectlabel list --project-key <key> --object-type <type> [--object-ids <uuid...>] [--label-types <types...>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm objectlabel get --project-key <key> --object-type <type> --label-id <uuid>
uip tm objectlabel add --project-key <key> --object-type <type> --object-ids <uuid...> --labels <name...> [--label-type <type>] [--remove-other-labels]
uip tm objectlabel remove --project-key <key> --object-type <type> --object-ids <uuid...> (--labels <name...> | --remove-all-labels) [-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).

--object-type acepta Requirement, TestCase, TestSet, TestExecution o TestCaseLog. --label-type/--label-types acepta los valores de formulario de conexión userLabel, systemLabel, internalLabel, no los formularios de PascalCase utilizados en otras partes de esta CLI.

lista de etiquetas de objetos de uip tm

Enumerar los distintos nombres de etiquetas en uso para un tipo de objeto (paginado). Esto no devuelve filas de asignación de etiquetas: utiliza get para el detalle de una sola fila.

Argumentos

Nada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> obligatorio) : tipo de objeto para el que enumerar etiquetas.
• --object-ids <uuid...> — restringir a las etiquetas asignadas a estos objetos (separados por espacios). Omita la búsqueda en todo el tipo de objeto.
• --label-types <type...>: filtrar por tipos de etiquetas (userLabel, systemLabel, internalLabel, separados por espacios). El valor predeterminado es userLabel + systemLabel.
• --filter <text>: prefijo con el que hacer coincidir los nombres de las etiquetas (StartsWith del lado del servidor, no una búsqueda general de subcadena).
• --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 objectlabel list \
  --project-key DEMO \
  --object-type TestCase \
  --filter smo \
  --limit 50

Forma de datos

{
  "Code": "ObjectLabelsList",
  "Data": [
    { "Name": "smoke" },
    { "Name": "smoke-test" }
  ]
}

Cada fila es solo { "Name": "<label>" }: list no devuelve Id, ObjectId o LabelType. Para obtener los detalles completos de una fila de asignación específica (incluido su Id), utiliza objectlabel get.

obtención de etiqueta de objeto de uip tm

Obtener una sola fila de asignación de etiquetas por su UUID de asignación.

Argumentos

Nada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> obligatorio) : tipo de objeto al que pertenece la etiqueta.
• --label-id <uuid> obligatorio) : UUID de la fila de asignación de etiquetas. Este es el UUID del registro de asignación, no un nombre de etiqueta.

Ejemplo

uip tm objectlabel get \
  --project-key DEMO \
  --object-type TestCase \
  --label-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos

{
  "Code": "ObjectLabelGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ProjectId": "p1",
    "ObjectId": "f9e8d7c6-0000-0000-0000-000000000001",
    "ObjectType": "TestCase",
    "Name": "smoke",
    "Description": "",
    "LabelType": "UserLabel"
  }
}

LabelType en esta respuesta es PascalCase (UserLabel, SystemLabel, InternalLabel) aunque los marcadores de entrada --label-type/--label-types toman la forma de conexión de camelCase.

añadir etiqueta de objeto de uip tm

Añade etiquetas a uno o más objetos. Dos comportamientos distintos dependiendo de si se pasa --label-type:

• Sin --label-type (predeterminado): una sola llamada de adición masiva en todos los objetos y etiquetas. Introduce --remove-other-labels para convertirlo en un conjunto autorizado: después de añadir, se elimina cualquier etiqueta que no sea del sistema en estos objetos que no esté en --labels .
• Con --label-type: cada etiqueta se asigna individualmente (en bucle cada par de objeto × etiqueta), por lo que se puede grabar un tipo de etiqueta específico. --remove-other-labels se ignora en este modo.

Argumentos

Nada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --object-ids <uuid...> obligatorio) : UUID de objetos separados por espacios a los que aplicar las etiquetas.
• --labels <name...> obligatorio) : nombres de etiquetas separados por espacios para añadir.
• --label-type <type>: tipo de etiqueta (userLabel, systemLabel, internalLabel). Cuando se establece, cambia a la ruta de asignación por par descrita anteriormente.
• --remove-other-labels: después de añadir, elimina cualquier etiqueta que no sea del sistema en estos objetos que no esté presente en --labels. Se ignora cuando se establece --label-type.

Ejemplos

# Bulk add — multiple labels to multiple objects in one call
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke regression

# With a specific label type — assigns each label individually
uip tm objectlabel add \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels smoke \
  --label-type systemLabel

Forma de datos

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 2,
    "Result": "Added"
  }
}

Cuando se pasa --label-type, la respuesta lo incluye:

{
  "Code": "ObjectLabelsAdd",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "LabelType": "systemLabel",
    "Result": "Added"
  }
}

eliminación de etiqueta de objeto de uip tm

Eliminar etiquetas de uno o más objetos. Esta es una operación destructiva : requiere -y, --yes; la CLI nunca solicita. Proporciona --labels para eliminar etiquetas específicas, o --remove-all-labels para borrar todas las etiquetas que no sean del sistema de los objetos especificados; ambas se excluyen mutuamente.

Argumentos

Nada.

Opciones

• --project-key <key> (obligatorio) : proyecto propietario.
• --object-type <type> (obligatorio) : tipo de objeto.
• --object-ids <uuid...> obligatorio) : UUID de objetos separados por espacios.
• --labels <name...> — nombres de etiquetas separados por espacios para eliminar. Obligatorio a menos que se establezca --remove-all-labels.
• --remove-all-labels: borra todas las etiquetas que no sean del sistema en los objetos enumerados. Mutuamente exclusivo con --labels.
• -y, --yes — confirma esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplos

# remove specific labels
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --labels regression \
  --yes

# clear every non-system label
uip tm objectlabel remove \
  --project-key DEMO \
  --object-type TestCase \
  --object-ids id1 id2 \
  --remove-all-labels \
  --yes

Forma de datos

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "LabelCount": 1,
    "Result": "Removed"
  }
}

Con --remove-all-labels, la respuesta informa RemoveAllLabels en lugar de LabelCount, y Result es AllRemoved:

{
  "Code": "ObjectLabelsRemove",
  "Data": {
    "ObjectCount": 2,
    "RemoveAllLabels": true,
    "Result": "AllRemoved"
  }
}

Relacionado

• requisitos : los requisitos pueden llevar etiquetas de objetos.
• customfield — un mecanismo de etiqueta independiente (customfield label) para valores de campo personalizados de tipo Etiqueta; distinta de las etiquetas de forma libre de objectlabel.

Ver también

• Descripción general de Test Manager