BuildWebService

Click here for a complete list of operations.

AddBuildDefinitions

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/Build/V3.0/BuildService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03/AddBuildDefinitions"

<?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>
    <AddBuildDefinitions xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <definitions>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
      </definitions>
    </AddBuildDefinitions>
  </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>
    <AddBuildDefinitionsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <AddBuildDefinitionsResult>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
      </AddBuildDefinitionsResult>
    </AddBuildDefinitionsResponse>
  </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/Build/V3.0/BuildService.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>
    <AddBuildDefinitions xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <definitions>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
      </definitions>
    </AddBuildDefinitions>
  </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>
    <AddBuildDefinitionsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <AddBuildDefinitionsResult>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
        <BuildDefinition BuildControllerUri="string" ContinuousIntegrationType="None or Individual or Batch or Schedule or ScheduleForced or Gated or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" Enabled="boolean" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" DefaultBuildAgentUri="string" ConfigurationFolderUri="string" MaxTimeout="int">
          <Description>string</Description>
          <Process TeamProject="string" ServerPath="string" Description="string" SupportedReasons="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" TemplateType="Custom or Default or Upgrade" Id="int">
            <Parameters>string</Parameters>
            <FileExists>boolean</FileExists>
          </Process>
          <ProcessParameters>string</ProcessParameters>
          <RetentionPolicies>
            <RetentionPolicy xsi:nil="true" />
            <RetentionPolicy xsi:nil="true" />
          </RetentionPolicies>
          <Schedules>
            <Schedule xsi:nil="true" />
            <Schedule xsi:nil="true" />
          </Schedules>
          <WorkspaceTemplate DefinitionUri="string" LastModifiedDate="dateTime" LastModifiedBy="string">
            <Mappings xsi:nil="true" />
          </WorkspaceTemplate>
        </BuildDefinition>
      </AddBuildDefinitionsResult>
    </AddBuildDefinitionsResponse>
  </soap12:Body>
</soap12:Envelope>