다음을 통해 공유


TestRestClient class

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

생성자

TestRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)

도구 모음에 테스트 사례를 추가합니다.

addTestResultsToTestRun(TestCaseResult[], string, number)

테스트 실행에 테스트 결과를 추가합니다.

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

테스트 단계 결과에 파일 첨부

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

테스트 결과에 파일을 첨부합니다.

createTestRun(RunCreateModel, string)

새 테스트 실행을 만듭니다.

createTestRunAttachment(TestAttachmentRequestModel, string, number)

테스트 실행에 파일을 첨부합니다.

createTestSession(TestSession, TeamContext)

테스트 세션 만들기

createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

테스트 결과에 파일 연결

deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)

테스트 사례를 삭제합니다.

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)

ID로 실행되는 테스트를 삭제합니다.

deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)

빌드에 대한 코드 검사 데이터를 가져옵니다.

getCodeCoverageSummary(string, number, number)

빌드에 대한 코드 검사 요약을 가져옵니다.

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)

테스트 지점을 가져옵니다.

getPoints(string, number, number, string, string, string, string, boolean, number, number)

테스트 지점 목록을 가져옵니다.

getPointsByQuery(TestPointsQuery, string, number, number)

쿼리를 사용하여 테스트 지점을 가져옵니다.

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

테스트 결과 보존 설정 가져오기

getTestCaseById(string, number, number, number)

테스트 사례 ID가 있는 테스트 도구 모음에서 특정 테스트 사례를 가져옵니다.

getTestCases(string, number, number)

제품군에서 모든 테스트 사례를 가져옵니다.

getTestIteration(string, number, number, number, boolean)

결과에 대한 반복 가져오기

getTestIterations(string, number, number, boolean)

결과에 대한 반복 가져오기

getTestResultAttachmentContent(string, number, number, number)

ID로 테스트 결과 첨부 파일을 다운로드합니다.

getTestResultAttachments(string, number, number)

테스트 결과 첨부 파일 참조 목록을 가져옵니다.

getTestResultAttachmentZip(string, number, number, number)

ID로 테스트 결과 첨부 파일을 다운로드합니다.

getTestResultById(string, number, number, ResultDetails)

테스트 실행에 대한 테스트 결과를 가져옵니다.

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

테스트 실행에 대한 테스트 결과를 가져옵니다.

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

이 API는 특정 자동화된 테스트 메서드에 대해 지정된 필드/추세가 있는 ID별로 결과를 반환합니다. 여전히 이 API를 개선하고 있으며 적절한 서명 및 계약을 확정하지 않았습니다.

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

ID로 테스트 실행 첨부 파일을 다운로드합니다.

getTestRunAttachments(string, number)

테스트 실행 첨부 파일 참조 목록을 가져옵니다.

getTestRunAttachmentZip(string, number, number)

ID로 테스트 실행 첨부 파일을 다운로드합니다.

getTestRunById(string, number, boolean)

ID로 테스트를 실행합니다.

getTestRunCodeCoverage(string, number, number)

테스트 실행에 대한 코드 검사 데이터 가져오기

getTestRunLogs(string, number)

테스트 실행 메시지 로그 가져오기

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

테스트 실행 목록을 가져옵니다.

getTestRunStatistics(string, number)

결과별 실행 요약을 가져올 때 사용되는 테스트 실행 통계를 가져옵니다.

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

테스트 세션 목록 가져오기

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

테스트 하위 결과 첨부 파일 다운로드

getTestSubResultAttachments(string, number, number, number)

테스트 하위 결과 첨부 파일 목록 가져오기

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

테스트 하위 결과 첨부 파일 다운로드

publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)

TestHistoryQuery를 사용하여 테스트 메서드의 기록 가져오기

queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)

해당 testcasereferenceId에 대한 테스트 결과 메타 데이터 세부 정보 목록 가져오기

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)

필터를 기반으로 하는 쿼리 테스트 실행 필수 필드는 minLastUpdatedDate 및 maxLastUpdatedDate입니다.

queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)

