Requisitos de uip tm

Sintaxis y opciones para `requisitos de uip tm`, que gestiona los requisitos dentro de un proyecto de Test Manager: crear, leer, actualizar, eliminar, exportar y vincular a casos de prueba.

uip tm requirements gestiona los requisitos dentro de un proyecto de Test Manager. Los requisitos son la capa de trazabilidad: expresan lo que debe hacer el sistema, y cada requisito puede vincularse a uno o más casos de prueba para mostrar la cobertura. Puedes crear requisitos manualmente o sincronizarlos desde un conector externo de gestión del ciclo de vida de la aplicación (ALM) (por ejemplo, Jira) si está configurado en Test Manager.

Sinopsis

uip tm requirements list --project-key <key> [--filter <text>] [--requirement-ids <ids...>] [--labels <labels...>] [--updated-by <userId>] [--test-case-id <uuid>] [--changed-since <datetime>] [--sort-by <expr>] [--limit <n>] [--offset <n>]
uip tm requirements get --project-key <key> (--requirement-id <uuid> | --requirement-key <key>)
uip tm requirements create --project-key <key> --name <name> [--description <text>] [--container-id <uuid>] [--external-reference <ref>] [--connector-requirement-uuid <uuid>]
uip tm requirements update --project-key <key> --requirement-id <uuid> [--name <name>] [--description <text>]
uip tm requirements delete --project-key <key> --requirement-ids <uuid...> -y
uip tm requirements export --project-key <key> --output-file <path> [--requirement-ids <uuid...>] [--updated-by <userId>] [--test-case-id <uuid>] [--labels <label...>] [--filter <text>] [--sort-by <expr>]
uip tm requirements list-testcase-ids --project-key <key> --requirement-id <uuid>
uip tm requirements testcases --project-key <key> --requirement-id <uuid> (--add-testcase-ids <uuid...> | --remove-testcase-ids <uuid...>)
uip tm requirements list-by-test-execution --project-key <key> --execution-id <uuid> [--labels <label...>] [--updated-by <userId>] [--filter <text>] [--sort-by <expr>] [--limit <n>] [--offset <n>]

Todos los verbos respetan las opciones globales y los códigos de salida estándar. Cada verbo acepta --log-level <level> (predeterminado Information).

lista de requisitos de uip tm

Enumerar los requisitos en un proyecto con filtrado enriquecido del lado del servidor. CLI elige el punto final de backend más específico en función de los marcadores de filtro proporcionados: un filtro solo de etiqueta utiliza una ruta rápida; combinar etiquetas con otros filtros utiliza el punto final de filtro enriquecido.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto a lista.
--filter <text>	Buscar requisitos por nombre o clave.
--requirement-ids <uuid...>	UUID separados por espacios que se incluirán. Enruta a través del punto final de filtro enriquecido.
--labels <labels...>	Nombres de etiquetas separados por espacios por los que filtrar. Cuando se proporciona solo, utiliza una ruta rápida solo de etiqueta.
--updated-by <userId>	Filtrar por el ID de usuario que actualizó el requisito por última vez.
--test-case-id <uuid>	Devolver solo los requisitos vinculados a este UUID de caso de prueba.
--changed-since <datetime>	Requisitos de devolución modificados después de esta marca de tiempo ISO-8601.
--sort-by <expr>	Expresión de ordenación (nombre del campo, opcionalmente con el sufijo :asc o :desc).
--limit <n>	Tamaño de la página. El valor predeterminado es 50.
--offset <n>	Resultados para omitir. El valor predeterminado es 0.

Ejemplo

uip tm requirements list \
  --project-key DEMO \
  --labels "high-priority" \
  --limit 20

Forma de datos

