TestResultsRestClient class

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Konstruktory

TestResultsRestClient(IVssRestClientOptions)

Właściwości

Metody

addCustomFields(CustomTestFieldDefinition[], string)	Tworzy niestandardowe pola testowe na podstawie dostarczonych danych.
addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)	Dodawanie wyników testów do sesji przebiegu testu
addWorkItemToTestLinks(WorkItemToTestLinks, string)
callbackTestAgent(TestAgentCallbackRequest, string)
completeGitHubAuth(string, string)	Punkt końcowy wywołania zwrotnego OAuth. GitHub przekierowania tutaj po autoryzować użytkownika. Wymienia kod autoryzacji tokenów i przechowuje je w narzędziu TCM StrongBox. Wymaga zarejestrowania adresu URL wywołania zwrotnego w ustawieniach aplikacji OAuth GitHub.
createAnalysis(TestSessionAnalysis[], string, number)	Tworzy obiekt Analizy sesji w magazynie danych TCM dla danej sesji
createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)	Tworzy załącznik w magazynie dzienników dla określonego identyfikatora buildId.
createEnvironment(TestSessionEnvironment[], string)	Tworzy obiekt Environment w magazynie danych TCM
createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)	Dla podanego identyfikatora sessionId tworzy obiekty środowiska, konfiguracji i maszyny w magazynie danych TCM
createFailureType(TestResultFailureTypeRequestModel, string)	Tworzy nowy typ niepowodzenia testu
createNotification(TestSessionNotification[], string, number)	Tworzy obiekt Notification w magazynie danych TCM dla danej sesji
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)	Rejestruje metadane załącznika testowego na poziomie wyniku, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.
createTestResultMachines(TestResultMachine[], string, number)	Tworzy maszyny wyników testów dla podanego identyfikatora TestRunId
createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)	Rejestruje metadane załącznika testowego na poziomie uruchomienia, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)	Tworzy załącznik w magazynie dzienników dla określonego identyfikatora runId.
createTestSession(TestResultsSession, string)	Tworzy obiekt TestResultsSession w magazynie danych TCM
createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)	Rejestruje metadane dla załącznika testowego na poziomie podwyniku, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.
deleteCustomFieldById(string, number)	Zwraca szczegóły pola testu niestandardowego dla określonego elementu testExtensionFieldId.
deleteFailureType(string, number)	Usuwa typ błędu testu z określonym identyfikatorem failureTypeId
deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)	Usuwanie błędnych identyfikatorów referencyjnych przypadków testowych według informacji o gałęziach i repozytoriach
deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)	Usuwa załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.
deleteTestSettings(string, number)
enhanceCoverage(string, string, number)	Klikalny punkt wejściowy dla linku "Enhance diff coverage" wyświetlany w komentarzach dotyczących relacji PR. Wysyła zadanie coverage_test_generation do ADOAgenticService dla danego pull request i przekierowuje użytkownika z powrotem na stronę pull request.
fetchSourceCodeCoverageReport(string, number)
generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)	Generuje ręczny plan testu na podstawie zadania pracy za pomocą AI. Jeśli użytkownik nie ma ważnego tokena Copilot, zwraca needsAuth=true z uwierzytelniającym URL zamiast kolejkować zadanie.
getAfdTcmEndpoint(string)
getBranchesByFlakyTestCaseRefId(string, number)	Pobierz listę gałęzi, w których identyfikator odwołania do przypadku testowego został usunięty
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)
getCodeCoverageSummary(string, number, number)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Żądanie: identyfikator kompilacji i identyfikator kompilacji różnicowej (opcjonalnie)
getCoverageStatusBadge(string, string, string, string)	<p>Pobiera stan pokrycia dla ostatniej pomyślnej kompilacji definicji, opcjonalnie o określonym zakresie dla określonej gałęzi</p>
getFailureTypes(string)	Zwraca listę typów niepowodzeń testów.
getFileLevelCodeCoverage(FileCoverageRequest, string)	Pobieranie pokrycia pliku dla określonego pliku
getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)	Uzyskaj najnowsze wyniki dla każdego żądanego TestCaseId. Przypadki testowe, które nigdy nie zostały wykonane (bez wyniku w nieusuniętym przebiegu) są pomijane w odpowiedzi – dzwoniący traktuje ich brak jako "nigdy nie uruchomiony".
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)	Pobiera obiekty powiadomień TestResultsSession w magazynie danych TCM
getSimilarTestResults(string, number, number, number, number, String)	Pobiera listę wyników, których niepowodzenie jest zgodne z podanym.
getTestAgentToken()	Zwraca token GitHub OAuth obecnego użytkownika z uprawnieniami do dostępu do Interfejsy API funkcji Copilot, zamknięty za flagą funkcji.
getTestIterationAttachmentContent(string, number, number, number, number)	Zwraca załącznik iteracji testowej
getTestIterationAttachmentZip(string, number, number, number, number)	Zwraca załącznik iteracji testowej
getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)	Pobieranie listy załączników kompilacji — dokumentacja
getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)	Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika kompilacji
getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)	Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika wyników testu
getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)	Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika przebiegu testu
getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)	Uzyskiwanie identyfikatora URI sygnatury dostępu współdzielonego załącznika podwyłdania testowego
getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)	Pobierz podsumowanie wyników testu.
getTestResultAttachmentContent(string, number, number, number)	Zwraca załącznik wyników testu
getTestResultAttachments(string, number, number)
getTestResultAttachmentZip(string, number, number, number)	Zwraca załącznik wyników testu
getTestResultById(string, number, number, ResultDetails)
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)	Pobierz podsumowanie wyników testów dla kompilacji. Aby pobrać pełną pełną wartość TestCaseResult, wywołaj metodę Results — Get.
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)	Pobieranie listy załączników wyników testów
getTestResultMachines(string, number)	Pobiera maszyny wyników testów dla podanego identyfikatora TestRunId
getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)	Pobierz listę wyników.
getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)	Pobiera pełne obiekty TestCaseResult ze szczegółami 1MRX dla podanego identyfikatora pipelineId
getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)	Pobieranie danych TestResultsSettings
getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)	Zwraca załącznik przebiegu testu
getTestRunAttachments(string, number)
getTestRunAttachmentUploadDetails(string, number)	Wstępne uruchomienie załącznika bezpośrednio do BlobStore: wymusza zezwolenie na publikację i zwraca domenę dedup do publikacji. Agent wywołuje to przed przesłaniem bajtów.
getTestRunAttachmentZip(string, number, number)	Zwraca załącznik przebiegu testu
getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)	Pobieranie listy załączników przebiegu testów
getTestRunLogStoreAttachmentContent(string, number, string)	Zwraca załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.
getTestRunLogStoreAttachments(string, number)	Zwraca listę załączników dla określonego identyfikatora runId z magazynu dzienników.
getTestRunLogStoreAttachmentZip(string, number, string)	Zwraca załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.
getTestRunMessageLogs(string, number)	Pobieranie dzienników komunikatów przebiegu testu
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
getTestRunsBySessionId(string, number)	Pobiera przebiegi testów skojarzone z sesją
getTestRunStatistics(string, number)	Pobierz statystyki przebiegu testu , używane, gdy chcemy uzyskać podsumowanie przebiegu według wyniku.
getTestRunSummaryByOutcome(string, number)	Pobierz podsumowanie przebiegu testu, używane, gdy chcemy uzyskać podsumowanie przebiegu według wyniku. Przebieg testu powinien być w stanie ukończonym.
getTestSession(string, number)	Pobiera obiekt metadanych TestResultsSession w magazynie danych TCM
getTestSessionLayout(string, string)	Pobiera obiekt Układu TestResultsSession w magazynie danych TCM
getTestSessionLayoutBySessionId(string, number)	Pobiera obiekt Układu TestResultsSession w magazynie danych TCM
getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)	Zwraca załącznik wyników podrzędnych testu
getTestSubResultAttachments(string, number, number, number)	Zwraca odwołania do załączników dla wyniku podrzędnego testu.
getTestSubResultAttachmentZip(string, number, number, number, number)	Zwraca załącznik wyników podrzędnych testu
getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)	Pobieranie listy odwołań do załączników podrzędnych testów
getTestTagsForBuild(string, number)	Pobierz wszystkie tagi w kompilacji.
getTestTagsForRelease(string, number, number)	Pobierz wszystkie tagi w wersji.
getTestTagSummaryForBuild(string, number)	Pobierz wszystkie tagi w kompilacji.
getTestTagSummaryForRelease(string, number, number)	Pobierz wszystkie tagi w wersji.
getTestWeightedScoreByTestRun(string, string, boolean, boolean)	Oblicz ważony wynik testu dla podanej listy ID testów podzielonej na komany.
publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)	Zwraca listę niestandardowych pól testowych dla danego niestandardowego zakresu pola testowego.
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)	Uzyskiwanie historii metody testowej przy użyciu metody TestHistoryQuery
queryTestMethodLinkedWorkItems(string, string)
queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)	Zwraca metadane dla załączników testowych na poziomie wyniku, wspieranych przez BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu.
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string, ResultMetaDataDetails)	Pobieranie listy szczegółów metadanych wyników testu dla odpowiednich identyfikatorów testcasereferenceId
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)	Pobierz podsumowanie wyników testu.
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)	Działanie wyników testu zapytania na podstawie filtru
queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)	Zwraca metadane dla załączników testowych na poziomie uruchomienia opartych na BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu. Agent używa tego do wyliczania logów testowych BlobStore (dedup), które nie występują w klasycznym kontenerze LogStore SAS i dlatego nie mogą być bezpośrednio wypisane przez agenta.
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)	Testy zapytań są uruchamiane na podstawie filtrów. Obowiązkowe pola to minLastUpdatedDate i maxLastUpdatedDate.
queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)	Zwraca metadane dla załączników testowych na poziomie podwyników, wspieranych przez BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu.
queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)	Tworzenie i pobieranie identyfikatora URI sygnatury dostępu współdzielonego kontenera kompilacji
testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)	Utwórz pusty plik dla wyniku i pobierz identyfikator URI sygnatury dostępu współdzielonego dla pliku
testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)	Tworzenie pustego pliku dla przebiegu i uzyskiwanie identyfikatora URI sygnatury dostępu współdzielonego dla pliku
testResultsGroupDetails(string, number, string, string, string, boolean, boolean)	Pobierz szczegóły wszystkich dostępnych grup, a dla tych grup nie powiodło się i przerwano wyniki.
triggerTestAgent(TestAgentTriggerRequest, string)
updateCodeCoverageSummary(string, number, CodeCoverageData)	http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Żądanie: Json podsumowania pokrycia kodu
updateCustomField(CustomTestFieldUpdateDefinition, string)	Zwraca szczegóły pola testu niestandardowego, które jest aktualizowane.
updatePipelinesTestSettings(TestResultsUpdateSettings, string)	Aktualizowanie ustawień projektu wyników testów
updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)	Aktualizowanie właściwości metadanych wyników testu
updateTestResultsToTestRunSession(TestCaseResult[], string, number)	Tworzy obiekty TestResultsMRX w magazynie danych TCM dla istniejących wyników testów
updateTestRun(RunUpdateModel, string, number)
updateTestRunsBySessionId(TestSessionTestRun, string, number)	Przebiegi testów aktualizacji skojarzone z sesją
updateTestRunTags(TestTagsUpdateModel, string, number)	Aktualizowanie tagów przebiegu. Tagi można dodawać i usuwać
updateTestSession(TestResultsSession, string, number)	Aktualizuje obiekt sesji testowej skojarzony z identyfikatorem sessionId

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: "c83eaf52-edf3-4034-ae11-17d38f25404c" = "c83eaf52-edf3-4034-ae11-17d38f25404c"