테스트 사례와 연결된 테스트 지점은 테스트 도구 모음에서 제거됩니다. 테스트 사례 작업 항목이 시스템에서 삭제되지 않습니다. 테스트 사례를 영구적으로 삭제하려면 테스트 사례 리소스를 참조하세요.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 요청: 코드 검사 요약의 Json

updateResultRetentionSettings(ResultRetentionSettings, string)

테스트 결과 보존 설정 업데이트

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

도구 모음에서 테스트 사례 연결의 속성을 업데이트.

updateTestPoints(PointUpdateModel, string, number, number, string)

테스트 지점을 업데이트합니다.

updateTestResults(TestCaseResult[], string, number)

테스트 결과를 업데이트하면 테스트 실행이 실행됩니다.

updateTestRun(RunUpdateModel, string, number)

ID로 실행되는 테스트를 업데이트합니다.

updateTestSession(TestSession, TeamContext)

테스트 세션 업데이트

생성자 세부 정보

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

매개 변수

속성 세부 정보

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

속성 값

string

메서드 세부 정보

addCustomFields(CustomTestFieldDefinition[], string)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

addTestCasesToSuite(string, number, number, string)

도구 모음에 테스트 사례를 추가합니다.

function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

제품군을 포함하는 테스트 계획의 ID입니다.

suiteId

number

테스트 사례를 추가해야 하는 테스트 도구 모음의 ID입니다.

testCaseIds

string

제품군에 추가할 테스트 사례의 ID입니다. ID는 쉼표로 구분된 형식으로 지정됩니다.

반환

Promise<SuiteTestCase[]>

addTestResultsToTestRun(TestCaseResult[], string, number)

테스트 실행에 테스트 결과를 추가합니다.

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

매개 변수

results

TestCaseResult[]

추가할 테스트 결과 목록입니다.

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

추가할 테스트 결과에서 실행 ID를 테스트합니다.

반환

Promise<TestCaseResult[]>

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

매개 변수

workItemToTestLinks
WorkItemToTestLinks
project

string

프로젝트 ID 또는 프로젝트 이름

반환

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

테스트 단계 결과에 파일 첨부

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

매개 변수

attachmentRequestModel
TestAttachmentRequestModel

첨부 파일 세부 정보 TestAttachmentRequestModel

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

반복을 포함하는 테스트 결과의 ID

iterationId

number

테스트 결과 반복의 ID입니다.

actionPath

string

테스트 결과 작업 경로의 16진수 값입니다.

반환

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

테스트 결과에 파일을 첨부합니다.

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

매개 변수

attachmentRequestModel
TestAttachmentRequestModel

첨부 파일 세부 정보 TestAttachmentRequestModel

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

첨부 파일을 업로드해야 하는 테스트 결과의 ID입니다.

반환

createTestRun(RunCreateModel, string)

새 테스트 실행을 만듭니다.

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

매개 변수

testRun
RunCreateModel

실행 세부 정보 RunCreateModel

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

테스트 실행에 파일을 첨부합니다.

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

매개 변수

attachmentRequestModel
TestAttachmentRequestModel

첨부 파일 세부 정보 TestAttachmentRequestModel

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

첨부 파일을 업로드해야 하는 테스트 실행의 ID입니다.

반환

createTestSession(TestSession, TeamContext)

테스트 세션 만들기

function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

매개 변수

testSession
TestSession

만들기에 대한 테스트 세션 세부 정보

teamContext
TeamContext

작업에 대한 팀 컨텍스트

반환

Promise<TestSession>

createTestSettings(TestSettings, string)

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

매개 변수

testSettings
TestSettings
project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<number>

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

테스트 결과에 파일 연결

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

매개 변수

attachmentRequestModel
TestAttachmentRequestModel

첨부 파일 요청 모델.

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

하위 결과가 포함된 테스트 결과의 ID입니다.

testSubResultId

number

첨부 파일을 업로드해야 하는 테스트 하위 결과의 ID입니다.

반환

deleteSharedParameter(string, number)

function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

sharedParameterId

number

반환

Promise<void>

deleteSharedStep(string, number)

function deleteSharedStep(project: string, sharedStepId: number): Promise<void>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

sharedStepId

number

