Przejdź do treści

REST API

Nowy HTTP / JSON API eksponuje operacje biznesowe z katalogu MCP bez koperty JSON- RPC. Dostępne operacje zależą od zainstalowanej wersji serwera. Jest to zorientowany na działanie API, a nie oddzielny interfejs CRUD dla każdej tabeli bazy danych.

Dostęp i uprawnienia

Wyślij istniejący klucz API MCP jako Authorization: Bearer <key>. MCP musi być włączony globalnie i dla projektu. Klucze projektu wymagają X-ZTM-Project-UniqueId. Klucze globalne wymagają wyraźnego dostępu do projektów dla operacji projektu. Przeglądarka i znak w systemie Windows nie zastępują klucza API.

Pozwolenia użytkowników, zapis bram, dozwolone możliwości i ograniczenia demo mają zastosowanie tak jak w przypadku MCP. Użyj HTTPS poza lokalnymi testami. Nigdy nie umieszczaj kluczy w URL, kodzie źródłowym lub logach. Zob. Bezpieczne działania i MCP.

Odkryj operacje

Wniosek Wynik
GET /api/v1/operations Operacje i kontrakty wejściowe dostępne dla obecnego klucza i projektu
GET /api/v1/operations/{operationId} Jedna umowa na prowadzenie działalności
GET /api/v1/openapi.json OpenAPI 3.1 dla tego samego kontekstu autoryzacji
POST /api/v1/operations/{operationId} Wykonaj z obiektem argumentu jako organem żądającym
POST /api/v1/resources/read Odczytaj dane dotyczące eksportu związane z kluczami

OpenAPI zawiera betonową ścieżkę POST dla każdej dostępnej operacji. Wtryski stosują te same schematy co MCP. Zdrowie biblioteki, stabilność wyników, załączniki do projektu i porównania wydań / migawki zostały wpisane schematy wyjściowe. Inne dynamiczne wyniki zapytania / działania zachowują rozszerzone kontrakty JSON. Katalog zawiera wspólne narzędzia zapytania i działania; nie każdy element menu Web ma dedykowany punkt końcowy.