Wartość właściwości

"c83eaf52-edf3-4034-ae11-17d38f25404c"

addCustomFields(CustomTestFieldDefinition[], string)

Tworzy niestandardowe pola testowe na podstawie dostarczonych danych.

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

Parametry

newFields: CustomTestFieldDefinition[]

NewFields to tablica typu CustomTestFieldDefinition.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<CustomTestFieldDefinition[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametry

results: TestCaseResult[]

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Dodawanie wyników testów do sesji przebiegu testu

function addTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametry

results: TestCaseResult[]

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator RunId przebiegu testu

Zwraca

Promise<TestCaseResult[]>

addWorkItemToTestLinks(WorkItemToTestLinks, string)

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

Parametry

workItemToTestLinks: WorkItemToTestLinks

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WorkItemToTestLinks>

callbackTestAgent(TestAgentCallbackRequest, string)

function callbackTestAgent(request: TestAgentCallbackRequest, project: string): Promise<boolean>

Parametry

request: TestAgentCallbackRequest

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<boolean>

completeGitHubAuth(string, string)

Punkt końcowy wywołania zwrotnego OAuth. GitHub przekierowania tutaj po autoryzować użytkownika. Wymienia kod autoryzacji tokenów i przechowuje je w narzędziu TCM StrongBox. Wymaga zarejestrowania adresu URL wywołania zwrotnego w ustawieniach aplikacji OAuth GitHub.

function completeGitHubAuth(project: string, code: string): Promise<string>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

code: string

Kod autoryzacji zwrócony przez GitHub po wyrażeniu zgody użytkownika

Zwraca

Promise<string>

createAnalysis(TestSessionAnalysis[], string, number)

Tworzy obiekt Analizy sesji w magazynie danych TCM dla danej sesji

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

Parametry

analysis: TestSessionAnalysis[]

Szczegóły analizy sesji

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji do dodania powiadomienia

Zwraca

Promise<AnalysisFailureGroupReturn[]>

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Tworzy załącznik w magazynie dzienników dla określonego identyfikatora buildId.

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

Zawiera informacje o załączniku, takie jak strumień, nazwa pliku, komentarz, typ załącznika

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

BuildId

Zwraca

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Tworzy obiekt Environment w magazynie danych TCM

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

Parametry

environments: TestSessionEnvironment[]

Odebrano obiekt Środowiska.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Dla podanego identyfikatora sessionId tworzy obiekty środowiska, konfiguracji i maszyny w magazynie danych TCM

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

Parametry

sessionEnvironmentAndMachine: SessionEnvironmentAndMachine

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Zwraca

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Tworzy nowy typ niepowodzenia testu

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

Parametry

testResultFailureType: TestResultFailureTypeRequestModel

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultFailureType>

createNotification(TestSessionNotification[], string, number)

Tworzy obiekt Notification w magazynie danych TCM dla danej sesji

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

Parametry

notifications: TestSessionNotification[]

Powiadomienia do dodania dla określonego identyfikatora sessionId

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji do dodania powiadomienia

Zwraca

Promise<number[]>

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

iterationId: number

actionPath: string

Zwraca

Promise<TestAttachmentReference>

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

Zwraca

Promise<TestAttachmentReference>

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Rejestruje metadane załącznika testowego na poziomie wyniku, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.

function createTestResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

Zwraca

Promise<TestAttachmentReference>

createTestResultMachines(TestResultMachine[], string, number)

Tworzy maszyny wyników testów dla podanego identyfikatora TestRunId

function createTestResultMachines(testResultMachines: TestResultMachine[], project: string, runId: number): Promise<void>

Parametry

testResultMachines: TestResultMachine[]

Lista maszyn dla wyników testów w przebiegu

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator elementu TestRun, aby dodać maszyny dla

Zwraca

Promise<void>

createTestRun(RunCreateModel, string)

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

Parametry

testRun: RunCreateModel

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestAttachmentReference>

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Rejestruje metadane załącznika testowego na poziomie uruchomienia, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.

function createTestRunAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Parametry

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestAttachmentReference>

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Tworzy załącznik w magazynie dzienników dla określonego identyfikatora runId.

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

Zawiera informacje o załączniku, takie jak strumień, nazwa pliku, komentarz, typ załącznika

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

Zwraca

Promise<TestLogStoreAttachmentReference>

createTestSession(TestResultsSession, string)

Tworzy obiekt TestResultsSession w magazynie danych TCM

function createTestSession(session: TestResultsSession, project: string): Promise<number>

Parametry

session: TestResultsSession

Odebrano obiekt sesji.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<number>

createTestSettings(TestSettings, string)

function createTestSettings(testSettings: TestSettings, project: string): Promise<number>

Parametry

testSettings: TestSettings

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<number>

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentRequestModel: TestAttachmentRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

testSubResultId: number

Zwraca

Promise<TestAttachmentReference>

createTestSubResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number, number)

