TestManagementWebService Web Service

TestManagementWebService

Click here for a complete list of operations.

QueryTestRunByTmiRunId

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/TestManagement/v2.0/TestManagementWebService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01/QueryTestRunByTmiRunId"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryTestRunByTmiRunId xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <tmiRunId>guid</tmiRunId>
    </QueryTestRunByTmiRunId>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryTestRunByTmiRunIdResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <QueryTestRunByTmiRunIdResult TestRunId="int" State="unsignedByte" DropLocation="string" PostProcessState="unsignedByte" DueDate="dateTime" Iteration="string" TestMessageLogId="int" LegacySharePath="string" Type="unsignedByte" IsAutomated="boolean" Version="int" IsBvt="boolean" TotalTests="int" IncompleteTests="int" NotApplicableTests="int" PassedTests="int" UnanalyzedTests="int">
        <TestRunStatistics>
          <TestRunStatistic State="unsignedByte" Outcome="unsignedByte" Count="int" ResultMetadata="unsignedByte">
            <ResolutionState xsi:nil="true" />
          </TestRunStatistic>
          <TestRunStatistic State="unsignedByte" Outcome="unsignedByte" Count="int" ResultMetadata="unsignedByte">
            <ResolutionState xsi:nil="true" />
          </TestRunStatistic>
        </TestRunStatistics>
        <ErrorMessage>string</ErrorMessage>
        <FailedTests>int</FailedTests>
        <BuildReference BuildConfigurationId="int" TeamProjectName="string" BuildUri="string" BuildFlavor="string" BuildPlatform="string">
          <BuildId>int</BuildId>
        </BuildReference>
        <ReleaseReference>
          <ReleaseRefId>int</ReleaseRefId>
          <ReleaseUri>string</ReleaseUri>
          <ReleaseEnvUri>string</ReleaseEnvUri>
          <ReleaseId>int</ReleaseId>
          <ReleaseEnvId>int</ReleaseEnvId>
          <ReleaseDefId>int</ReleaseDefId>
          <ReleaseEnvDefId>int</ReleaseEnvDefId>
          <Attempt>int</Attempt>
          <ReleaseName>string</ReleaseName>
          <ReleaseEnvName>string</ReleaseEnvName>
          <ReleaseCreationDate>dateTime</ReleaseCreationDate>
          <EnvironmentCreationDate>dateTime</EnvironmentCreationDate>
          <PrimaryArtifactBuildId>int</PrimaryArtifactBuildId>
          <PrimaryArtifactProjectId>string</PrimaryArtifactProjectId>
          <PrimaryArtifactType>string</PrimaryArtifactType>
        </ReleaseReference>
        <Filter>
          <SourceFilter>string</SourceFilter>
          <TestCaseFilter>string</TestCaseFilter>
        </Filter>
        <ConfigurationIds>
          <int>int</int>
          <int>int</int>
        </ConfigurationIds>
        <DtlTestEnvironment>
          <Id>string</Id>
          <Name>string</Name>
          <Url>string</Url>
        </DtlTestEnvironment>
        <DtlAutEnvironment>
          <Id>string</Id>
          <Name>string</Name>
          <Url>string</Url>
        </DtlAutEnvironment>
        <TestMessageLogEntries>
          <TestMessageLogDetails>
            <EntryId>int</EntryId>
            <DateCreated>dateTime</DateCreated>
            <Message>string</Message>
          </TestMessageLogDetails>
          <TestMessageLogDetails>
            <EntryId>int</EntryId>
            <DateCreated>dateTime</DateCreated>
            <Message>string</Message>
          </TestMessageLogDetails>
        </TestMessageLogEntries>
        <CustomFields>
          <TestExtensionField />
          <TestExtensionField />
        </CustomFields>
        <SourceWorkflow>string</SourceWorkflow>
        <Substate>unsignedByte</Substate>
        <RunTimeout />
        <CsmParameters>string</CsmParameters>
        <CsmContent>string</CsmContent>
        <SubscriptionName>string</SubscriptionName>
        <TestConfigurationsMapping>string</TestConfigurationsMapping>
        <Tags>
          <TestTag>
            <Name>string</Name>
          </TestTag>
          <TestTag>
            <Name>string</Name>
          </TestTag>
        </Tags>
        <PipelineReference>
          <PipelineId>int</PipelineId>
          <StageReference>
            <StageName>string</StageName>
            <Attempt>int</Attempt>
          </StageReference>
          <PhaseReference>
            <PhaseName>string</PhaseName>
            <Attempt>int</Attempt>
          </PhaseReference>
          <JobReference>
            <JobName>string</JobName>
            <Attempt>int</Attempt>
          </JobReference>
          <PipelineDefinitionId>int</PipelineDefinitionId>
        </PipelineReference>
      </QueryTestRunByTmiRunIdResult>
    </QueryTestRunByTmiRunIdResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/TestManagement/v2.0/TestManagementWebService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryTestRunByTmiRunId xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <tmiRunId>guid</tmiRunId>
    </QueryTestRunByTmiRunId>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryTestRunByTmiRunIdResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <QueryTestRunByTmiRunIdResult TestRunId="int" State="unsignedByte" DropLocation="string" PostProcessState="unsignedByte" DueDate="dateTime" Iteration="string" TestMessageLogId="int" LegacySharePath="string" Type="unsignedByte" IsAutomated="boolean" Version="int" IsBvt="boolean" TotalTests="int" IncompleteTests="int" NotApplicableTests="int" PassedTests="int" UnanalyzedTests="int">
        <TestRunStatistics>
          <TestRunStatistic State="unsignedByte" Outcome="unsignedByte" Count="int" ResultMetadata="unsignedByte">
            <ResolutionState xsi:nil="true" />
          </TestRunStatistic>
          <TestRunStatistic State="unsignedByte" Outcome="unsignedByte" Count="int" ResultMetadata="unsignedByte">
            <ResolutionState xsi:nil="true" />
          </TestRunStatistic>
        </TestRunStatistics>
        <ErrorMessage>string</ErrorMessage>
        <FailedTests>int</FailedTests>
        <BuildReference BuildConfigurationId="int" TeamProjectName="string" BuildUri="string" BuildFlavor="string" BuildPlatform="string">
          <BuildId>int</BuildId>
        </BuildReference>
        <ReleaseReference>
          <ReleaseRefId>int</ReleaseRefId>
          <ReleaseUri>string</ReleaseUri>
          <ReleaseEnvUri>string</ReleaseEnvUri>
          <ReleaseId>int</ReleaseId>
          <ReleaseEnvId>int</ReleaseEnvId>
          <ReleaseDefId>int</ReleaseDefId>
          <ReleaseEnvDefId>int</ReleaseEnvDefId>
          <Attempt>int</Attempt>
          <ReleaseName>string</ReleaseName>
          <ReleaseEnvName>string</ReleaseEnvName>
          <ReleaseCreationDate>dateTime</ReleaseCreationDate>
          <EnvironmentCreationDate>dateTime</EnvironmentCreationDate>
          <PrimaryArtifactBuildId>int</PrimaryArtifactBuildId>
          <PrimaryArtifactProjectId>string</PrimaryArtifactProjectId>
          <PrimaryArtifactType>string</PrimaryArtifactType>
        </ReleaseReference>
        <Filter>
          <SourceFilter>string</SourceFilter>
          <TestCaseFilter>string</TestCaseFilter>
        </Filter>
        <ConfigurationIds>
          <int>int</int>
          <int>int</int>
        </ConfigurationIds>
        <DtlTestEnvironment>
          <Id>string</Id>
          <Name>string</Name>
          <Url>string</Url>
        </DtlTestEnvironment>
        <DtlAutEnvironment>
          <Id>string</Id>
          <Name>string</Name>
          <Url>string</Url>
        </DtlAutEnvironment>
        <TestMessageLogEntries>
          <TestMessageLogDetails>
            <EntryId>int</EntryId>
            <DateCreated>dateTime</DateCreated>
            <Message>string</Message>
          </TestMessageLogDetails>
          <TestMessageLogDetails>
            <EntryId>int</EntryId>
            <DateCreated>dateTime</DateCreated>
            <Message>string</Message>
          </TestMessageLogDetails>
        </TestMessageLogEntries>
        <CustomFields>
          <TestExtensionField />
          <TestExtensionField />
        </CustomFields>
        <SourceWorkflow>string</SourceWorkflow>
        <Substate>unsignedByte</Substate>
        <RunTimeout />
        <CsmParameters>string</CsmParameters>
        <CsmContent>string</CsmContent>
        <SubscriptionName>string</SubscriptionName>
        <TestConfigurationsMapping>string</TestConfigurationsMapping>
        <Tags>
          <TestTag>
            <Name>string</Name>
          </TestTag>
          <TestTag>
            <Name>string</Name>
          </TestTag>
        </Tags>
        <PipelineReference>
          <PipelineId>int</PipelineId>
          <StageReference>
            <StageName>string</StageName>
            <Attempt>int</Attempt>
          </StageReference>
          <PhaseReference>
            <PhaseName>string</PhaseName>
            <Attempt>int</Attempt>
          </PhaseReference>
          <JobReference>
            <JobName>string</JobName>
            <Attempt>int</Attempt>
          </JobReference>
          <PipelineDefinitionId>int</PipelineDefinitionId>
        </PipelineReference>
      </QueryTestRunByTmiRunIdResult>
    </QueryTestRunByTmiRunIdResponse>
  </soap12:Body>
</soap12:Envelope>