{
  "Code": "RequirementsList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "ObjKey": "DEMO:1",
      "ProjectId": "00000000-0000-0000-0000-000000000abc",
      "Name": "User must be able to log in",
      "Description": "Login with valid credentials succeeds",
      "ContainerId": "c1c2c3c4-0000-0000-0000-000000000001",
      "ConnectorRequirementId": "ext-req-42",
      "ForeignReference": "JIRA-100",
      "CustomFieldLabels": { "Tags": ["smoke", "auth"] },
      "CustomFieldValues": { "Owner": "qa-team" },
      "Created": "2025-04-15T10:30:00Z",
      "CreatedBy": "11111111-2222-3333-4444-555555555555",
      "Updated": "2025-04-15T10:30:00Z",
      "UpdatedBy": "11111111-2222-3333-4444-555555555555"
    }
  ]
}

Campos clave: ObjKey: utilizar en --requirement-key en get. Id: uso en --requirement-id en get, update, delete, list-testcase-ids y testcases. ForeignReference: establecido a través de --external-reference en create.

Obtener requisitos de uip tm

Obtener un único requisito por su UUID interno o su clave PROJECT:N. Pasa --requirement-id o --requirement-key: son mutuamente excluyentes.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--requirement-id <uuid>	UUID de requisito interno. Mutuamente exclusivo con --requirement-key.
--requirement-key <key>	Clave de requisito (por ejemplo, DEMO:1). Mutuamente exclusivo con --requirement-id.

Ejemplo

uip tm requirements get \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos

{
  "Code": "RequirementGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjKey": "DEMO:1",
    "Name": "User must be able to log in",
    "Description": "Login with valid credentials succeeds",
    "ForeignReference": "JIRA-100"
  }
}

creación de requisitos de uip tm

Crear un nuevo requisito en un proyecto.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--name <name>	Obligatorio. Nombre del requisito.
--description <text>	Descripción de forma libre. El valor predeterminado es vacío.
--container-id <uuid>	UUID del contenedor en el que colocar el requisito (opcionalmente).
--external-reference <ref>	Referencia del sistema externo (por ejemplo, un ID de ticket de Jira).
--connector-requirement-uuid <uuid>	UUID de un sistema de requisitos externo conectado. Debe ser un UUID válido.

Ejemplo

uip tm requirements create \
  --project-key DEMO \
  --name "User must be able to log in" \
  --external-reference "JIRA-123"

Forma de datos

{
  "Code": "RequirementCreate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "ObjKey": "DEMO:1",
    "Name": "User must be able to log in",
    "ForeignReference": "JIRA-100"
  }
}

actualización de requisitos de uip tm

Actualizar un requisito existente. Se debe proporcionar al menos uno de estos campos.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--requirement-id <uuid>	Obligatorio. UUID interno del requisito a actualizar.
--name <name>	Nuevo nombre.
--description <text>	Nueva descripción.

Ejemplo

uip tm requirements update \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --name "User must be able to log in with MFA"

Forma de datos

{
  "Code": "RequirementUpdate",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "User must be able to log in with MFA",
    "Result": "Updated"
  }
}

eliminación de requisitos de uip tm

Elimine uno o más requisitos. Se requiere -y/--yes: la CLI nunca solicita de forma interactiva. Un solo UUID y varios UUID se enrutan a través del mismo punto final masivo.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--requirement-ids <uuid...>	Obligatorio. UUID de requisito que se eliminarán (separados por espacios).
-y, --yes	Obligatorio. Confirme esta operación irreversible.

Ejemplos

# Delete a single requirement
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 \
  --yes

# Delete multiple requirements in one call
uip tm requirements delete \
  --project-key DEMO \
  --requirement-ids a1b2c3d4-0000-0000-0000-000000000001 b2c3d4e5-0000-0000-0000-000000000001 \
  --yes

Forma de datos

{
  "Code": "RequirementDelete",
  "Data": { "Passed": 2, "Failed": 0 }
}

exportación de requisitos de uip tm