Rejestruje metadane dla załącznika testowego na poziomie podwyniku, którego zawartość została już przesłana do pamięci dedepowanej przez wywołującego. Żądanie zawiera jedynie metadane załącznika (identyfikator dedup, rozmiar, nazwa pliku, typ itp.) i nie zawiera bajtów plików.

function createTestSubResultAttachmentMetadata(attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>

Parametry

attachmentMetadataRequestModel: TestAttachmentMetadataRequestModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

testSubResultId: number

Zwraca

Promise<TestAttachmentReference>

deleteCustomFieldById(string, number)

Zwraca szczegóły pola testu niestandardowego dla określonego elementu testExtensionFieldId.

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testExtensionFieldId: number

Niestandardowy identyfikator pola testowego, który musi zostać usunięty.

Zwraca

Promise<void>

deleteFailureType(string, number)

Usuwa typ błędu testu z określonym identyfikatorem failureTypeId

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

failureTypeId: number

Zwraca

Promise<void>

deleteFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

Usuwanie błędnych identyfikatorów referencyjnych przypadków testowych według informacji o gałęziach i repozytoriach

function deleteFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<number>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

Guid repozytorium

branchInfo: BranchInfo

Informacje o gałęziach zawierające nazwę i typ Uwaga: Operacje na chronionych gałęziach, takich jak "master" lub "main", nie są obsługiwane.

Zwraca

Promise<number>

deleteTestMethodToWorkItemLink(string, string, number)

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testName: string

workItemId: number

Zwraca

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

Zwraca

Promise<void>

deleteTestRun(string, number)

function deleteTestRun(project: string, runId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<void>

deleteTestRunAttachment(string, number, number)

function deleteTestRunAttachment(project: string, runId: number, attachmentId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

attachmentId: number

Zwraca

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Usuwa załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.

function deleteTestRunLogStoreAttachment(project: string, runId: number, filename: string): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

filename: string

Nazwa pliku załącznika

Zwraca

Promise<void>

deleteTestSettings(string, number)

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testSettingsId: number

Zwraca

Promise<void>

enhanceCoverage(string, string, number)

Klikalny punkt wejściowy dla linku "Enhance diff coverage" wyświetlany w komentarzach dotyczących relacji PR. Wysyła zadanie coverage_test_generation do ADOAgenticService dla danego pull request i przekierowuje użytkownika z powrotem na stronę pull request.

function enhanceCoverage(project: string, repository: string, pullRequestId: number): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repository: string

pullRequestId: number

Zwraca

Promise<void>

fetchSourceCodeCoverageReport(string, number)

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Zwraca

Promise<SourceViewBuildCoverage[]>

generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Generuje ręczny plan testu na podstawie zadania pracy za pomocą AI. Jeśli użytkownik nie ma ważnego tokena Copilot, zwraca needsAuth=true z uwierzytelniającym URL zamiast kolejkować zadanie.

function generateTestPlanFromWorkItem(generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel, project: string, workItemId: number): Promise<boolean>

Parametry

generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel

project: string

Identyfikator projektu lub nazwa projektu

workItemId: number

Zwraca

Promise<boolean>

getAfdTcmEndpoint(string)

function getAfdTcmEndpoint(key: string): Promise<string>

Parametry

key: string

Zwraca

Promise<string>

getBranchesByFlakyTestCaseRefId(string, number)

Pobierz listę gałęzi, w których identyfikator odwołania do przypadku testowego został usunięty

function getBranchesByFlakyTestCaseRefId(project: string, testCaseReferenceId: number): Promise<TestCaseFlakinessBranchInfo>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testCaseReferenceId: number

Identyfikator referencyjny testu używany przez wynik testu

Zwraca

Promise<TestCaseFlakinessBranchInfo>

getBugsLinkedToTestResult(string, number, number)

function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

Zwraca

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

flags: number

Zwraca

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Żądanie: identyfikator kompilacji i identyfikator kompilacji różnicowej (opcjonalnie)

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

deltaBuildId: number

Zwraca

Promise<CodeCoverageSummary>

getCoverageStatusBadge(string, string, string, string)

<p>Pobiera stan pokrycia dla ostatniej pomyślnej kompilacji definicji, opcjonalnie o określonym zakresie dla określonej gałęzi</p>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definition: string

Identyfikator lub nazwa definicji.

branchName: string

Nazwa gałęzi.

label: string

Ciąg, aby zastąpić tekst domyślny po lewej stronie wskaźnika.

Zwraca

Promise<string>

getFailureTypes(string)

Zwraca listę typów niepowodzeń testów.

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultFailureType[]>

getFileLevelCodeCoverage(FileCoverageRequest, string)

Pobieranie pokrycia pliku dla określonego pliku

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

Parametry

fileCoverageRequest: FileCoverageRequest

Szczegóły pliku z kontekstem iteracji żądania ściągnięcia

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<string>

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

function getFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<TestCaseFlakinessBranchInfo[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repositoryId: string

branchInfo: BranchInfo

Zwraca

Promise<TestCaseFlakinessBranchInfo[]>

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildDefinitionId: number

minBuildCreatedDate: Date

Zwraca

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

function getFlakyTestResultsByTestRun(project: string, runId: number): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestCaseResult[]>

getLatestTestResultsByTestCaseIds(TestCaseLatestResultsQuery, string)

Uzyskaj najnowsze wyniki dla każdego żądanego TestCaseId. Przypadki testowe, które nigdy nie zostały wykonane (bez wyniku w nieusuniętym przebiegu) są pomijane w odpowiedzi – dzwoniący traktuje ich brak jako "nigdy nie uruchomiony".

function getLatestTestResultsByTestCaseIds(query: TestCaseLatestResultsQuery, project: string): Promise<TestCaseLatestResult[]>

Parametry

query: TestCaseLatestResultsQuery

TestCaseLatestResultsQuery zawiera identyfikatory TestCaseId do sprawdzenia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestCaseLatestResult[]>

getResultGroupsByBuild(string, number, string, string[], string)

function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

publishContext: string

fields: string[]

continuationToken: string

Zwraca

Promise<PagedList<FieldDetailsForTestResults>>

getResultGroupsByRelease(string, number, string, number, string[], string)

function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

publishContext: string

releaseEnvId: number

fields: string[]

continuationToken: string

Zwraca

Promise<PagedList<FieldDetailsForTestResults>>

getSessionNotifications(string, number)

Pobiera obiekty powiadomień TestResultsSession w magazynie danych TCM

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji TestResults w celu uzyskania powiadomień.

Zwraca

Promise<TestSessionNotification[]>

getSimilarTestResults(string, number, number, number, number, String)

Pobiera listę wyników, których niepowodzenie jest zgodne z podanym.

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

identyfikator przebiegu testu

testResultId: number

identyfikator wyniku testu wewnątrz przebiegu testu

testSubResultId: number

identyfikator podwyrażenia wewnątrz wyniku testu

top: number

Maksymalna liczba wyników do zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<TestCaseResult[]>

getTestAgentToken()

Zwraca token GitHub OAuth obecnego użytkownika z uprawnieniami do dostępu do Interfejsy API funkcji Copilot, zamknięty za flagą funkcji.

function getTestAgentToken(): Promise<string>

Zwraca

Promise<string>

getTestIterationAttachmentContent(string, number, number, number, number)

Zwraca załącznik iteracji testowej

function getTestIterationAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Zwraca

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

Zwraca załącznik iteracji testowej

function getTestIterationAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

iterationId: number

Zwraca

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

Pobieranie listy załączników kompilacji — dokumentacja

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji do pobrania

type: TestLogType

typ załącznika do pobrania

directoryPath: string

ścieżka katalogu, dla której potrzebne są załączniki

fileNamePrefix: string

prefiks nazwy pliku do filtrowania listy załączników

fetchMetaData: boolean

Wartość domyślna to false, ustawiana, jeśli metadane są potrzebne

top: number

Liczba odwołań do załączników testowych w celu zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika kompilacji

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

build: number

Identyfikator kompilacji do pobrania

type: TestLogType

typ pliku

filePath: string

filePath, dla którego jest wymagany identyfikator URI sygnatury dostępu współdzielonego

Zwraca

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika wyników testu

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu, który zawiera wynik

resultId: number

Identyfikator wyniku testu, którego pliki należy pobrać

type: TestLogType

typ pliku

filePath: string

filePath, dla którego jest wymagany identyfikator URI sygnatury dostępu współdzielonego

Zwraca

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Pobieranie identyfikatora URI sygnatury dostępu współdzielonego załącznika przebiegu testu

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testowego, którego plik musi zostać pobrany

type: TestLogType

typ pliku

filePath: string

filePath, dla którego jest wymagany identyfikator URI sygnatury dostępu współdzielonego

Zwraca

Promise<TestLogStoreEndpointDetails>

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Uzyskiwanie identyfikatora URI sygnatury dostępu współdzielonego załącznika podwyłdania testowego

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu, który zawiera wynik

resultId: number

Identyfikator wyniku testu, który zawiera podwyrażenie

subResultId: number

Identyfikator podwyrażenia testowego, którego identyfikator URI sygnatury dostępu współdzielonego pliku jest wymagany

type: TestLogType

typ pliku

filePath: string

filePath, dla którego jest wymagany identyfikator URI sygnatury dostępu współdzielonego

Zwraca

Promise<TestLogStoreEndpointDetails>

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

Pobierz podsumowanie wyników testu.

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

pipelineId: number

Identyfikator potoku. Jest to takie samo, jak identyfikator kompilacji.

stageName: string

Nazwa etapu. Maksymalna obsługiwana długość nazwy to 256 znaków.

phaseName: string

Nazwa fazy. Maksymalna obsługiwana długość nazwy to 256 znaków.

jobName: string

Macierz w języku YAML generuje kopie zadania z różnymi danymi wejściowymi w macierzy. JobName to nazwa tych danych wejściowych. Maksymalna obsługiwana długość nazwy to 256 znaków.

metricNames: Metrics[]

groupByNode: boolean

Podsumowanie grupy dla każdego węzła spadkobiercy pipleine

Zwraca

Promise<PipelineTestMetrics>

getTestResultAttachmentContent(string, number, number, number)

Zwraca załącznik wyników testu

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

Zwraca

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

Zwraca

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

Zwraca załącznik wyników testu

function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

Zwraca

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

function getTestResultById(project: string, runId: number, testResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testResultId: number

detailsToInclude: ResultDetails

Zwraca

Promise<TestCaseResult>

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)

Pobierz podsumowanie wyników testów dla kompilacji. Aby pobrać pełną pełną wartość TestCaseResult, wywołaj metodę Results — Get.

function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Zwraca

Promise<TestResultsDetails>

getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)

function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

releaseEnvId: number

publishContext: string

groupBy: string

filter: string

orderby: string

shouldIncludeResults: boolean

queryRunSummaryForInProgress: boolean

Zwraca

Promise<TestResultsDetails>

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

Pobieranie listy załączników wyników testów

function getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu, który zawiera wynik

resultId: number

Identyfikator wyniku testu

type: TestLogType

typ załączników do pobrania

directoryPath: string

ścieżka katalogu załączników do pobrania

fileNamePrefix: string

prefiks nazwy pliku do filtrowania listy załączników

fetchMetaData: boolean

Wartość domyślna to false, ustawiana, jeśli metadane są potrzebne

top: number

Liczba odwołań załączników w celu zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<TestLog>>

getTestResultMachines(string, number)

Pobiera maszyny wyników testów dla podanego identyfikatora TestRunId

function getTestResultMachines(project: string, runId: number): Promise<TestResultMachine[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator elementu TestRun, aby dodać maszyny dla

Zwraca

Promise<TestResultMachine[]>

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Zwraca

Promise<TestCaseResult[]>

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)

function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Zwraca

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)

Pobierz listę wyników.

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

pipelineId: number

Identyfikator potoku. Jest to takie samo, jak identyfikator kompilacji.

stageName: string

Nazwa etapu. Maksymalna obsługiwana długość nazwy to 256 znaków.

phaseName: string

Nazwa fazy. Maksymalna obsługiwana długość nazwy to 256 znaków.

jobName: string

Macierz w języku YAML generuje kopie zadania z różnymi danymi wejściowymi w macierzy. JobName to nazwa tych danych wejściowych. Maksymalna obsługiwana długość nazwy to 256 znaków.

outcomes: TestOutcome[]

Lista wyników

includeAllBuildRuns: boolean

Czy należy uwzględnić przebiegi testowe ze wszystkich przebiegów kompilacji, czy nie.

top: number

Maksymalna liczba wyników do zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Pobiera pełne obiekty TestCaseResult ze szczegółami 1MRX dla podanego identyfikatora pipelineId

function getTestResultsByPipelineMRX(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestCaseResult>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

pipelineId: number

Identyfikator potoku. Jest to takie samo, jak identyfikator kompilacji.

stageName: string

Nazwa etapu. Maksymalna obsługiwana długość nazwy to 256 znaków.

phaseName: string

Nazwa fazy. Maksymalna obsługiwana długość nazwy to 256 znaków.

jobName: string

Macierz w języku YAML generuje kopie zadania z różnymi danymi wejściowymi w macierzy. JobName to nazwa tych danych wejściowych. Maksymalna obsługiwana długość nazwy to 256 znaków.

outcomes: TestOutcome[]

Lista wyników

includeAllBuildRuns: boolean

Czy należy uwzględnić przebiegi testowe ze wszystkich przebiegów kompilacji, czy nie. Wartość domyślna to fałsz.

top: number

Maksymalna liczba wyników do zwrócenia. Wartość domyślna to 10000.

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<TestCaseResult>>

getTestResultsByQuery(TestResultsQuery, string)

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

Parametry

query: TestResultsQuery

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

Parametry

queryModel: QueryModel

project: string

Identyfikator projektu lub nazwa projektu

includeResultDetails: boolean

includeIterationDetails: boolean

skip: number

top: number

Zwraca

Promise<TestCaseResult[]>

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)

function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

releaseEnvid: number

publishContext: string

outcomes: TestOutcome[]

top: number

continuationToken: string

Zwraca

Promise<PagedList<ShallowTestCaseResult>>

getTestResultsSettings(string, TestResultsSettingsType)

Pobieranie danych TestResultsSettings

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

settingsType: TestResultsSettingsType

Zwraca

Promise<TestResultsSettings>

getTestResultWorkItemsById(string, number, number)

function getTestResultWorkItemsById(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

Zwraca

Promise<WorkItemReference[]>

getTestRunAttachmentContent(string, number, number)

Zwraca załącznik przebiegu testu

function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

attachmentId: number

Zwraca

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestAttachment[]>

getTestRunAttachmentUploadDetails(string, number)

Wstępne uruchomienie załącznika bezpośrednio do BlobStore: wymusza zezwolenie na publikację i zwraca domenę dedup do publikacji. Agent wywołuje to przed przesłaniem bajtów.

function getTestRunAttachmentUploadDetails(project: string, runId: number): Promise<TestAttachmentUploadDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestAttachmentUploadDetails>

getTestRunAttachmentZip(string, number, number)

Zwraca załącznik przebiegu testu

function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

attachmentId: number

Zwraca

Promise<ArrayBuffer>

getTestRunById(string, number, boolean, boolean)

function getTestRunById(project: string, runId: number, includeDetails?: boolean, includeTags?: boolean): Promise<TestRun>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

includeDetails: boolean

includeTags: boolean

Zwraca

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

flags: number

Zwraca

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

Pobieranie listy załączników przebiegu testów

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

type: TestLogType

typ załączników do pobrania

directoryPath: string

ścieżka katalogu, dla której potrzebne są załączniki

fileNamePrefix: string

prefiks nazwy pliku do filtrowania listy załączników

fetchMetaData: boolean

Wartość domyślna to false, ustawiana, jeśli metadane są potrzebne

top: number

Liczba odwołań załączników do zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Zwraca załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

filename: string

Nazwa pliku załącznika

Zwraca

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Zwraca listę załączników dla określonego identyfikatora runId z magazynu dzienników.

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

Zwraca

Promise<TestLogStoreAttachment[]>

getTestRunLogStoreAttachmentZip(string, number, string)

Zwraca załącznik z określoną nazwą pliku dla określonego identyfikatora runId z magazynu dzienników.

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu

filename: string

Nazwa pliku załącznika

Zwraca

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

Pobieranie dzienników komunikatów przebiegu testu

function getTestRunMessageLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu do pobrania.

Zwraca

Promise<TestMessageLogDetails[]>

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildUri: string

owner: string

tmiRunId: string

planId: number

includeRunDetails: boolean

automated: boolean

skip: number

top: number

Zwraca

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

Pobiera przebiegi testów skojarzone z sesją

function getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji TestResults w celu uzyskania przebiegów testów.

Zwraca

Promise<number[]>

getTestRunStatistics(string, number)

Pobierz statystyki przebiegu testu , używane, gdy chcemy uzyskać podsumowanie przebiegu według wyniku.

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu do pobrania.

Zwraca

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

Pobierz podsumowanie przebiegu testu, używane, gdy chcemy uzyskać podsumowanie przebiegu według wyniku. Przebieg testu powinien być w stanie ukończonym.

function getTestRunSummaryByOutcome(project: string, runId: number): Promise<TestRunStatistic>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu do pobrania.

Zwraca

Promise<TestRunStatistic>

getTestSession(string, number)

Pobiera obiekt metadanych TestResultsSession w magazynie danych TCM

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Zwraca

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Pobiera obiekt Układu TestResultsSession w magazynie danych TCM

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

sessionId: string

Zwraca

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Pobiera obiekt Układu TestResultsSession w magazynie danych TCM

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Pobieranie obiektu sesji.

Zwraca

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestSessionResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

detailsToInclude: ResultDetails

skip: number

top: number

outcomes: TestOutcome[]

newTestsOnly: boolean

Zwraca

Promise<TestCaseResult[]>

getTestSettingsById(string, number)

function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testSettingsId: number

Zwraca

Promise<TestSettings>

getTestSubResultAttachmentContent(string, number, number, number, number)

Zwraca załącznik wyników podrzędnych testu

function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Zwraca

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

Zwraca odwołania do załączników dla wyniku podrzędnego testu.

function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

testSubResultId: number

Zwraca

Promise<TestAttachment[]>

getTestSubResultAttachmentZip(string, number, number, number, number)

Zwraca załącznik wyników podrzędnych testu

function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentId: number

testSubResultId: number

Zwraca

Promise<ArrayBuffer>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

Pobieranie listy odwołań do załączników podrzędnych testów

function getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu, który zawiera wyniki

resultId: number

Identyfikator wyniku testu, który zawiera podwyrażenie

subResultId: number

Identyfikator podresultu testowego

type: TestLogType

typ załączników do pobrania

directoryPath: string

ścieżka katalogu załącznika do pobrania

fileNamePrefix: string

prefiks nazwy pliku do filtrowania listy załączników

fetchMetaData: boolean

Wartość domyślna to false, ustawiana, jeśli metadane są potrzebne

top: number

Liczba odwołań załączników do zwrócenia

continuationToken: String

Nagłówek umożliwiający przekazanie tokenu kontynuacji

Zwraca

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Pobierz wszystkie tagi w kompilacji.

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji

Zwraca

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

Pobierz wszystkie tagi w wersji.

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania

releaseEnvId: number

Identyfikator środowiska wydania

Zwraca

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Pobierz wszystkie tagi w kompilacji.

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji

Zwraca

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

Pobierz wszystkie tagi w wersji.

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

Identyfikator wydania

releaseEnvId: number

Identyfikator środowiska wydania

Zwraca

Promise<TestTagSummary>

getTestWeightedScoreByTestRun(string, string, boolean, boolean)

Oblicz ważony wynik testu dla podanej listy ID testów podzielonej na komany.

function getTestWeightedScoreByTestRun(project: string, runIds: string, includeAllOutcomes?: boolean, onlyFlakyResults?: boolean): Promise<TestCaseResult[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runIds: string

Koman rozdzielił identyfikatory testowe. Maksymalnie 100 obsługiwanych.

includeAllOutcomes: boolean

Dołącz wszystkie wyniki testów do obliczeń TWS. Domyślnie uważa się fałsz

onlyFlakyResults: boolean

Opcja zwracania tylko niestabilnych wyników testów zidentyfikowanych jako niestabilne. Domyślnie prawda jest przekazywana

Zwraca

Promise<TestCaseResult[]>

publishTestResultDocument(TestResultDocument, string, number)

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

Parametry

document: TestResultDocument

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestResultDocument>

queryCustomFields(string, CustomTestFieldScope)

Zwraca listę niestandardowych pól testowych dla danego niestandardowego zakresu pola testowego.

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

scopeFilter: CustomTestFieldScope

Zakres niestandardowych pól testowych, które mają być zwracane.

Zwraca

Promise<CustomTestFieldDefinition[]>

queryResultTrendForBuild(TestResultTrendFilter, string)

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametry

filter: TestResultTrendFilter

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<AggregatedDataForResultTrend[]>

queryResultTrendForRelease(TestResultTrendFilter, string)

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Parametry

filter: TestResultTrendFilter

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<AggregatedDataForResultTrend[]>

queryTestHistory(TestHistoryQuery, string)

Uzyskiwanie historii metody testowej przy użyciu metody TestHistoryQuery

function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>

Parametry

filter: TestHistoryQuery

TestHistoryQuery w celu uzyskania historii

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

testName: string

Zwraca

Promise<TestToWorkItemLinks>

queryTestResultAttachmentsMetadata(string, number, number, string, string, number, boolean)

Zwraca metadane dla załączników testowych na poziomie wyniku, wspieranych przez BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu.

function queryTestResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Zwraca

Promise<BlobStoreTestAttachment[]>

queryTestResultHistory(ResultsFilter, string)

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

Parametry

filter: ResultsFilter

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultHistory>

queryTestResultsMetaData(string[], string, ResultMetaDataDetails)

Pobieranie listy szczegółów metadanych wyników testu dla odpowiednich identyfikatorów testcasereferenceId

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

Parametry

testCaseReferenceIds: string[]

TestCaseReference Ids wyniku testu do odpytowania, rozdzielona przecinkami lista prawidłowych identyfikatorów (limit nr identyfikatorów 200).

project: string

Identyfikator projektu lub nazwa projektu

detailsToInclude: ResultMetaDataDetails

Szczegóły do uwzględnienia z metadanymi wyników testów. Wartość domyślna to Brak. Inne wartości to FlakyIdentifiers.

Zwraca

Promise<TestResultMetaData[]>

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)

function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

publishContext: string

includeFailureDetails: boolean

buildToCompare: BuildReference

Zwraca

Promise<TestResultSummary>

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

Pobierz podsumowanie wyników testu.

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

pipelineId: number

Identyfikator potoku. Jest to takie samo, jak identyfikator kompilacji.

stageName: string

Nazwa etapu. Maksymalna obsługiwana długość nazwy to 256 znaków.

phaseName: string

Nazwa fazy. Maksymalna obsługiwana długość nazwy to 256 znaków.

jobName: string

Macierz w języku YAML generuje kopie zadania z różnymi danymi wejściowymi w macierzy. JobName to nazwa tych danych wejściowych. Maksymalna obsługiwana długość nazwy to 256 znaków.

includeFailureDetails: boolean

Jeśli wartość true zwraca szczegółowe informacje o błędach

Zwraca

Promise<TestResultSummary>

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)

function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

releaseId: number

releaseEnvId: number

publishContext: string

includeFailureDetails: boolean

releaseToCompare: ReleaseReference

Zwraca

Promise<TestResultSummary>

queryTestResultsSummaryForReleases(ReleaseReference[], string)

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

Parametry

releases: ReleaseReference[]

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultSummary[]>

queryTestResultWorkItems(string, string, string, number, Date, number, number)

Działanie wyników testu zapytania na podstawie filtru

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

workItemCategory: string

może przyjmować wartości Microsoft.BugCategory lub all(w przypadku pobierania wszystkich elementów roboczych)

automatedTestName: string

testCaseId: number

maxCompleteDate: Date

days: number

workItemCount: number

Zwraca

Promise<WorkItemReference[]>

queryTestRunAttachmentsMetadata(string, number, string, string, number, boolean)

Zwraca metadane dla załączników testowych na poziomie uruchomienia opartych na BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu. Agent używa tego do wyliczania logów testowych BlobStore (dedup), które nie występują w klasycznym kontenerze LogStore SAS i dlatego nie mogą być bezpośrednio wypisane przez agenta.

function queryTestRunAttachmentsMetadata(project: string, runId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Zwraca

Promise<BlobStoreTestAttachment[]>

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)

Testy zapytań są uruchamiane na podstawie filtrów. Obowiązkowe pola to minLastUpdatedDate i maxLastUpdatedDate.

function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, sortOrder?: TestRunSortOrderType, continuationToken?: string): Promise<PagedList<TestRun>>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

minLastUpdatedDate: Date

Minimalna data ostatniej modyfikacji przebiegu do wykonania zapytania (obowiązkowe).

maxLastUpdatedDate: Date

Maksymalna data ostatniej modyfikacji przebiegu do wykonania zapytania (obowiązkowe, różnica między minimalną i maksymalną datą może wynosić maksymalnie 7 dni).

state: TestRunState

Bieżący stan przebiegów do odpytowania.

planIds: number[]

Identyfikatory planu przebiegów do odpytowania, rozdzielona przecinkami lista prawidłowych identyfikatorów.

isAutomated: boolean

Typ automatyzacji przebiegów do odpytowania.

publishContext: TestRunPublishContext

Funkcja PublishContext przebiegów do odpytowania.

buildIds: number[]

Identyfikatory kompilacji przebiegów do wykonania zapytania, rozdzielona przecinkami lista prawidłowych identyfikatorów.

buildDefIds: number[]

Identyfikatory definicji kompilacji przebiegów do odpytowania, rozdzielone przecinkami listę prawidłowych identyfikatorów.

branchName: string

Nazwa gałęzi źródłowej przebiegów do odpytowania.

releaseIds: number[]

Identyfikatory wydania przebiegów do odpytowania, rozdzielona przecinkami lista prawidłowych identyfikatorów.

releaseDefIds: number[]

Identyfikatory definicji wydania przebiegów do odpytowania, rozdzielone przecinkami listę prawidłowych identyfikatorów.

releaseEnvIds: number[]

Identyfikatory środowiska wydania przebiegów do odpytowania, rozdzielone przecinkami listę prawidłowych identyfikatorów.

releaseEnvDefIds: number[]

Identyfikatory definicji środowiska wydania dla przebiegów do odpytowania, rozdzielone przecinkami listę prawidłowych identyfikatorów.

runTitle: string

Uruchom tytuł przebiegów do odpytowania.

top: number

Liczba przebiegów do odpytowania. Limit to 100

sortOrder: TestRunSortOrderType

Kolejność sortowania według lastUpdated dla przebiegów testów.

continuationToken: string

continuationToken odebrany z poprzedniej partii lub null dla pierwszej partii. Nie ma zostać utworzony (lub zmieniony, jeśli otrzymany z ostatniej partii) przez użytkownika.

Zwraca

Promise<PagedList<TestRun>>

queryTestSubResultAttachmentsMetadata(string, number, number, number, string, string, number, boolean)

Zwraca metadane dla załączników testowych na poziomie podwyników, wspieranych przez BlobStore, których nazwa pliku zaczyna się od fileNamePrefiks lub pojedynczy załącznik identyfikowany przez attachmentId po jego podaniu.

function queryTestSubResultAttachmentsMetadata(project: string, runId: number, testCaseResultId: number, testSubResultId: number, attachmentType?: string, fileNamePrefix?: string, attachmentId?: number, fetchMetaData?: boolean): Promise<BlobStoreTestAttachment[]>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

testCaseResultId: number

testSubResultId: number

attachmentType: string

fileNamePrefix: string

attachmentId: number

fetchMetaData: boolean

Zwraca

Promise<BlobStoreTestAttachment[]>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

Parametry

resultsContext: TestResultsContext

project: string

Identyfikator projektu lub nazwa projektu

workItemIds: number[]

Zwraca

Promise<TestSummaryForWorkItem[]>

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Tworzenie i pobieranie identyfikatora URI sygnatury dostępu współdzielonego kontenera kompilacji

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji do pobrania

testLogStoreOperationType: TestLogStoreOperationType

Typ operacji do wykonania przy użyciu identyfikatora URI sygnatury dostępu współdzielonego

Zwraca

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Utwórz pusty plik dla wyniku i pobierz identyfikator URI sygnatury dostępu współdzielonego dla pliku

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu testu, który zawiera wynik

resultId: number

Identyfikator wyników testu, który zawiera wynik podrzędny

subResultId: number

Identyfikator wyniku podrzędnego testu, którego identyfikator URI sygnatury dostępu współdzielonego pliku jest wymagany

filePath: string

ścieżka pliku wewnątrz wyniku podrzędnego, dla którego wymagany jest identyfikator URI sygnatury dostępu współdzielonego

type: TestLogType

Typ pliku do pobrania

Zwraca

Promise<TestLogStoreEndpointDetails>

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Tworzenie pustego pliku dla przebiegu i uzyskiwanie identyfikatora URI sygnatury dostępu współdzielonego dla pliku

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator przebiegu w celu uzyskania szczegółów punktu końcowego

testLogStoreOperationType: TestLogStoreOperationType

Typ operacji do wykonania przy użyciu identyfikatora URI sygnatury dostępu współdzielonego

filePath: string

ścieżka pliku w celu utworzenia pustego pliku

type: TestLogType

Wartość domyślna to GeneralAttachment, typ pustego pliku do utworzenia

Zwraca

Promise<TestLogStoreEndpointDetails>

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

Pobierz szczegóły wszystkich dostępnych grup, a dla tych grup nie powiodło się i przerwano wyniki.

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

pipelineId: number

Identyfikator potoku. Jest to takie samo, jak identyfikator kompilacji.

stageName: string

Nazwa etapu. Maksymalna obsługiwana długość nazwy to 256 znaków.

phaseName: string

Nazwa fazy. Maksymalna obsługiwana długość nazwy to 256 znaków.

jobName: string

Macierz w języku YAML generuje kopie zadania z różnymi danymi wejściowymi w macierzy. JobName to nazwa tych danych wejściowych. Maksymalna obsługiwana długość nazwy to 256 znaków.

shouldIncludeFailedAndAbortedResults: boolean

Jeśli wartość true, zwróci identyfikatory niepomyślnie i przerwane wyniki dla każdej grupy testowej

queryGroupSummaryForInProgress: boolean

Jeśli wartość true, obliczy również podsumowanie dla przebiegów inprogress.

Zwraca

Promise<TestResultsDetails>

triggerTestAgent(TestAgentTriggerRequest, string)

function triggerTestAgent(request: TestAgentTriggerRequest, project: string): Promise<boolean>

Parametry

request: TestAgentTriggerRequest

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<boolean>

updateCodeCoverageSummary(string, number, CodeCoverageData)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Żądanie: Json podsumowania pokrycia kodu

function updateCodeCoverageSummary(project: string, buildId: number, coverageData?: CodeCoverageData): Promise<void>

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

coverageData: CodeCoverageData

Zwraca

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

Zwraca szczegóły pola testu niestandardowego, które jest aktualizowane.

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

Parametry

updateCustomTestField: CustomTestFieldUpdateDefinition

Niestandardowe pole testowe, które należy zaktualizować.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<CustomTestFieldDefinition>

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

Aktualizowanie ustawień projektu wyników testów

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

Parametry

testResultsUpdateSettings: TestResultsUpdateSettings

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TestResultsSettings>

updateTestResults(TestCaseResult[], string, number)

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Parametry

results: TestCaseResult[]

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Aktualizowanie właściwości metadanych wyników testu

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

Parametry

testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput

TestResultMetaData aktualizacji danych wejściowych TestResultMetaDataUpdateInput

project: string

Identyfikator projektu lub nazwa projektu

testCaseReferenceId: number

TestCaseReference Id wyniku testu, który ma zostać zaktualizowany.

Zwraca

Promise<TestResultMetaData>

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Tworzy obiekty TestResultsMRX w magazynie danych TCM dla istniejących wyników testów

function updateTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<number[]>

Parametry

results: TestCaseResult[]

Obiekt results z tylko właściwościami MRX wyników testu i istniejącymi wartościami testResultId

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator RunId przebiegu testu

Zwraca

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

Parametry

runUpdateModel: RunUpdateModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Zwraca

Promise<TestRun>

updateTestRunsBySessionId(TestSessionTestRun, string, number)

Przebiegi testów aktualizacji skojarzone z sesją

function updateTestRunsBySessionId(testRunIds: TestSessionTestRun, project: string, sessionId: number): Promise<number[]>

Parametry

testRunIds: TestSessionTestRun

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji TestResults w celu zaktualizowania przebiegów testów.

Zwraca

Promise<number[]>

updateTestRunTags(TestTagsUpdateModel, string, number)

Aktualizowanie tagów przebiegu. Tagi można dodawać i usuwać

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

Parametry

testTagsUpdateModel: TestTagsUpdateModel

TestTagsUpdateModel

project: string

Identyfikator projektu lub nazwa projektu

runId: number

Identyfikator RunId przebiegu

Zwraca

Promise<TestTag[]>

updateTestSession(TestResultsSession, string, number)

Aktualizuje obiekt sesji testowej skojarzony z identyfikatorem sessionId

function updateTestSession(session: TestResultsSession, project: string, sessionId: number): Promise<number>

Parametry

session: TestResultsSession

Aktualizowanie obiektu sesji

project: string

Identyfikator projektu lub nazwa projektu

sessionId: number

Identyfikator sesji TestResults w celu zaktualizowania obiektu sesji testowej.

Zwraca

Promise<number>

TestResultsRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

TestResultsRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

addCustomFields(CustomTestFieldDefinition[], string)

Parametry

Zwraca

addTestResultsToTestRun(TestCaseResult[], string, number)

Parametry

Zwraca

addTestResultsToTestRunSession(TestCaseResult[], string, number)

Parametry

Zwraca

addWorkItemToTestLinks(WorkItemToTestLinks, string)

Parametry

Zwraca

callbackTestAgent(TestAgentCallbackRequest, string)

Parametry

Zwraca

completeGitHubAuth(string, string)

Parametry

Zwraca

createAnalysis(TestSessionAnalysis[], string, number)

Parametry

Zwraca

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

Parametry

Zwraca

createEnvironment(TestSessionEnvironment[], string)

Parametry

Zwraca

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Parametry

Zwraca

createFailureType(TestResultFailureTypeRequestModel, string)

Parametry

Zwraca

createNotification(TestSessionNotification[], string, number)

Parametry

Zwraca

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Parametry

Zwraca

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Parametry

Zwraca

createTestResultAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number, number)

Parametry

Zwraca

createTestResultMachines(TestResultMachine[], string, number)

Parametry

Zwraca

createTestRun(RunCreateModel, string)

Parametry

Zwraca

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Parametry

Zwraca

createTestRunAttachmentMetadata(TestAttachmentMetadataRequestModel, string, number)

Parametry

Zwraca

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Parametry

Zwraca

createTestSession(TestResultsSession, string)

Parametry

Zwraca

createTestSettings(TestSettings, string)

Parametry

Zwraca

createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Parametry

Zwraca