반환

Promise<void>

deleteTestCase(string, number)

테스트 사례를 삭제합니다.

function deleteTestCase(project: string, testCaseId: number): Promise<void>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

testCaseId

number

삭제할 테스트 사례의 ID입니다.

반환

Promise<void>

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

testName

string

workItemId

number

반환

Promise<boolean>

deleteTestRun(string, number)

ID로 실행되는 테스트를 삭제합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

삭제할 실행의 ID입니다.

반환

Promise<void>

deleteTestSettings(string, number)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

testSettingsId

number

반환

Promise<void>

getBugsLinkedToTestResult(string, number, number)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

testCaseResultId

number

반환

Promise<WorkItemReference[]>

getBuildCodeCoverage(string, number, number)

빌드에 대한 코드 검사 데이터를 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

코드 검사 데이터를 가져와야 하는 빌드의 ID입니다.

flags

number

플래그 값은 가져올 코드 검사 세부 정보의 수준을 결정합니다. 플래그는 가산적입니다. 예상 값은 모듈의 경우 1, 함수의 경우 2, BlockData의 경우 4입니다.

반환

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

빌드에 대한 코드 검사 요약을 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

코드 검사 데이터를 가져와야 하는 빌드의 ID입니다.

deltaBuildId

number

Delta Build ID(선택 사항)

반환

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>

매개 변수

workItemQuery
LinkedWorkItemsQuery
project

string

프로젝트 ID 또는 프로젝트 이름

반환

getPoint(string, number, number, number, string)

테스트 지점을 가져옵니다.

function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

테스트 계획의 ID입니다.

suiteId

number

점이 포함된 제품군의 ID입니다.

pointIds

number

가져올 테스트 지점의 ID입니다.

witFields

string

작업 항목 필드 이름의 쉼표로 구분된 목록입니다.

반환

Promise<TestPoint>

getPoints(string, number, number, string, string, string, string, boolean, number, number)

테스트 지점 목록을 가져옵니다.

function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

테스트 계획의 ID입니다.

suiteId

number

점이 포함된 제품군의 ID입니다.

witFields

string

작업 항목 필드 이름의 쉼표로 구분된 목록입니다.

configurationId

string

특정 구성에 대한 테스트 지점을 가져옵니다.

testCaseId

string

configurationId가 설정되지 않은 경우 유효한 특정 테스트 사례에 대한 테스트 지점을 가져옵니다.

testPointIds

string

configurationId 및 testCaseId가 설정되지 않은 경우에만 유효한 쉼표로 구분된 테스트 지점 ID 목록에 대한 테스트 지점을 가져옵니다.

includePointDetails

boolean

테스트 지점에 대한 모든 속성을 포함합니다.

skip

number

건너뛸 테스트 지점의 수입니다.

top

number

반환할 테스트 지점의 수입니다.

반환

Promise<TestPoint[]>

getPointsByQuery(TestPointsQuery, string, number, number)

쿼리를 사용하여 테스트 지점을 가져옵니다.

function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>

매개 변수

query
TestPointsQuery

TestPointsQuery를 사용하여 테스트 지점을 가져옵니다.

project

string

프로젝트 ID 또는 프로젝트 이름

skip

number

건너뛸 테스트 지점의 수입니다.

top

number

반환할 테스트 지점의 수입니다.

반환

Promise<TestPointsQuery>

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

publishContext

string

fields

string[]

continuationToken

string

반환

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

releaseId

number

publishContext

string

releaseEnvId

number

fields

string[]

continuationToken

string

반환

getResultRetentionSettings(string)

테스트 결과 보존 설정 가져오기

function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

getTestCaseById(string, number, number, number)

테스트 사례 ID가 있는 테스트 도구 모음에서 특정 테스트 사례를 가져옵니다.

function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

제품군을 포함하는 테스트 계획의 ID입니다.

suiteId

number

테스트 사례가 포함된 제품군의 ID입니다.

testCaseIds

number

가져올 테스트 사례의 ID입니다.

반환

Promise<SuiteTestCase>

getTestCases(string, number, number)

제품군에서 모든 테스트 사례를 가져옵니다.

