Edit

Share via


Microsoft.TeamFoundation.TestManagement.WebApi Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Classes

AccessDeniedException
AfnStrip
AggregatedDataForResultTrend
AggregatedResultsAnalysis
AggregatedResultsByOutcome
AggregatedResultsDifference
AggregatedRunsByOutcome
AggregatedRunsByState
BatchResponse
BuildConfiguration
BuildCoverage

Build Coverage Detail

BuildReference

Reference to a build.

BuildReference2
CloneOperationInformation

Detail About Clone Operation.

CloneOptions
CloneStatistics
CodeCoverageData

Represents the build configuration (platform, flavor) and coverage data for the build

CodeCoverageSecuredObject

Added as All returned objects from a public API must implement ISecuredObject This is needed to run additional verifications before serializing the response

CodeCoverageStatistics

Represents the code coverage statistics for a particular coverage label (modules, statements, blocks, etc.)

CodeCoverageSummary

Represents the code coverage summary results Used to publish or retrieve code coverage summary against a build

CodeCoverageSummary2
Coverage2
CoverageStatistics
CustomTestField

A custom field information.

CustomTestFieldDefinition
DatedTestFieldData
DtlEnvironmentDetails

This is a temporary class to provide the details for the test run environment.

FailingSince

Failing since information of a test result.

FieldDetailsForTestResults
FunctionCoverage
FunctionCoverage2
InvalidPropertyException
LastResultDetails
LinkedWorkItemsQuery
LinkedWorkItemsQueryResult
ModuleCoverage
ModuleCoverage2
NameValuePair

Name value pair

ParameterizedString
PlanUpdateModel

A model class used for creating and updating test plans.

PointAssignment

Adding test cases to a suite creates one of more test points based on the default configurations and testers assigned to the test suite. PointAssignment is the list of test points that were created for each of the test cases that were added to the test suite.

PointsFilter

Filter class for test point.

PointsResults2
PointUpdateModel

Model to update test point.

PointWorkItemProperty

Test point workitem property.

PropertyBag
QueryModel
ReleaseEnvironmentDefinitionReference

Reference to release environment resource.

ReleaseReference

Reference to a release.

ReleaseReference2
RequestBlockedException
RequestParamaterValues
RequestParameterKeys
RequirementsToTestsMapping2
Response
ResultRetentionSettings

Test result retention settings

ResultsFilter
ResultUpdateRequestModel
ResultUpdateResponseModel
RunCreateModel

Test run create details.

RunFilter

This class is used to provide the filters used for discovery

RunStatistic

Test run statistics.

RunUpdateModel
ShallowReference

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

ShallowTestCaseResult
SharedStepModel

Reference to shared step workitem.

SourceWorkflow
SuiteCreateModel

Suite create model

SuiteEntry

A suite entry defines properties for a test suite.

SuiteEntryUpdateModel

A model to define sequence of test suite entries in a test suite.

SuiteTestCase

Test case for the suite.

SuiteTestCaseUpdateModel

Test suite update model.

SuiteUpdateModel

Test suite update model.

TCMDataMigrationInProgressException
TCMPropertyBag2
TeamProjectNotFoundException
TestActionCollection
TestActionResult2
TestActionResultModel

Represents a test step result.

TestAttachment
TestAttachmentCollection
TestAttachmentLink
TestAttachmentReference

Reference to test attachment.

TestAttachmentRequestModel

Test attachment request model

TestAuthoringDetails
TestBaseHelper
TestCaseMetadata2
TestCaseReference2
TestCaseResult

Represents a test result.

TestCaseResultAttachmentModel

Test attachment information in a test iteration.

TestCaseResultIdentifier

Reference to a test result.

TestCaseResultUpdateModel
TestCompatHttpClientBase

This class contains overloads of methods that were removed from the auto-generated client due to adding parameters. We use extra overloads to ensure that whatever binary signature a client used before will map to one of these prototypes.

TestConfiguration

Test configuration

TestEnvironment
TestExecutionReportData
TestFailureDetails
TestFailuresAnalysis
TestFailureType
TestFieldData
TestFieldsEx2
TestHistoryQuery

Filter to get TestCase result history.

TestHttpClientBase
TestIterationDetailsModel

Represents a test iteration result.

TestLog

Represents Test Log Result object.

TestLogReference
TestLogStatus

Represents Test Log Status object.

TestLogStoreEndpointDetails

