requisitos do uip tm

Sintaxe e opções para "uip tm requirements", que gerencia requisitos dentro de um projeto do Test Manager: criar, ler, atualizar, excluir, exportar e vincular para casos de teste.

uip tm requirements gerencia requisitos dentro de um projeto do Test Manager. Os requisitos são a camada de rastreabilidade: eles expressam o que o sistema deve fazer, e cada requisito pode ser vinculado a um ou mais casos de teste para mostrar a cobertura. Você pode criar requisitos manualmente ou sincronizá-los a partir de um conector externo de Gerenciamento do Ciclo de Vida do Aplicativo (ALM) (por exemplo, Jira), se configurado no Test Manager.

Resumo

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 os verbos honram as opções globais e os códigos de saída padrão. Todo verbo aceita --log-level <level> (padrão Information).

lista de requisitos do uip tm

Liste os requisitos em um projeto com filtragem avançada no lado do servidor. A CLI escolhe o endpoint de back-end mais específico com base nos sinalizadores de filtro fornecidos — um filtro somente de rótulos usa um caminho rápido; combinar rótulos com outros filtros usa o ponto de extremidade do filtro rich.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Projeto a listar.
--filter <text>	Pesquise requisitos por nome ou chave.
--requirement-ids <uuid...>	UUIDs separados por espaço a serem incluídos. Roteia por meio do endpoint do filtro de rich text.
--labels <labels...>	Nomes de rótulos separados por espaço para filtrar. Quando fornecido individualmente, usa um caminho rápido somente rótulo.
--updated-by <userId>	Filtre pelo ID do usuário que atualizou o requisito pela última vez.
--test-case-id <uuid>	Retornar apenas requisitos vinculados a este UUID de caso de teste.
--changed-since <datetime>	Retornar requisitos modificados após este carimbo de data/hora ISO-8601.
--sort-by <expr>	Expressão de classificação (nome do campo, sufixado opcionalmente com :asc ou :desc).
--limit <n>	Tamanho da página O padrão é 50.
--offset <n>	Resultados a ignorar. O padrão é 0.

Exemplo

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

Formato dos dados

{
  "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-chave: ObjKey — use em --requirement-key em get. Id — use em --requirement-id em get, update, delete, list-testcase-ids e testcases. ForeignReference — definido via --external-reference em create.

requisitos do uip tm obter

Obtenha um único requisito por seu UUID interno ou sua chave PROJECT:N. Transmita --requirement-id ou --requirement-key — eles são mutuamente exclusivos.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--requirement-id <uuid>	UUID do requisito interno. mutuamente exclusivo com --requirement-key.
--requirement-key <key>	Chave do requisito (por exemplo, DEMO:1). Mutualmente exclusivo com --requirement-id.

Exemplo

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

Formato dos dados

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

requisitos do uip tm criação

Criar um novo requisito em um projeto.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--name <name>	Obrigatório. Nome do requisito.
--description <text>	Descrição de forma livre. O padrão é vazio.
--container-id <uuid>	UUID do contêiner para colocar o requisito (opcionalmente).
--external-reference <ref>	Referência do sistema externo (por exemplo, um ID de ticket do Jira).
--connector-requirement-uuid <uuid>	UUID de um sistema de requisitos externo conectado. Deve ser um UUID válido.

Exemplo

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

Formato dos dados

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

atualização de requisitos do uip tm

Atualizar um requisito existente. Pelo menos um desses campos deve ser fornecido.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--requirement-id <uuid>	Obrigatório. UUID interno do requisito a ser atualizado.
--name <name>	Novo nome.
--description <text>	Nova descrição.

Exemplo

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

Formato dos dados

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

Exclusão de requisitos do uip tm

Exclua um ou mais requisitos. -y/--yes é necessário — a CLI nunca solicita interativamente. Um único UUID e vários UUIDs roteiam por meio do mesmo ponto de extremidade em massa.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--requirement-ids <uuid...>	Obrigatório. UUIDs de requisitos a serem excluídos (separados por espaço).
-y, --yes	Obrigatório. Confirme esta operação irreversível.

Exemplos

# 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

Formato dos dados

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

exportação de requisitos do uip tm

Exporte requisitos para um arquivo .xlsx. Suporta os mesmos sinalizadores de filtro que o requirements list.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--output-file <path>	Obrigatório. Caminho para gravar o arquivo de exportação.
--requirement-ids <uuid...>	Filtra por UUIDs de requisito.
--updated-by <userId>	Filtre pelo ID do usuário que atualizou o requisito pela última vez.
--test-case-id <uuid>	Filtrar pelo UUID do caso de teste vinculado.
--labels <label...>	Filtrar por rótulos.
--filter <text>	Pesquise por nome ou chave.
--sort-by <expr>	Classificar resultados.

Exemplo

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

Formato dos dados

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

requisitos da lista de casos de teste do uip tm

Lista os UUIDs dos casos de teste vinculados a um requisito.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--requirement-id <uuid>	Obrigatório. UUID interno do requisito.

Exemplo

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

Formato dos dados

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

casos de teste de requisitos do uip tm

Adicione ou remova links de casos de teste em um requisito. Passe --add-testcase-ids ou --remove-testcase-ids (não ambos na mesma chamada).

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--requirement-id <uuid>	Obrigatório. Requisito para modificar.
--add-testcase-ids <uuid...>	UUIDs de casos de teste separados por espaço a serem vinculados.
--remove-testcase-ids <uuid...>	UUIDs de casos de teste separados por espaço a serem desvinculados.

Exemplos

# 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

Formato dos dados — anexar

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

Formato dos dados — desanexar

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

requisitos do uip tm listar por execução de teste

Listar os requisitos cobertos por uma execução de teste específica. Retorna os requisitos cujos casos de teste vinculados foram incluídos nessa execução.

Argumentos

Nenhum.

Opções

Bandeira	Description
--project-key <key>	Obrigatório. Proprietário do projeto.
--execution-id <uuid>	Obrigatório. UUID de execução de teste.
--labels <label...>	Filtrar por nomes de rótulos (separados por espaço).
--updated-by <userId>	Filtre pelo ID do usuário que atualizou o requisito pela última vez.
--filter <text>	Pesquise requisitos por nome ou chave.
--sort-by <expr>	Expressão de classificação (nome do campo, sufixado opcionalmente com :asc ou :desc).
--limit <n>	Tamanho da página O padrão é 50.
--offset <n>	Resultados a ignorar. O padrão é 0.

Exemplo

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

Formato dos dados

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

Relacionado

• projeto — possuindo o escopo do projeto.
• casos de teste — casos de teste que podem ser vinculados aos requisitos.
• execuções — origem do --execution-id usada por list-by-test-execution.

Veja também

• Visão geral do Test Manager