function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

제품군을 포함하는 테스트 계획의 ID입니다.

suiteId

number

가져올 제품군의 ID입니다.

반환

Promise<SuiteTestCase[]>

getTestIteration(string, number, number, number, boolean)

결과에 대한 반복 가져오기

function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

반복을 포함하는 테스트 결과의 ID입니다.

iterationId

number

테스트 결과 반복의 ID입니다.

includeActionResults

boolean

테스트 반복에서 수행된 각 작업에 대한 결과 세부 정보를 포함합니다. ActionResults는 수동 테스트 실행의 일부로 실행되는 테스트 단계의 결과(통과/실패)를 나타냅니다. ActionResults 플래그를 포함하면 actionResults 섹션의 테스트 단계 결과와 각 테스트 반복에 대한 매개 변수 섹션의 테스트 매개 변수가 표시됩니다.

반환

getTestIterations(string, number, number, boolean)

결과에 대한 반복 가져오기

function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

반복을 포함하는 테스트 결과의 ID입니다.

includeActionResults

boolean

테스트 반복에서 수행된 각 작업에 대한 결과 세부 정보를 포함합니다. ActionResults는 수동 테스트 실행의 일부로 실행되는 테스트 단계의 결과(통과/실패)를 나타냅니다. ActionResults 플래그를 포함하면 actionResults 섹션의 테스트 단계 결과와 각 테스트 반복에 대한 매개 변수 섹션의 테스트 매개 변수가 표시됩니다.

반환

getTestResultAttachmentContent(string, number, number, number)

ID로 테스트 결과 첨부 파일을 다운로드합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

testCaseResultId를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

첨부 파일을 다운로드해야 하는 테스트 결과의 ID입니다.

attachmentId

number

다운로드할 테스트 결과 첨부 파일의 ID입니다.

반환

Promise<ArrayBuffer>

getTestResultAttachments(string, number, number)

테스트 결과 첨부 파일 참조 목록을 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

테스트 결과의 ID입니다.

반환

Promise<TestAttachment[]>

getTestResultAttachmentZip(string, number, number, number)

ID로 테스트 결과 첨부 파일을 다운로드합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

testCaseResultId를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

첨부 파일을 다운로드해야 하는 테스트 결과의 ID입니다.

attachmentId

number

다운로드할 테스트 결과 첨부 파일의 ID입니다.

반환

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

테스트 실행에 대한 테스트 결과를 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

가져올 테스트 결과의 테스트 실행 ID입니다.

testCaseResultId

number

테스트 결과 ID입니다.

detailsToInclude
ResultDetails

테스트 결과와 함께 포함할 세부 정보입니다. 기본값은 None입니다. 다른 값은 반복, WorkItems 및 SubResults입니다.

반환

Promise<TestCaseResult>

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

반환

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>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

releaseId

number

releaseEnvId

number

publishContext

string

groupBy

string

filter

string

orderby

string

shouldIncludeResults

boolean

queryRunSummaryForInProgress

boolean

반환

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

테스트 실행에 대한 테스트 결과를 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

가져올 테스트 결과의 테스트 실행 ID입니다.

detailsToInclude
ResultDetails

테스트 결과와 함께 포함할 세부 정보입니다. 기본값은 None입니다. 다른 값은 반복 및 WorkItems입니다.

skip

number

처음부터 건너뛸 테스트 결과 수입니다.

top

number

반환할 테스트 결과 수입니다. detailsToInclude가 None이고 그렇지 않으면 200이면 최대값은 1000입니다.

outcomes

TestOutcome[]

테스트 결과를 필터링하기 위해 쉼표로 구분된 테스트 결과 목록입니다.

반환

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>>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

반환

getTestResultsByQuery(TestResultsQuery, string)

이 API는 특정 자동화된 테스트 메서드에 대해 지정된 필드/추세가 있는 ID별로 결과를 반환합니다. 여전히 이 API를 개선하고 있으며 적절한 서명 및 계약을 확정하지 않았습니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<TestResultsQuery>

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>>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

releaseId

number

releaseEnvid

number

publishContext

string

outcomes