$headers = @{
    Authorization = "Bearer $env:ZTM_API_KEY"
    'X-ZTM-Project-UniqueId' = $env:ZTM_PROJECT_UNIQUE_ID
}
$baseUrl = 'https://your-server.example'
Invoke-RestMethod "$baseUrl/api/v1/operations" -Headers $headers
Invoke-RestMethod "$baseUrl/api/v1/operations/ztm_usage_guide" `
    -Method Post -Headers $headers -ContentType 'application/json' -Body '{}'

Te zmienne środowiskowe są odczytywane przy pomocy skryptu PowerShell; nie konfigurują automatycznie serwera. Projekty trasy z użyciem nagłówków, a nie argumentów operacyjnych. Ciała JSON są ograniczone do 1 MiB i 32 poziomy gniazda. Duplikaty nazwy nieruchomości są odrzucane.

Przeczytaj ustawienia podglądu pakietu Office

Globalny klawisz API MCP może odczytać skuteczny tryb XLSX instalacji z POST /api/v1/operations/ztm_admin_office_preview_settings_get i korpusem {}. Przykładową odpowiedzią jest {"xlsxPreviewMode":"HtmlTable"}; drugą możliwą wartością jest DevExpressPdf. Klucz do projektu jest niewystarczający. Ta operacja jest tylko gotowa. Użyj administracja serwerów, aby zmienić ustawienia.

Pisma i wywóz

Podążaj za podglądem każdej operacji i wyraźnym kontraktem commit, na przykład ztm_project_action_prepare i ztm_project_action_commit. Dostęp do API nie zastępuje zatwierdzenia działalności gospodarczej. Zachowaj podglądy, klucze idepotencji i commits związane z tym samym kontekstem użytkownika i projektu. Po przerwie, sprawdź status działania zamiast ślepo powtarzać napisanie.

Eksport może zwrócić resourceUri. Przeczytaj go przez POST /api/v1/resources/read z {"uri":"<resourceUri>"} przy użyciu tego samego klucza i projektu. Odpowiedź zawiera contents z danymi tekstowymi lub Base64 i typem MIME. Bilety mogą wygasnąć lub zezwolić na jeden odczyt; traktować URI zasobów jako poufne.

Błędy

Błędy zwracają status HTTP i application/problem+json zawierające code i traceId: 400 niepoprawnych wejść, 401 brakujące / odrzucone uwierzytelnianie, 403 niewystarczające uprawnienia, 404 niedostępny obiekt lub operacja, 409 konflikt akcji, 413 nadmiar ciała, 415 nieobsługiwanych typów treści, 500 wewnętrznych awarii. Konflikty wymagają przeglądu, nie automatycznych powtórzeń. Podaj wsparcie traceId, nigdy kluczy lub poufnych ładunków.

Wymagane zasady i zablokowane testy

ztm_project_query zawiera rule dla biblioteki i planowanych zależności: 0 = tylko podpowiedź, 1 = Must successment, 2 = Must have not have failed.

Aby zmienić istniejącą zależność biblioteki, użyj ztm_project_action_context, a następnie ztm_project_action_prepare z capabilityId: project.test-case.dependency.set-rule i argumentów testCaseId, dependencyId, rule. Przejrzyj podgląd i potwierdź go za pomocą ztm_project_action_commit. Klucz wymaga tej wyraźnej możliwości zapisu. Tworzenie pozostaje kompatybilne: nowy związek zaczyna się jako podpowiedź; jego reguła może następnie zostać zmieniona. Istniejące plany i operacje nie są automatycznie synchronizowane.

POST /api/v1/operations/ztm_test_prerequisites_read z {"plannedVariantId":123} ocenia widoczny planowany test. Odpowiedź obejmuje isBlocked, needsRecheck i blockers. Niewidzialni lub brakujący poprzednicy nie są ujawniani po nazwie; wskazuje ich hasHiddenPrerequisites. Ta ocena punktualna nie przyznaje praw do wykonania ani nie zastępuje osobistego potwierdzenia. Ta sama operacja jest dostępna za pośrednictwem MCP.

Załączniki do projektu

ztm_project_attachments_read zawiera listę załączników projektowych i ich ownerId, z offset i limit (maksymalnie 100). Dostawa attachmentId do pobrania contentBase64 (maksymalnie 32 MiB). Wymagany jest aktywny administrator projektu lub menedżer projektu. Dynamicznie powiązane pliki są wymienione, ale nie mogą być pobrane poprzez tę operację.

Wpisy wymagają oddzielnej funkcji project.attachment.upload, project.attachment.update lub project.attachment.delete. Istniejące dotacje na zagospodarowanie nie przyznają dostępu do plików projektu. Użyj zwróconego ownerId, który może być 0 dla danego projektu.

  1. Wysyłanie: połączenie ztm_project_attachment_stage z targetKind: "project", targetId: <ownerId>, fileName, mimeType i contentBase64. Istniejący limit do umieszczenia to 512 KiB na plik.
  2. Zadzwoń do ztm_project_action_prepare z możliwością, nowy idempotencyKey i arguments. Wyślijmy argumenty: ownerKind: "project", ownerId, bilet attachmentReferenceId, opcjonalne displayName i remarks. Aktualizacja metadanych: ownerKind, ownerId, attachmentId, displayName, remarks. Usuń: ownerKind, ownerId, attachmentId.
  3. Przejrzyj podgląd i potwierdź za pomocą ztm_project_action_commit tym samym kluczem. Współbieżna edycja powoduje konflikt; odtwarzanie udanego commit nie tworzy innego załącznika.

Porównania i decyzje o wydaniu

ztm_release_snapshots_list zawiera listę możliwych do odczytania zapisanych porównań z opcjonalnym filtrem targetId. Podaj zwrócony NextCursor jako cursor, aby przeczytać następną stronę.

ztm_release_compare akceptuje baseId, targetId, explicit baseRunIds / targetRunIds i opcjonalne zespoły baseScopeRunIds / targetScopeRunIds { "runId": 123, "scopeRunId": 123 }. Opcjonalnie baseSnapshotId / targetSnapshotId wybierz zapisany dowód. Zwraca porównanie WWW, w tym Fingerprint, stosując te same zasady wyboru i autoryzacji obiektów.

Aby zapisać dowody, wyraźnie przyznać project.release-review.snapshot-create i przygotować / commit argumenty query (obiekt argument porównawczy), name i fingerprint. Zmiany w dowodach są odrzucane. Przeczytaj zapisane porównanie, decisionRevision i historii decyzji z ztm_release_snapshot_read i snapshotId; historyBeforeRevision stron starszych decyzji.

Decyzja wymaga również project.release-review.decision-record, pozwolenia na zarządzanie projektami i wyraźnej ludzkiej autoryzacji. Przygotowanie akceptuje snapshotId, targetId, revision, outcome (1 akceptowany, 2 akceptowany z warunkami, 3 odrzucony, 4 cofnięty), responsibleUserId, comment, openPoints (jeden za linię) i humanConfirmed: true. Serwer rejestruje uwierzytelnionego aktora; flaga nie zastępuje rzeczywistej zgody człowieka. Przejrzyj podgląd, a następnie commit. Nadal obowiązują zasady sieciowe: bieżąca zmiana, kwalifikowalny użytkownik odpowiedzialny, wyjaśnienie, pełny zakres i niezmienione dowody. Kopie projektów historycznych nie mogą otrzymać nowej decyzji.

Zakres i granice

REST i MCP udostępniają swój katalog operacji. Nie oznacza to całkowitego pokrycia każdej funkcji Web. Załączniki do projektu mają teraz odrębną umowę na pisanie; istniejące umowy na wykonanie testu, wymagania i planowanie przesyłania pozostają osobne. Opóźnione operacje pozostają widoczne w katalogu zdolności.

Prezentacja przeglądarki, dialogi plików i interaktywne logowanie nie wymagają odrębnych punktów końcowych domeny. Osobiste potwierdzenie rzeczywistego retestowania ręcznego nie jest generowane automatycznie w imieniu testera. Release view / PDF i automatyzacji importu korzystać z ich istniejących operacji; REST transport nie rozszerza ich domeny zasięgu. Dołączanie projektu pisze i wydaje porównanie / decyzja operacji są teraz dostępne, jak opisano powyżej. Arbitralne ścieżki serwerów i łącza plików Local Bridge pozostają poza tymi operacjami API. Odmiana standardowa kopiowanie i import plików nie są odrębnymi działaniami w poddanym przeglądowi WWW. Wpisywane wyjścia obejmują załączniki do projektu oraz porównania / migawki wydania; istniejące dynamiczne wyjścia zapytań / akcji pozostają rozszerzalne JSON, a nie w pełni wpisywane modele SDK.

Wersja przypadku testowego

Wersja w przypadku badania jest dostępny przez POST /api/v1/operations/ztm_project_test_case_versions. Użyj operation: "list", testCaseID i opcjonalnie skip i take do listy ograniczonej z bieżącą głowicą. read również wymaga revisionID, podczas gdy compare dodaje otherRevisionID; asset używa revisionID i assetID i zwraca base64- zakodowane bajty. restore-preview sprawdza revisionID z expectedHead.

Przygotować odtworzenie poprzez ztm_project_action_prepare, zdolność project.test-case-version.restore i argumenty testCaseID, revisionID, expectedHead, opcjonalne note i options. Potwierdź zwrócony token przez ztm_project_action_commit. options może zawierać wyraźnie wyłączone excludedAttributeIDs i flattenUnavailableReusableSteps. Wiązanie projektu, aktywna tożsamość użytkownika, uprawnienia do obiektów, skomputeryzowane pisanie i ochrona demo nadal mają zastosowanie. Nigdy nie umieszczaj kluczy API w przykładach, logach lub historii powłoki.

Zdrowie biblioteki i stabilność wyników

Te operacje odczytu korzystają z tych samych usług i praw obiektowych, co raporty Web. Nie jest wymagana dotacja na piśmie. Nie modyfikują, nie usuwają ani nie wykonują testów.

Działanie Filtry opcjonalne
ztm_library_health_read unitId w tym potomkowie lub caseId; ageDays 1- 36500 (domyślnie 180); reason; page od 1; pageSize 1- 100 (domyślnie 50)
ztm_test_stability_read testPlanId; testEnvironmentId (0 dla braku środowiska); fromUtc, toUtc jako znaczniki czasu UTC, takie jak 2026-11-08T12:00:00Z; lookbackRuns 1- 200 (domyślnie 50)

Przykład: POST /api/v1/operations/ztm_library_health_read z {"ageDays":180,"reason":"NoVisibleUsage","pageSize":25}. Odpowiedź na wpisanie zawiera Findings, CandidateCount, ScannedCaseCount, IsComplete, Limit, Page i PageSize. Powody to NoVisibleUsage, NeverVisiblyExecuted, LongUnchanged, MissingTitle, MissingSteps, MissingExpectedResults, EmptyQuickContent i NoVariants. Powody mogą się nakładać. Brak widocznego zastosowania nie wskazuje na to, że test jest nieużywany w całym projekcie; zawartość o długim czasie trwania nie jest automatycznie nieaktualna. Analiza ogranicza się do 2000 widocznych przypadków i 20000 widocznych zastosowań. Gdy analiza wykorzystania jest niekompletna, negatywne wskaźniki użytkowania są tłumione.

Przykład: POST /api/v1/operations/ztm_test_stability_read z {"lookbackRuns":50}. Odpowiedź obejmuje Series, FailureGroups, indywidualny Evidence i liczby EligibleRuns, IncludedRuns, EligibleResults, IncludedResults, Truncated i InvalidEvidenceCount. Używa bieżącego wyniku na run / case / varial w widocznych zakończonych rundach, a nie kompletnej historii wykonania. Analizowane jest najwyżej 20000 obserwacji wyników. Odmiany, środowiska i pochodzenie są oddzielone; różnice w budowie pozostają widoczne. ContentDifferences i ContentFingerprint porównują tylko zapisany opis przypadku testowego, a nie kompletną specyfikację historyczną. Zmiany w wynikach to wskaźniki, a nie dowód na łuszczenie się. Dopasowanie tekstu błędu nie dowodzi wspólnej przyczyny. Origin: 0 = sprawdzona automatyzacja prądu, 1 = inne lub niezweryfikowane pochodzenie, 2 = zmienione lub nieprawidłowe dowody automatyzacji.

Użyj pokazanej obudowy wejściowej. Nieprawidłowe zakresy, znaczniki czasu lub nieznane filtry zwracają 400; nieczytelne obiekty biblioteki wyraźnej zwracają 403. Te same narzędzia i filtry są dostępne za pośrednictwem MCP.

Podstawowe wartości odniesienia

Podstawowe wartości odniesienia zapewnia operacje wpisywane dla opcji zakresu, listy, treści historyczne, bieżące porównanie i zapisywane pliki. Utworzenie wykorzystuje prepare / commit z wyraźnie przyznaną funkcją project.library-baseline.create; nie ma edytowania, przywracania lub usuwania operacji. Zobacz powiązany rozdział dla nazw narzędzi, argumentów zakresu, zasad ponownego testowania oraz limit 512 KiB dla odpowiedzi API.

Planowanie drzew i niestandardowe statusy wyników

ztm_project_planning_tree_read zwraca dozwolone drzewo planowania wraz z dostępnymi definicjami wyników i uruchomieniem filtrów. Prośba o przykład:

{"resultDefinitionIds": [12, 15], "includeNoResult": true}

Użyj rzeczywistych identyfikatorów z resultDefinitions; przykładowe identyfikatory są posiadaczami plakietek. Identyfikatory stanu używają OR; opcjonalny treeFilterObjectId dodatkowo ogranicza działania. Zatwierdzone selekcje oznaczają brak filtra dla tego wniosku, niezależnie od zapisanych preferencji UI. Wynik następuje po ustawieniach widoczności drzewa użytkownika i zwraca tylko dozwolone węzły. Nieznane jednoznaczne identyfikatory są odrzucane. Operacja odczytu nie zmienia osobistych preferencji ani wyników testów. Ta sama umowa jest dostępna za pośrednictwem MCP.

Pochodzenie wartości atrybutu

Dla istniejących akcji atrybutów ztm_project_action_context dodaje Metadata do PromotedFields i ObjectAttributes. Zawiera AttributeId, AttributeStyleFieldId, nazwę pola, identyfikator stylu i nazwę, typ pola, rodzaj właściciela i ID, Entail i SourceKind (direct, inherited, default). Niezapisany domyślny nie ma identyfikatora właściciela. Brakujące definicje pola zachowują pierwotny identyfikator pola, podczas gdy ich szczegóły definicji są zerowe.

Te same informacje są dostępne za pośrednictwem MCP i POST /api/v1/operations/ztm_project_action_context. Istniejące uprawnienia i możliwości działania atrybutu nadal mają zastosowanie; dostęp do kontekstu nie udziela dodatkowego zezwolenia na odczyt. Pola haseł są wyłączone. Kontekst odczytu nie utrzymuje się bez domyślnych wartości. Atrybuty wyjaśnia różnicę pomiędzy dziedzictwem według nazwy a promowanymi polami.

Ukierunkowane informacje zwrotne na temat wyników

Narzędzia tylko do odczytu ztm_result_feedback_read, ztm_result_feedback_preview i ztm_result_feedback_export są również dostępne w operacjach POST poniżej /api/v1/operations/. Każdy z nich wymaga możliwości odczytu project.result-feedback.read, .preview lub .export oraz dostępu do odczytu wybranych obiektów.

read akceptuje testRunId. preview dodaje resultItemIds (od 1 do 100 unikalnych identyfikatorów), opcjonalnie recipient, subject, message, externalReference i includeResultText (domyślnie false). Jej odpowiedź obejmuje Fingerprint poddanej przeglądowi treści. export używa tego samego wejścia plus expectedFingerprint, format (html lub xlsx) i opcjonalnie language (de lub en). Odpowiedź zawiera FileName, ContentType i ContentBase64.

Zmieniona zawartość wymaga kolejnego podglądu. Niedostępne wybrane wyniki odrzucają cały wynik; nie ma cichego częściowego eksportu. Żadna operacja nie wysyła wiadomości ani nie przechowuje odbiorców w projekcie. Patrz Wyniki badania udziału dla limitów przepływu użytkowników i zawartości.

Zasady dotyczące roli AD

ztm_ldap_role_rules_get odczytuje zasady konfiguracji importu; ztm_ldap_role_rules_save zapisuje je z oczekiwaną korektą; ztm_ldap_role_rules_preview przedstawia zmiany członkostwa. ztm_ldap_import_run uruchamia istniejący import AD wraz z zapisanymi zasadami. Te same operacje są dostępne jako narzędzia MCP.

Wszystkie rozmowy wymagają configurationId. Zapisz, podgląd i import wymagają expectedRevision od najnowszej odpowiedzi odczytu. Zapisz akceptuje rules zawierające stabilne ID reguły, stan włączony, nazwę atrybutu, dokładną wartość, rolę i dedykowaną nazwę grupy. Telefony nie wybierają identyfikatorów grupowych. Kontrakty generowane OpenAPI opisują pełne pola.

Zapisywanie i import to pisma administracyjne wymagające włączonego klucza administracyjnego z dostępem do projektu i zakresem dopasowania. Sprawdzone są również uprawnienia do zarządzania projektami. Podgląd zmian bez członkostwa, ale wymaga dostępu do skonfigurowanego katalogu. Publiczne demo blokuje rozmowy administracyjne. Po korekcji konfliktu, przeczytaj i ponownie przeglądaj konfigurację zamiast ślepego ponownego pobierania importu z przestarzałych ustawień.

Świeże i ręczne oceny usterek

ztm_release_evidence_read, ztm_release_evidence_configure i ztm_release_evidence_observe odczytują ograniczenia wiekowe lub wartości graniczne przechowywania oraz wyraźnie ręczną ocenę wad. Używają odpowiednich kontraktów MCP i bieżącego expectedRevision. Ponowne przeczytanie po konflikcie (409); nie należy ślepo ponownie próbować. observe wymaga rzeczywistego referenceId i sourceFingerprint z przeglądu report.EvidenceAssessment.Defects, plus state, criticality, observedUtc z wyraźną strefą czasową oraz comment.

Dedykowane zakresy zapisu to project.release-evidence.configure i project.release-evidence.observe. Włączone projekt pisze i te same prawa do zarządzania release- jak Web również mają zastosowanie. Oświadczenia obejmują użytkownika i czas nagrywania; nie są one automatycznie weryfikowane dane trackera i nie mogą być wynalezione bez wyraźnej instrukcji człowieka. ztm_release_overview_read dodaje EvidenceAssessment do nowych chwytów na żywo; istniejący poziom assessment i powody go zawierają. Historyczne uchwyty pozostają niezmienione. Patrz Porównanie i akceptacja wydania.

Zestawy danych z badań strukturalnych

Te narzędzia MCP są również dostępne jako POST /api/v1/operations/<tool-name> z tymi samymi umowami. Patrz Matryca danych testowych dla zasad funkcjonalnych.

Narzędzie (przedrostek ztm_test_data_set_) Argumenty Wynik
list brak dozwolone zestawy danych w items
read dataSetId zbiór danych z korektą i stabilnymi identyfikatorami wierszy
save data, expectedRevision, confirmed:true utrzymujący się zestaw danych z nową korektą
delete dataSetId, expectedRevision, confirmed:true deleted:true; dane referencyjne pozostają chronione
binding variantId binding lub null
preview variantId, dataSetId, rowId teksty, diagnostyka i odciski palców bez zmian
apply argumenty podglądu, expectedFingerprint, confirmed:true utrzymujące się wiążące i rozwiązane teksty
unbind variantId, expectedFingerprint, confirmed:true unbound:true; tekstami rozwiązanymi zostają zachowane
export dataSetId XLSX fileName, mimeType, contentBase64
import_preview dataSetId, expectedRevision, contentBase64 niezapisany wniosek; wyraźnie zadzwoń później do save

Pola zbioru danych to Id, TestUnitId, Name, Revision, Columns i Rows; wiersze zawierają Id i Values. Utworzenie używa zerowego GUID dla Id i pustego expectedRevision. Wiersze wymagają unikalnych niezerowych GUID. Aktualizacje wymagają wcześniej odczytywanej korekty. Po konfliktach przeczytaj ponownie i przejrzyj zmiany.

Cztery writs wymagają poszczególnych zakresów project.test-data-set.save, .delete, .apply lub .unbind, włączonych projektów i odpowiednich uprawnień obiektu. Import podglądu nigdy nie trwa, ale wymaga zgody właściciela edytować tak jak Web. Ograniczenia demo stosuje się również w ramach API. REST używa kluczy na okaziciela zamiast plików cookie przeglądarki i nie wymaga tokena CSRF; formularze WWW nadal wymagają żetonów antyfałszerskich.

XLSX wykorzystuje jeden arkusz roboczy z _RowId jako pierwszą kolumnę. Komponenty, makra i odniesienia zewnętrzne są odrzucane. Limity: 4 MiB XLSX, 16 MiB rozszerzona zawartość, 30 kolumn danych, 1000 wierszy, 32,767 znaków na komórkę i 2 MiB na zestaw danych. Tylko zapisz i zaimportuj podgląd zaakceptować do 6 MiB transportu JSON w tym Base64; inne operacje zachowują istniejący limit 1-MiB.

binding zwraca również zamrożone wiązania, których źródło jest niedostępne: SourceAvailable:false i diagnostyczne SourceUnavailable. Zapisany tekst pozostaje czytelny, gdy wariant jest czytelny. Odświeżanie wymaga dostępu do źródła; niewiążące wykorzystuje obecny odcisk palca wiążący.

Przywóz z innego narzędzia testowego

Bieżąca budowa zapewnia POST /api/v1/operations/ztm_vendor_migration_preview i POST /api/v1/operations/ztm_vendor_migration_apply dla migracja z innego narzędzia. Odpowiednie narzędzia MCP dzielą się tą umową.

Supply targetUnitId, sourceKey, workbookBase64 i opcjonalnie attachmentsZipBase64.

Dla tabeli sprzedającej należy dodać provider (testrail, xray, zephyr, qase lub neutralne) i fileName kończące się w .xlsx lub .csv. Kontynuuj wysyłanie bajtów w workbookBase64. Wykryte kolumny są używane domyślnie. Użyj mapping, aby przypisać ExternalId, Nazwa, FolderPath, Opis, Warunki wstępne, Kroki, ExpectedResult i attachmentPath do istniejących nagłówków. Użyj tego samego źródła, pliku i mapowania podczas stosowania podglądu. Neutralne żądania XLSX bez tych pól zachować ich dotychczasowe zachowanie.

Podgląd używa funkcji odczytu project.vendor-migration.preview. Wystarczy odczytać klucz; jego użytkownik potrzebuje również pozwolenia na tworzenie przypadków w celu. Do podglądu nie jest wymagany żaden zakres zapisu. Zwraca Fingerprint, Items, Diagnostics i CanApply bez zapisywania. Zastosuj tylko wtedy, gdy CanApply jest prawdziwy; przeglądaj nowy podgląd po zmianach.

Aby zastosować, wysłać te same pliki, podgląd odcisku palca jako expectedFingerprint, świeże UUID jako operationId i confirmed: true. Po przerwie w sieci należy pobrać tę samą operację z tym samym UUID.

Zastosowanie wymaga aktywowanych akcji zapisu i zakresu project.vendor-migration.apply. Prawa do obiektu i ograniczenia demo pasują do przepływu pracy w sieci. Wniosek dotyczący JSON, w tym dane Base64, jest ograniczony do 6 MiB.

Kiedy baza danych projektu jest zajęta, REST zwraca HTTP 503 za pomocą DatabaseBusy i Retry-After: 2. MCP zwraca actionErrorCode: "DatabaseBusy" i retryAfterSeconds: 2 w danych błędów. Po zwolnieniu dostępu, ponownie wypróbować to samo żądanie z tym samym operationId; zapisane paragony są zwracane po sprawdzeniu uprawnień i bieżącej zawartości ponownie, bez tworzenia dalszych kopii.

Przekażcie mi test.

Użyj osobistego klucza projektu z zakresu zapisu project.test-run.handover, aby przeczytać uprawnionych odbiorców i bieżącą korektę. MCP i REST używają tych samych argumentów.

  1. Zadzwoń do ztm_project_action_context z {"capabilityId":"project.test-run.handover","itemKind":"test-run","itemId":23}.
  2. Wybierz ID z Recipients i użyj Revision jako expectedRevision. Na przykład wywołaj ztm_run_handover lub POST /api/v1/operations/ztm_run_handover z {"runId":23,"recipientUserId":7,"expectedRevision":0}.

Applied potwierdza, że przekazanie zostało zapisane. mailStatus zgłasza status dostawy (Sent, NotConfigured, MissingAddress, MissingLink lub Failed). Powtórzenie prośby o zwrot bieżącego odbiorcy AlreadyApplied za pomocą mailStatus: null. Przeczytaj kontekst ponownie po konflikcie (HTTP 409). Właściciel klucza potrzebuje pozwolenia na edycję biegu. Klucze globalne i instancje demo nie mogą dokonywać przekazania.

Przypisz planowane przypadki badań

  1. Użyj ztm_project_action_context do odczytu bieżącego stanu dla każdego uruchomienia. Wyślij {"capabilityId":"project.test-run.assign","itemKind":"test-run","itemId":23}. Wybierz przypadki z Cases i odbiorcy z Recipients.
  2. Zadzwoń do ztm_run_assign w MCP lub wyślij POST /api/v1/operations/ztm_run_assign. W przypadku nieprzypisanego przypadku należy wysłać na przykład {"recipientUserId":7,"selection":[{"caseId":42,"runId":23,"expected":null}]}. Jeśli sprawa jest już przydzielona, podaj jej userId, assignedUtc i assignedByUserId pod expected. Podaj recipientUserId: null, żeby oczyścić zadanie.
  3. Odczyt obciążenia pracą przez ztm_run_workload_read lub POST /api/v1/operations/ztm_run_workload_read z {"planId":9}.

Zapis wymaga osobistego klucza z zakresu project.test-run.assign, uruchom uprawnienia do edycji i dostępu do wybranych przypadków. Jest niedostępny w publicznym demo. Na temat konfliktu, przeczytaj ponownie obecny stan. Każda prośba zapisuje swój wybór w jednej operacji. Obciążenie robocze obejmuje tylko widoczne otwarte przejazdy.

Odczytywanie pokrycia wydania

  1. Zadzwoń do ztm_coverage_matrix_read w MCP lub wyślij POST /api/v1/operations/ztm_coverage_matrix_read z {}. Releases zawiera widoczne identyfikatory i nazwy wydania.
  2. Wyślij wybrany releaseId i opcjonalnie filter. Na przykład, {"releaseId":"6bebaee0-20b9-4ff8-b4d1-abdd5d37833c","filter":"without-result"}. Filtry all, without-test, without-result i failed pasują do widoku przeglądarki.
  3. Odczyt Rows według wymagań, przypadku testowego i środowiska. Status jest 0 dla braku wyniku, 1 dla nie podlegającego ocenie, 2 dla przekazanego, 3 dla nieudanego i 4 dla częściowo przekazanego. W przypadku gdy zapisane dowody są widoczne, komórki obejmują ResultItemId, RunTitle, RecordedUtc i Tester. Totals liczy przefiltrowane wymagania. Jeden wymóg może się przyczynić do kilku kategorii.

Potrzebny jest osobisty klucz projektu i przeczytaj dostęp do żądanych danych. Funkcja Wymagania musi być włączona dla projektu. Ta operacja odczytuje macierz.

Zadzwoń do ztm_share_link_create w MCP lub POST /api/v1/operations/ztm_share_link_create w REST. Obie akceptują to samo ciało JSON.

{"targetKind":"run","targetId":"23","validityDays":7,"requestId":"869744c5-8cdb-45e1-a300-918d308345f1","includeErrors":false,"includeFindings":false}

Ustaw targetKind na run, plan lub release. Dostarcz ID celu jako ciąg znaków, używając jego UUID do wydania. Wybrać 7 lub 30 dni. Problemy i ustalenia są domyślnie ukryte. Dodaj recipientEmail, aby wysłać link pocztą elektroniczną projektu.

Zatrzymaj shareId do odwołania. Odpowiedź zwraca adres gościa w url raz, razem z expiresUtc i mailStatus (NotRequested, Sent lub Failed). Należy rozwiązać względny adres gościa w stosunku do pochodzenia punktu końcowego API. Traktuj adres, łącznie z fragmentem, jak hasło. Jeśli dostawa zawiedzie, link został już utworzony. Pobieranie za pomocą tego samego requestId nie może utworzyć innego łącza ani wysłać kolejnego maila. Jeśli odpowiedź została utracona, należy cofnąć oryginalny wpis w Dzielone linki przed utworzeniem zastępstwa.

Lek Revoke należy stosować z ztm_share_link_revoke lub POST /api/v1/operations/ztm_share_link_revoke i {"shareId":"<share UUID>"}. Odpowiedź zawiera shareId i revokedUtc. Powtórzone cofnięcie zwraca pierwotny znacznik czasu.

Oba działania wymagają HTTPS (pętla jest dozwolona lokalnie), włączonego projektu pisze i osobisty klucz projektu z odpowiednim project.share-link.create lub project.share-link.revoke zakresu. Docelowe uprawnienia i ograniczenia demo obowiązują tak jak w przypadku klienta internetowego. Zob. dostęp dla gości.

Edytuj kilka przypadków testowych

Zadzwoń do ztm_library_bulk_update w MCP lub POST /api/v1/operations/ztm_library_bulk_update. Na przykład, podgląd ustawia atrybut modułu:

{"operation":"preview","action":"attribute","caseIds":[12,31],"attributeName":"Modul","attributeValue":"Checkout"}

Sprawdź Rows. Następnie ustaw operation na apply i prześlij te same parametry ze zwróconym Fingerprint w fingerprint. Dodaj UUID w requestId dla powtórzeń. Powtórzenie tego samego żądania z identyfikatorem zwraca swój pokwitowanie, podczas gdy serwer zachowuje zadanie. HTTP 409 wymaga nowego podglądu.

targetUnitId z move lub archive, reviewGroupId z review i variantValueIds z variant. Obiekt docelowy archiwum musi być oznaczony jako jednostka archiwum. Każdy wniosek przyjmuje do 200 przypadków testowych. Użyj osobistego klucza projektu z zakresu project.test-library.bulk-update. Serwer sprawdza aktualne prawa dla każdego przypadku. Klucze globalne i dostęp do demo są zablokowane.

Użyj {"operation":"undo","requestId":"<RequestId from receipt>"} z tym samym kluczem do projektu, aby cofnąć ruchy lub zmiany atrybutów, podczas gdy zadanie pozostaje w pamięci serwera. Pozwolenia i zmiany interweniujące są sprawdzane ponownie.

Opcjonalny boolean isArchive w argumentach project.test-unit.update oznacza jednostkę jako archiwum. Użyj istniejącego przepływu podglądu / commit za pomocą itemId i title. Pomijając isArchive zachowuje swoją wartość. Jednostka Wiedzy Projektu czyta także demaskowanie isArchive.

Retest wybrane wyniki

ztm_library_retest lub POST /api/v1/operations/ztm_library_retest wykorzystuje taki sam przepływ pracy jak Utrzymanie biblioteki testowej:

  1. Wyślij operation: "options" i findings do odczytu dozwolonych uruchomień źródłowych, środowisk i testerów. Każde odkrycie zawiera caseId, plannedCaseId lub resultId; obejmuje znane variantId, planId i runId. Wyraźnie wybrać kontekst, gdy kilka są dostępne.
  2. Wyślij operation: "preview", ten sam wybór i planId, runId, environment i testerId. Items zawiera listę skutecznych wariantów, w tym obowiązkowe warunki wstępne. Skipped identyfikuje wyniki wyłączone ze względu na wskaźnik wyboru oparty na zeronach. Ustaw acceptOldTemplate: true tylko po wyraźnej decyzji o użyciu przestarzałych szablonów.
  3. Wyślij operation: "create" z identycznymi wejściami, zwrócony Fingerprint jako fingerprint, a RequestId jako requestId. Pokwitowanie zawiera RunId, Url i pominięto ustalenia. Po awarii połączenia, ponownie spróbować tego samego ID żądanie, aby uniknąć tworzenia drugiego uruchomienia.

Podglądy wygasają po 30 minutach i należą do projektu i użytkownika. Zmiany wyboru, uprawnień lub treści wymagają nowego podglądu. Każdy wniosek akceptuje maksymalnie 200 wyników; wymagane jest istniejące uruchomienie źródłowe. Opcjonalny parametr tab (health, impact, results) również sprawdza, czy odpowiednia karta jest dostępna.

Użyj osobistego klucza projektu z zakresu zapisu project.test-library.retest i zezwolenia na tworzenie uruchomień w wybranym planie. Wykluczone są globalne klucze administratora i tryb publicznego demo. Istniejące narzędzia i synchronizacja poprzez project.planned-test-case.synchronize-from-library pozostają niezmienione.

Uwagi dotyczące przedmiotu

Użyj ztm_comment_read, aby odczytać komentarze i aktywność dla jednego obiektu. Supply kind (test-case, requirement, run, result) i id. Strona offset i activityOffset niezależnie. Użyj commentId, aby zlokalizować stronę zawierającą komentarz. Traktuj Markdown jako zawartość użytkownika.

ztm_comment_add zapisuje markdown z generowanym przez klienta UUID jako commentId. Dostawa parentId do odpowiedzi. Możesz użyć mentionUserIds do powiadamiania wyraźnie wybranych użytkowników projektu o dostępie do odczytu. Tekst musi zawierać ich wzmiankę. Retry z tym samym UUID i zawartość. Created odróżnia nowy komentarz od powtórki. MailFailed zgłasza problem dostawy, podczas gdy komentarz pozostaje zapisany.

Oba narzędzia wymagają włączenia komentarzy do projektu. Używają aktywnego właściciela klucza osobistego projektu i sprawdzają aktualne uprawnienia obiektu. Wysyłanie wymaga zapisu projektu i zakresu project.comments.add. REST używa POST /api/v1/operations/ztm_comment_read i POST /api/v1/operations/ztm_comment_add. Przebieg pracy sieci

Utwórz ponowny test z biegu

Narzędzie MCP ztm_retest_create i trasa REST POST /api/v1/operations/ztm_retest_create akceptują te same argumenty. Podgląd wyboru najpierw. Przykład ten zawiera nieprzetestowane warianty oprócz nieudanych i zablokowanych.

{"mode":"preview","sourceRunId":36,"includeUntested":true}

Przegląd RequestedCount, dodatkowe warunki wstępne (RequiredCount) i Errors. Użyj środowiska (Environment), identyfikatora testera z Testers i ComparisonToken z tego podglądu. Zastąp przykładowe wartości i wygeneruj świeże UUID dla każdego nowego żądania. Jeśli RequiresOldTemplate jest prawdą, tworzenie wymaga wyraźnej zgody za pomocą acceptOldTemplate: true.

{
  "mode": "create",
  "sourceRunId": 36,
  "includeUntested": true,
  "environment": "Staging",
  "testerId": 7,
  "comparisonToken": "<ComparisonToken>",
  "creationId": "179e6928-a673-4dac-acae-b913914a13df"
}

Odpowiedź zawiera nowy, nierozpoczęty bieg testRunId. Jeżeli połączenie nie powiodło się, należy ponownie sprawdzić identyczne żądanie, w tym jego creationId. Oba tryby wymagają włączenia zapisu, zakresu project.retest.create oraz uprawnień do projektu i obiektu do wyświetlania źródła i tworzenia przebiegu. Stosuje się również ograniczenia demo. Korzystanie z internetowej deski rozdzielczej.

Utwórz problem z wyniku testu

ztm_issue_create_from_result · POST /api/v1/operations/ztm_issue_create_from_result

Użyj narzędzia MCP lub jego dopasowującej operacji REST z osobistym zakresem zapisu project.defect.create. testCaseId jest planowanym identyfikatorem wariantu. Dla uporządkowanych kroków, Szybkie wiersze i pozycje listy, stepIndex zaczyna się od zera. Należy ją pominąć w odniesieniu do ogólnych wyników i nieustrukturyzowanego tekstu.

{"mode":"prepare","testRunId":40,"testCaseId":371,"stepKind":"structured","stepIndex":3}

Przejrzyj zwrócone pola i opcje mocowania. Po potwierdzeniu użyj zwróconego RequestId jako requestId i wyślij wybrane wartości oraz dostępne identyfikatory wyników.

{"mode":"create","testRunId":40,"testCaseId":371,"requestId":"4c2ef7c8-b3a2-43e4-a721-6f04bb164b42","attachmentIds":[38]}

Po Retryable, ponownie spróbować z tym samym identyfikatorem, gdy nadajnik jest dostępny. Po Unknown, sprawdź nadajnik i wyślij istniejący numer jako existingIssueReference. Po LinkPending, powtórzyć wniosek o połączenie znanego wydania. Aby bezpośrednio wkleić zrzut ekranu, użyj okna dialogowego.