Represents Test Log store endpoint details.

TestManagementBaseSecuredObject
TestManagementConstants
TestManagementEventType

Types of service events published by Test Management service.

TestManagementHttpClient
TestManagementHttpClientRetryHelper
TestManagementResourceIds
TestManagementRetryHelper
TestMessageLog2
TestMessageLogDetails

An abstracted reference to some other resource. This class is used to provide the build data contracts with a uniform way to reference other resources in a way that provides easy traversal through links.

TestMessageLogEntry2
TestMethod
TestObjectInUseException
TestObjectNotFoundException
TestObjectUpdatedException
TestOperationReference

Class representing a reference to an operation.

TestOutcomeSettings

Test outcome settings

TestParameter2
TestPlan

The test plan resource.

TestPlanCloneRequest
TestPlanHubData
TestPlansWithSelection
TestPoint

Test point.

TestPointReference
TestPointsEvent
TestPointsQuery

Test point query class.

TestPointsUpdatedEvent
TestResolutionState
TestResult2
TestResultCreateModel
TestResultDocument
TestResultHistory
TestResultHistoryDetailsForGroup
TestResultHistoryForGroup

List of test results filtered on the basis of GroupByValue

TestResultMetaData

Represents a Meta Data of a test result.

TestResultModelBase
TestResultParameterModel

Test parameter information in a test iteration.

TestResultPayload
TestResultReset2
TestResultsContext
TestResultsDetails
TestResultsDetailsForGroup
TestResultsEx2
TestResultsGroupsForBuild
TestResultsGroupsForRelease
TestResultsQuery
TestResultSummary
TestResultTrendFilter
TestRun

Test run details.

TestRun2
TestRunCanceledEvent
TestRunContext2
TestRunCoverage

Test Run Code Coverage Details

TestRunCreatedEvent
TestRunEvent
TestRunEx2
TestRunExtended2
TestRunStartedEvent
TestRunStatistic

Test run statistics.

TestRunSummary2
TestSession

Test Session

TestSessionExploredWorkItemReference
TestSessionWorkItemReference
TestSettings

Represents the test settings of the run. Used to create test settings and fetch test settings

TestSettings2

Represents the test settings of the run. Used to create test settings and fetch test settings

TestSubResult

Represents a sub result of a test result.

TestSuite

Test suite

TestSuiteCloneRequest

Test suite clone request

TestSummaryForWorkItem
TestToWorkItemLinks
TestVariable
ValidTestResultGroupByFields
ValidTestResultPropertyFilters
WorkItemReference
WorkItemToTestLinks

Structs

ParameterizedStringPart

Represents one part of a ParameterizedString, each part can be either a literal or a parameter reference. If a parameter reference, then it has an "IgnoreValue" property, which may be true or false

Developers Note: This must be immutable

Interfaces

ISharedStep
ITestAction
ITestActionGroup

Represents a group of actions, which, since a group is itself an action, may contain other nested groups. The nesting is arbitrary, but of finite depth (so a group may not directly or indirectly contain itself)

ITestAttachment
ITestBase
ITestBaseHelper
ITestResultsHttpClient
ITestStep
ITestStepAttachment

Enums

AttachmentType

The types of test attachments.

CloneOperationState

Enum of type Clone Operation Type.

CoverageQueryFlags

Used to choose which coverage data is returned by a QueryXXXCoverage() call.

CustomTestFieldScope
CustomTestFieldType
GroupTestResultsBy
ResultDetails

Additional details with test result

ResultGroupType

Hierarchy type of the result/subresults.

ResultObjectType

The top level entity that is being cloned as part of a Clone operation

Service
SuiteExpand

Option to get details in response

TCMServiceDataMigrationStatus
TestActionType
TestConfigurationState

Represents the state of an ITestConfiguration object.

TestLogScope

Test Log Context

TestLogStatusCode

Test Log Status codes.

TestLogStoreEndpointType
TestLogStoreOperationType
TestLogType

Test Log Types

TestOutcome
TestPointState
TestResultGroupBy

Group by for results

TestResultsContextType
TestRunOutcome

The types of outcomes for test run.

TestRunPublishContext

The types of publish context for run.

TestRunState

The types of states for test run.

TestRunSubstate

The types of sub states for test run. It gives the user more info about the test run beyond the high level test run state

TestSessionSource

Represents the source from which the test session was created

TestSessionState

Represents the state of the test session.

TestStepType