TestOutcome[]

top

number

continuationToken

string

반환

getTestRunAttachmentContent(string, number, number)

ID로 테스트 실행 첨부 파일을 다운로드합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

첨부 파일을 다운로드해야 하는 테스트 실행의 ID입니다.

attachmentId

number

다운로드할 테스트 실행 첨부 파일의 ID입니다.

반환

Promise<ArrayBuffer>

getTestRunAttachments(string, number)

테스트 실행 첨부 파일 참조 목록을 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

테스트 실행의 ID입니다.

반환

Promise<TestAttachment[]>

getTestRunAttachmentZip(string, number, number)

ID로 테스트 실행 첨부 파일을 다운로드합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

첨부 파일을 다운로드해야 하는 테스트 실행의 ID입니다.

attachmentId

number

다운로드할 테스트 실행 첨부 파일의 ID입니다.

반환

Promise<ArrayBuffer>

getTestRunById(string, number, boolean)

ID로 테스트를 실행합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

가져올 실행의 ID입니다.

includeDetails

boolean

기본값은 true입니다. 여기에는 실행 통계, 릴리스, 빌드, 테스트 환경, 사후 프로세스 상태 등의 세부 정보가 포함됩니다.

반환

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

테스트 실행에 대한 코드 검사 데이터 가져오기

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

코드 검사 데이터를 가져와야 하는 테스트 실행의 ID입니다.

flags

number

플래그 값은 가져올 코드 검사 세부 정보의 수준을 결정합니다. 플래그는 가산적입니다. 예상 값은 모듈의 경우 1, 함수의 경우 2, BlockData의 경우 4입니다.

반환

Promise<TestRunCoverage[]>

getTestRunLogs(string, number)

테스트 실행 메시지 로그 가져오기

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

가져올 실행의 ID입니다.

반환

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[]>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildUri

string

실행이 사용된 빌드의 URI입니다.

owner

string

실행 소유자의 팀 기초 ID입니다.

tmiRunId

string

planId

number

실행이 포함된 테스트 계획의 ID입니다.

includeRunDetails

boolean

true이면 실행의 모든 속성을 포함합니다.

automated

boolean

true이면 자동화된 실행만 반환합니다.

skip

number

건너뛸 테스트 실행 수입니다.

top

number

반환할 테스트 실행 수입니다.

반환

Promise<TestRun[]>

getTestRunStatistics(string, number)

결과별 실행 요약을 가져올 때 사용되는 테스트 실행 통계를 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

가져올 실행의 ID입니다.

반환

Promise<TestRunStatistic>

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

테스트 세션 목록 가져오기

function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>

매개 변수

teamContext
TeamContext

작업에 대한 팀 컨텍스트

period

number

테스트 세션이 페치되는 기간(지금부터 며칠)입니다.

allSessions

boolean

false이면 현재 사용자에 대한 테스트 세션을 반환합니다. 그렇지 않으면 모든 사용자에 대한 테스트 세션을 반환합니다.

includeAllProperties

boolean

true이면 테스트 세션의 모든 속성을 반환합니다. 그렇지 않으면 스키니 버전을 반환합니다.

source
TestSessionSource

테스트 세션의 원본입니다.

includeOnlyCompletedSessions

boolean

true이면 테스트 세션이 완료된 상태로 반환됩니다. 그렇지 않으면 모든 상태에 대한 테스트 세션을 반환합니다.

반환

Promise<TestSession[]>

getTestSettingsById(string, number)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

testSettingsId

number

반환

Promise<TestSettings>

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

테스트 하위 결과 첨부 파일 다운로드

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

하위 결과가 포함된 테스트 결과의 ID입니다.

attachmentId

number

다운로드할 테스트 결과 첨부 파일의 ID

testSubResultId

number

첨부 파일을 다운로드해야 하는 테스트 하위 결과의 ID

반환

Promise<ArrayBuffer>

getTestSubResultAttachments(string, number, number, number)

테스트 하위 결과 첨부 파일 목록 가져오기

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

하위 결과가 포함된 테스트 결과의 ID입니다.

testSubResultId

number

