TestManagementWebService4

Click here for a complete list of operations.

CreateTestPlan

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/TestManagementWebService4.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/CreateTestPlan"

<?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>
    <CreateTestPlan xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <testPlan PlanId="int" Name="string" Owner="guid" OwnerName="string" State="unsignedByte" StartDate="dateTime" EndDate="dateTime" AreaPath="string" Iteration="string" TestSettingsId="int" AutomatedTestSettingsId="int" ManualTestEnvironmentId="guid" AutomatedTestEnvironmentId="guid" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" RootSuiteId="int" Revision="int" BuildDefinition="string" BuildQuality="string" BuildDefinitionId="int" BuildUri="string" PreviousBuildUri="string" BuildTakenDate="dateTime" ServiceVersion="string" Status="string">
        <Description>string</Description>
        <ReleaseEnvDef>
          <ReleaseDefinitionId>int</ReleaseDefinitionId>
          <ReleaseEnvDefinitionId>int</ReleaseEnvDefinitionId>
        </ReleaseEnvDef>
        <SuitesMetaData>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
        </SuitesMetaData>
      </testPlan>
      <teamProjectName>string</teamProjectName>
      <links>
        <TestExternalLink LinkId="int" Uri="string" Description="string" />
        <TestExternalLink LinkId="int" Uri="string" Description="string" />
      </links>
    </CreateTestPlan>
  </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>
    <CreateTestPlanResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <CreateTestPlanResult PlanId="int" Name="string" Owner="guid" OwnerName="string" State="unsignedByte" StartDate="dateTime" EndDate="dateTime" AreaPath="string" Iteration="string" TestSettingsId="int" AutomatedTestSettingsId="int" ManualTestEnvironmentId="guid" AutomatedTestEnvironmentId="guid" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" RootSuiteId="int" Revision="int" BuildDefinition="string" BuildQuality="string" BuildDefinitionId="int" BuildUri="string" PreviousBuildUri="string" BuildTakenDate="dateTime" ServiceVersion="string" Status="string">
        <Description>string</Description>
        <ReleaseEnvDef>
          <ReleaseDefinitionId>int</ReleaseDefinitionId>
          <ReleaseEnvDefinitionId>int</ReleaseEnvDefinitionId>
        </ReleaseEnvDef>
        <SuitesMetaData>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
        </SuitesMetaData>
      </CreateTestPlanResult>
    </CreateTestPlanResponse>
  </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/TestManagementWebService4.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>
    <CreateTestPlan xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <testPlan PlanId="int" Name="string" Owner="guid" OwnerName="string" State="unsignedByte" StartDate="dateTime" EndDate="dateTime" AreaPath="string" Iteration="string" TestSettingsId="int" AutomatedTestSettingsId="int" ManualTestEnvironmentId="guid" AutomatedTestEnvironmentId="guid" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" RootSuiteId="int" Revision="int" BuildDefinition="string" BuildQuality="string" BuildDefinitionId="int" BuildUri="string" PreviousBuildUri="string" BuildTakenDate="dateTime" ServiceVersion="string" Status="string">
        <Description>string</Description>
        <ReleaseEnvDef>
          <ReleaseDefinitionId>int</ReleaseDefinitionId>
          <ReleaseEnvDefinitionId>int</ReleaseEnvDefinitionId>
        </ReleaseEnvDef>
        <SuitesMetaData>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
        </SuitesMetaData>
      </testPlan>
      <teamProjectName>string</teamProjectName>
      <links>
        <TestExternalLink LinkId="int" Uri="string" Description="string" />
        <TestExternalLink LinkId="int" Uri="string" Description="string" />
      </links>
    </CreateTestPlan>
  </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>
    <CreateTestPlanResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/07/TCM/TestManagement/01">
      <CreateTestPlanResult PlanId="int" Name="string" Owner="guid" OwnerName="string" State="unsignedByte" StartDate="dateTime" EndDate="dateTime" AreaPath="string" Iteration="string" TestSettingsId="int" AutomatedTestSettingsId="int" ManualTestEnvironmentId="guid" AutomatedTestEnvironmentId="guid" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" RootSuiteId="int" Revision="int" BuildDefinition="string" BuildQuality="string" BuildDefinitionId="int" BuildUri="string" PreviousBuildUri="string" BuildTakenDate="dateTime" ServiceVersion="string" Status="string">
        <Description>string</Description>
        <ReleaseEnvDef>
          <ReleaseDefinitionId>int</ReleaseDefinitionId>
          <ReleaseEnvDefinitionId>int</ReleaseEnvDefinitionId>
        </ReleaseEnvDef>
        <SuitesMetaData>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
          <ServerTestSuite Id="int" PlanId="int" ParentId="int" Title="string" Description="string" QueryString="string" RequirementId="int" Revision="int" TestCaseCount="int" SuiteType="unsignedByte" InheritDefaultConfigurations="boolean" LastPopulated="dateTime" LastError="string" State="unsignedByte" LastUpdatedBy="guid" LastUpdatedByName="string" LastUpdated="dateTime" Status="string">
            <ServerEntries xsi:nil="true" />
            <DefaultConfigurations xsi:nil="true" />
            <DefaultConfigurationNames xsi:nil="true" />
            <DefaultTesters xsi:nil="true" />
            <LastSynced>dateTime</LastSynced>
          </ServerTestSuite>
        </SuitesMetaData>
      </CreateTestPlanResult>
    </CreateTestPlanResponse>
  </soap12:Body>
</soap12:Envelope>