BuildService

Click here for a complete list of operations.

QueueBuild

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/V2.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/QueueBuild"

<?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>
    <QueueBuild xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <buildRequest BuildAgentUri="string" BuildDefinitionUri="string" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" CustomGetVersion="string" MaxQueuePosition="int" RequestedFor="string">
        <CommandLineArguments>string</CommandLineArguments>
      </buildRequest>
      <options>None or Preview</options>
    </QueueBuild>
  </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>
    <QueueBuildResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueueBuildResult Id="int" BuildAgentUri="string" BuildDefinitionUri="string" DropLocation="string" QueueTime="dateTime" QueuePosition="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" Status="None or InProgress or Queued or Postponed or Completed or Canceled or All" GetOption="LatestOnQueue or LatestOnBuild or Custom" CustomGetVersion="string" RequestedFor="string" RequestedBy="string">
        <CommandLineArguments>string</CommandLineArguments>
        <Build Uri="string" TeamProject="string" BuildNumber="string" BuildDefinitionUri="string" StartTime="dateTime" FinishTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" Status="None or InProgress or Succeeded or PartiallySucceeded or Failed or Stopped or NotStarted or All" Quality="string" CompilationStatus="Unknown or Failed or Succeeded" TestStatus="Unknown or Failed or Succeeded" DropLocation="string" DropLocationRoot="string" LogLocation="string" BuildControllerUri="string" SourceGetVersion="string" RequestedFor="string" RequestedBy="string" LastChangedOn="dateTime" LastChangedBy="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean" BuildAgentUri="string" ConfigurationFolderUri="string" ShelvesetName="string">
          <ProcessParameters>string</ProcessParameters>
          <Information>
            <BuildInformationNode xsi:nil="true" />
            <BuildInformationNode xsi:nil="true" />
          </Information>
        </Build>
      </QueueBuildResult>
    </QueueBuildResponse>
  </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/V2.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>
    <QueueBuild xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <buildRequest BuildAgentUri="string" BuildDefinitionUri="string" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" CustomGetVersion="string" MaxQueuePosition="int" RequestedFor="string">
        <CommandLineArguments>string</CommandLineArguments>
      </buildRequest>
      <options>None or Preview</options>
    </QueueBuild>
  </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>
    <QueueBuildResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueueBuildResult Id="int" BuildAgentUri="string" BuildDefinitionUri="string" DropLocation="string" QueueTime="dateTime" QueuePosition="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" Status="None or InProgress or Queued or Postponed or Completed or Canceled or All" GetOption="LatestOnQueue or LatestOnBuild or Custom" CustomGetVersion="string" RequestedFor="string" RequestedBy="string">
        <CommandLineArguments>string</CommandLineArguments>
        <Build Uri="string" TeamProject="string" BuildNumber="string" BuildDefinitionUri="string" StartTime="dateTime" FinishTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or Triggered or All" Status="None or InProgress or Succeeded or PartiallySucceeded or Failed or Stopped or NotStarted or All" Quality="string" CompilationStatus="Unknown or Failed or Succeeded" TestStatus="Unknown or Failed or Succeeded" DropLocation="string" DropLocationRoot="string" LogLocation="string" BuildControllerUri="string" SourceGetVersion="string" RequestedFor="string" RequestedBy="string" LastChangedOn="dateTime" LastChangedBy="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean" BuildAgentUri="string" ConfigurationFolderUri="string" ShelvesetName="string">
          <ProcessParameters>string</ProcessParameters>
          <Information>
            <BuildInformationNode xsi:nil="true" />
            <BuildInformationNode xsi:nil="true" />
          </Information>
        </Build>
      </QueueBuildResult>
    </QueueBuildResponse>
  </soap12:Body>
</soap12:Envelope>