첨부 파일을 다운로드해야 하는 테스트 하위 결과의 ID

반환

Promise<TestAttachment[]>

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

테스트 하위 결과 첨부 파일 다운로드

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

결과를 포함하는 테스트 실행의 ID입니다.

testCaseResultId

number

하위 결과가 포함된 테스트 결과의 ID입니다.

attachmentId

number

다운로드할 테스트 결과 첨부 파일의 ID

testSubResultId

number

첨부 파일을 다운로드해야 하는 테스트 하위 결과의 ID

반환

Promise<ArrayBuffer>

publishTestResultDocument(TestResultDocument, string, number)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

반환

queryCustomFields(string, CustomTestFieldScope)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

scopeFilter
CustomTestFieldScope

반환

queryResultTrendForBuild(TestResultTrendFilter, string)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

queryResultTrendForRelease(TestResultTrendFilter, string)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

queryTestHistory(TestHistoryQuery, string)

TestHistoryQuery를 사용하여 테스트 메서드의 기록 가져오기

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

매개 변수

filter
TestHistoryQuery

기록을 가져오는 TestHistoryQuery

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<TestHistoryQuery>

queryTestMethodLinkedWorkItems(string, string)

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

testName

string

반환

queryTestResultHistory(ResultsFilter, string)

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

매개 변수

filter
ResultsFilter
project

string

프로젝트 ID 또는 프로젝트 이름

반환

queryTestResultsMetaData(string[], string)

해당 testcasereferenceId에 대한 테스트 결과 메타 데이터 세부 정보 목록 가져오기

function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>

매개 변수

testReferenceIds

string[]

쿼리할 테스트 결과, 유효한 ID의 쉼표로 구분된 목록의 TestCaseReference ID입니다(ids 200 제한 없음).

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<TestResultMetaData[]>

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

publishContext

string

includeFailureDetails

boolean

buildToCompare
BuildReference

반환

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

releaseId

number

releaseEnvId

number

publishContext

string

includeFailureDetails

boolean

releaseToCompare
ReleaseReference

반환

queryTestResultsSummaryForReleases(ReleaseReference[], string)

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

매개 변수

releases

ReleaseReference[]

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<TestResultSummary[]>

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

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

workItemCategory

string

automatedTestName

string

testCaseId

number

maxCompleteDate

Date

days

number

workItemCount

number

반환

Promise<WorkItemReference[]>

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

필터를 기반으로 하는 쿼리 테스트 실행 필수 필드는 minLastUpdatedDate 및 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, continuationToken?: string): Promise<PagedList<TestRun>>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

minLastUpdatedDate

Date

쿼리할 최소 마지막으로 수정한 실행 날짜(필수)입니다.

maxLastUpdatedDate

Date

쿼리할 최대 마지막으로 수정한 실행 날짜(필수, 최소 날짜와 최대 날짜 간의 차이는 최대 7일일 수 있음).

state
TestRunState

쿼리할 실행의 현재 상태입니다.

planIds

number[]

쿼리할 실행의 계획 ID, 유효한 ID의 쉼표로 구분된 목록(ids 10 제한 없음).

isAutomated

boolean

쿼리할 실행의 자동화 유형입니다.

publishContext
TestRunPublishContext

쿼리할 실행의 PublishContext입니다.

buildIds

number[]

쿼리할 실행의 빌드 ID, 유효한 ID의 쉼표로 구분된 목록(ids 10 제한 없음).

buildDefIds

number[]

쿼리할 실행의 빌드 정의 ID이며, 유효한 ID의 쉼표로 구분된 목록입니다(ids 10 제한 없음).

branchName

string

쿼리할 실행의 원본 분기 이름입니다.

releaseIds

number[]

쿼리할 실행의 릴리스 ID, 유효한 ID의 쉼표로 구분된 목록(ids 10 제한 없음).

releaseDefIds

number[]

쿼리할 실행의 정의 ID를 해제하고, 유효한 ID의 쉼표로 구분된 목록(ids 10 제한 없음)을 해제합니다.

releaseEnvIds

number[]