Exportar requisitos a un archivo .xlsx. Admite los mismos marcadores de filtro que requirements list.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--output-file <path>	Obligatorio. Ruta para escribir el archivo de exportación.
--requirement-ids <uuid...>	Filtrar por UUID de requisito.
--updated-by <userId>	Filtrar por el ID de usuario que actualizó el requisito por última vez.
--test-case-id <uuid>	Filtrar por UUID de caso de prueba vinculado.
--labels <label...>	Filtrar por etiquetas.
--filter <text>	Buscar por nombre o clave.
--sort-by <expr>	Ordenar resultados.

Ejemplo

uip tm requirements export \
  --project-key DEMO \
  --output-file ./requirements-export.xlsx

Forma de datos

{
  "Code": "RequirementExport",
  "Data": { "OutputFile": "./requirements-export.xlsx", "Bytes": 1024, "Result": "Exported" }
}

requisitos de uip tm lista-id-de-caso-de-prueba

Enumera los UUID de los casos de prueba vinculados a un requisito.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--requirement-id <uuid>	Obligatorio. UUID interno del requisito.

Ejemplo

uip tm requirements list-testcase-ids \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001

Forma de datos

{
  "Code": "RequirementTestCaseIdsList",
  "Data": { "TestCaseIds": ["b2c3d4e5-0000-0000-0000-000000000001", "c3d4e5f6-0000-0000-0000-000000000001"] }
}

Casos de prueba de requisitos de uip tm

Añada o elimine enlaces de casos de prueba en un requisito. Pasa --add-testcase-ids o --remove-testcase-ids (no ambos en la misma llamada).

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--requirement-id <uuid>	Obligatorio. Requisito para modificar.
--add-testcase-ids <uuid...>	UUID de casos de prueba separados por espacios para vincular.
--remove-testcase-ids <uuid...>	UUID de casos de prueba separados por espacios para desvincular.

Ejemplos

# link test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --add-testcase-ids b2c3d4e5-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001

# unlink test cases
uip tm requirements testcases \
  --project-key DEMO \
  --requirement-id a1b2c3d4-0000-0000-0000-000000000001 \
  --remove-testcase-ids b2c3d4e5-0000-0000-0000-000000000001

Forma de datos: adjuntar

{ "Code": "RequirementAssignTestCases", "Data": { "Id": "a1b2c3d4-...", "Assigned": 2, "Result": "Assigned" } }

Forma de datos: separar

{ "Code": "RequirementUnassignTestCases", "Data": { "Id": "a1b2c3d4-...", "Unassigned": 1, "Result": "Unassigned" } }

requisitos de uip tm lista por ejecución de prueba

Enumerar los requisitos cubiertos por una ejecución de prueba específica. Devuelve los requisitos cuyos casos de prueba vinculados se incluyeron en esa ejecución.

Argumentos

Nada.

Opciones

Marca	Descripción
--project-key <key>	Obligatorio. Proyecto propietario.
--execution-id <uuid>	Obligatorio. UUID de ejecución de prueba.
--labels <label...>	Filtrar por nombres de etiqueta (separados por espacios).
--updated-by <userId>	Filtrar por el ID de usuario que actualizó el requisito por última vez.
--filter <text>	Buscar requisitos por nombre o clave.
--sort-by <expr>	Expresión de ordenación (nombre del campo, opcionalmente con el sufijo :asc o :desc).
--limit <n>	Tamaño de la página. El valor predeterminado es 50.
--offset <n>	Resultados para omitir. El valor predeterminado es 0.

Ejemplo

uip tm requirements list-by-test-execution \
  --project-key DEMO \
  --execution-id b2c3d4e5-0000-0000-0000-000000000001

Forma de datos

{
  "Code": "RequirementsListByTestExecution",
  "Data": [{ "Id": "a1b2c3d4-0000-0000-0000-000000000001", "ObjKey": "DEMO:1", "Name": "User must be able to log in" }]
}

Relacionado

• proyecto : propietario del ámbito del proyecto.
• casos de prueba : casos de prueba que se pueden vincular a los requisitos.
• ejecuciones — origen de las --execution-id utilizadas por list-by-test-execution.

Ver también

• Descripción general de Test Manager