쿼리할 실행의 환경 ID를 해제하고, 쉼표로 구분된 유효한 ID 목록(ids 10 제한 없음)을 해제합니다.

releaseEnvDefIds

number[]

쿼리할 실행의 릴리스 환경 정의 ID, 유효한 ID의 쉼표로 구분된 목록(ids 10 제한 없음).

runTitle

string

쿼리할 실행 제목을 실행합니다.

top

number

쿼리할 실행 수입니다. 제한은 100입니다.

continuationToken

string

continuationToken이 이전 일괄 처리에서 수신되었거나 첫 번째 일괄 처리에 대해 null입니다. 사용자가 생성(또는 마지막 일괄 처리에서 받은 경우 변경)하지 않아야 합니다.

반환

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

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

매개 변수

resultsContext
TestResultsContext
project

string

프로젝트 ID 또는 프로젝트 이름

workItemIds

number[]

반환

removeTestCasesFromSuiteUrl(string, number, number, string)

테스트 사례와 연결된 테스트 지점은 테스트 도구 모음에서 제거됩니다. 테스트 사례 작업 항목이 시스템에서 삭제되지 않습니다. 테스트 사례를 영구적으로 삭제하려면 테스트 사례 리소스를 참조하세요.

function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

제품군을 포함하는 테스트 계획의 ID입니다.

suiteId

number

가져올 제품군의 ID입니다.

testCaseIds

string

제품군에서 제거할 테스트 사례의 ID입니다.

반환

Promise<void>

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 요청: 코드 검사 요약의 Json

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

매개 변수

coverageData
CodeCoverageData
project

string

프로젝트 ID 또는 프로젝트 이름

buildId

number

반환

Promise<void>

updateResultRetentionSettings(ResultRetentionSettings, string)

테스트 결과 보존 설정 업데이트

function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>

매개 변수

retentionSettings
ResultRetentionSettings

업데이트할 테스트 결과 보존 설정 세부 정보

project

string

프로젝트 ID 또는 프로젝트 이름

반환

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

도구 모음에서 테스트 사례 연결의 속성을 업데이트.

function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

매개 변수

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

테스트 사례 제품군 연결의 속성을 업디션하기 위한 모델입니다.

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

제품군을 포함하는 테스트 계획의 ID입니다.

suiteId

number

테스트 사례를 추가해야 하는 테스트 도구 모음의 ID입니다.

testCaseIds

string

제품군에 추가할 테스트 사례의 ID입니다. ID는 쉼표로 구분된 형식으로 지정됩니다.

반환

Promise<SuiteTestCase[]>

updateTestPoints(PointUpdateModel, string, number, number, string)

테스트 지점을 업데이트합니다.

function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>

매개 변수

pointUpdateModel
PointUpdateModel

업데이트할 데이터입니다.

project

string

프로젝트 ID 또는 프로젝트 이름

planId

number

테스트 계획의 ID입니다.

suiteId

number

점이 포함된 제품군의 ID입니다.

pointIds

string

가져올 테스트 지점의 ID입니다. 쉼표로 구분된 ID 목록을 사용하여 여러 테스트 지점을 업데이트합니다.

반환

Promise<TestPoint[]>

updateTestResults(TestCaseResult[], string, number)

테스트 결과를 업데이트하면 테스트 실행이 실행됩니다.

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

매개 변수

results

TestCaseResult[]

업데이트할 테스트 결과 목록입니다.

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

테스트 결과를 업데이트할 테스트 실행 ID입니다.

반환

Promise<TestCaseResult[]>

updateTestRun(RunUpdateModel, string, number)

ID로 실행되는 테스트를 업데이트합니다.

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

매개 변수

runUpdateModel
RunUpdateModel

실행 세부 정보 RunUpdateModel

project

string

프로젝트 ID 또는 프로젝트 이름

runId

number

업데이트할 실행의 ID입니다.

반환

Promise<TestRun>

updateTestSession(TestSession, TeamContext)

테스트 세션 업데이트

function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>

매개 변수

testSession
TestSession

업데이트에 대한 테스트 세션 세부 정보

teamContext
TeamContext

작업에 대한 팀 컨텍스트

반환

Promise<TestSession>