BuildQueueService Web Service

BuildQueueService

Click here for a complete list of operations.

UpdateBuilds

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/V4.0/BuildQueueService.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/Build/UpdateBuilds"

<?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>
    <UpdateBuilds xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <updates>
        <QueuedBuildUpdateOptions QueueId="int" Fields="None or Priority or Postponed or Retry or BatchId or Requeue" BatchId="guid" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" Retry="boolean" RetryOption="None or InProgressBuild or CompletedBuild" />
        <QueuedBuildUpdateOptions QueueId="int" Fields="None or Priority or Postponed or Retry or BatchId or Requeue" BatchId="guid" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" Retry="boolean" RetryOption="None or InProgressBuild or CompletedBuild" />
      </updates>
    </UpdateBuilds>
  </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>
    <UpdateBuildsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <UpdateBuildsResult>
        <Definitions>
          <BuildDefinition BatchSize="int" BuildControllerUri="string" TriggerType="None or ContinuousIntegration or BatchedContinuousIntegration or Schedule or ScheduleForced or GatedCheckIn or BatchedGatedCheckIn or BuildCompletion or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" QueueStatus="Enabled or Paused or Disabled" FullPath="string" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" Uri="string" DateCreated="dateTime">
            <Description>string</Description>
            <Process xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <SourceProviders xsi:nil="true" />
            <Properties xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
          <BuildDefinition BatchSize="int" BuildControllerUri="string" TriggerType="None or ContinuousIntegration or BatchedContinuousIntegration or Schedule or ScheduleForced or GatedCheckIn or BatchedGatedCheckIn or BuildCompletion or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" QueueStatus="Enabled or Paused or Disabled" FullPath="string" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" Uri="string" DateCreated="dateTime">
            <Description>string</Description>
            <Process xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <SourceProviders xsi:nil="true" />
            <Properties xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
        </Definitions>
        <QueuedBuilds>
          <QueuedBuild BatchId="guid" BuildControllerUri="string" BuildDefinitionUri="string" CustomGetVersion="string" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" Id="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" QueuePosition="int" QueueTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or BuildCompletion or ResourceTrigger or Triggered or All" RequestedBy="string" RequestedByDisplayName="string" RequestedFor="string" RequestedForDisplayName="string" ShelvesetName="string" Status="None or InProgress or Retry or Queued or Postponed or Completed or Canceled or All" TeamProject="string">
            <BuildUris xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
          </QueuedBuild>
          <QueuedBuild BatchId="guid" BuildControllerUri="string" BuildDefinitionUri="string" CustomGetVersion="string" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" Id="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" QueuePosition="int" QueueTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or BuildCompletion or ResourceTrigger or Triggered or All" RequestedBy="string" RequestedByDisplayName="string" RequestedFor="string" RequestedForDisplayName="string" ShelvesetName="string" Status="None or InProgress or Retry or Queued or Postponed or Completed or Canceled or All" TeamProject="string">
            <BuildUris xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
          </QueuedBuild>
        </QueuedBuilds>
        <Builds>
          <BuildDetail 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 BuildCompletion or ResourceTrigger 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" LastChangedOn="dateTime" LastChangedBy="string" LastChangedByDisplayName="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean">
            <ProcessParameters>string</ProcessParameters>
            <LastChangeByTFID>guid</LastChangeByTFID>
            <QueueIds xsi:nil="true" />
            <Information xsi:nil="true" />
            <ContainerId>long</ContainerId>
          </BuildDetail>
          <BuildDetail 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 BuildCompletion or ResourceTrigger 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" LastChangedOn="dateTime" LastChangedBy="string" LastChangedByDisplayName="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean">
            <ProcessParameters>string</ProcessParameters>
            <LastChangeByTFID>guid</LastChangeByTFID>
            <QueueIds xsi:nil="true" />
            <Information xsi:nil="true" />
            <ContainerId>long</ContainerId>
          </BuildDetail>
        </Builds>
        <Agents>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
        </Agents>
        <Controllers>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
        </Controllers>
        <ServiceHosts>
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
        </ServiceHosts>
      </UpdateBuildsResult>
    </UpdateBuildsResponse>
  </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/V4.0/BuildQueueService.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>
    <UpdateBuilds xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <updates>
        <QueuedBuildUpdateOptions QueueId="int" Fields="None or Priority or Postponed or Retry or BatchId or Requeue" BatchId="guid" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" Retry="boolean" RetryOption="None or InProgressBuild or CompletedBuild" />
        <QueuedBuildUpdateOptions QueueId="int" Fields="None or Priority or Postponed or Retry or BatchId or Requeue" BatchId="guid" Priority="Low or BelowNormal or Normal or AboveNormal or High" Postponed="boolean" Retry="boolean" RetryOption="None or InProgressBuild or CompletedBuild" />
      </updates>
    </UpdateBuilds>
  </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>
    <UpdateBuildsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <UpdateBuildsResult>
        <Definitions>
          <BuildDefinition BatchSize="int" BuildControllerUri="string" TriggerType="None or ContinuousIntegration or BatchedContinuousIntegration or Schedule or ScheduleForced or GatedCheckIn or BatchedGatedCheckIn or BuildCompletion or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" QueueStatus="Enabled or Paused or Disabled" FullPath="string" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" Uri="string" DateCreated="dateTime">
            <Description>string</Description>
            <Process xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <SourceProviders xsi:nil="true" />
            <Properties xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
          <BuildDefinition BatchSize="int" BuildControllerUri="string" TriggerType="None or ContinuousIntegration or BatchedContinuousIntegration or Schedule or ScheduleForced or GatedCheckIn or BatchedGatedCheckIn or BuildCompletion or All" ContinuousIntegrationQuietPeriod="int" DefaultDropLocation="string" QueueStatus="Enabled or Paused or Disabled" FullPath="string" LastBuildUri="string" LastGoodBuildUri="string" LastGoodBuildLabel="string" Uri="string" DateCreated="dateTime">
            <Description>string</Description>
            <Process xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <SourceProviders xsi:nil="true" />
            <Properties xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
        </Definitions>
        <QueuedBuilds>
          <QueuedBuild BatchId="guid" BuildControllerUri="string" BuildDefinitionUri="string" CustomGetVersion="string" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" Id="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" QueuePosition="int" QueueTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or BuildCompletion or ResourceTrigger or Triggered or All" RequestedBy="string" RequestedByDisplayName="string" RequestedFor="string" RequestedForDisplayName="string" ShelvesetName="string" Status="None or InProgress or Retry or Queued or Postponed or Completed or Canceled or All" TeamProject="string">
            <BuildUris xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
          </QueuedBuild>
          <QueuedBuild BatchId="guid" BuildControllerUri="string" BuildDefinitionUri="string" CustomGetVersion="string" DropLocation="string" GetOption="LatestOnQueue or LatestOnBuild or Custom" Id="int" Priority="Low or BelowNormal or Normal or AboveNormal or High" QueuePosition="int" QueueTime="dateTime" Reason="None or Manual or IndividualCI or BatchedCI or Schedule or ScheduleForced or UserCreated or ValidateShelveset or CheckInShelveset or BuildCompletion or ResourceTrigger or Triggered or All" RequestedBy="string" RequestedByDisplayName="string" RequestedFor="string" RequestedForDisplayName="string" ShelvesetName="string" Status="None or InProgress or Retry or Queued or Postponed or Completed or Canceled or All" TeamProject="string">
            <BuildUris xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
          </QueuedBuild>
        </QueuedBuilds>
        <Builds>
          <BuildDetail 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 BuildCompletion or ResourceTrigger 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" LastChangedOn="dateTime" LastChangedBy="string" LastChangedByDisplayName="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean">
            <ProcessParameters>string</ProcessParameters>
            <LastChangeByTFID>guid</LastChangeByTFID>
            <QueueIds xsi:nil="true" />
            <Information xsi:nil="true" />
            <ContainerId>long</ContainerId>
          </BuildDetail>
          <BuildDetail 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 BuildCompletion or ResourceTrigger 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" LastChangedOn="dateTime" LastChangedBy="string" LastChangedByDisplayName="string" KeepForever="boolean" LabelName="string" IsDeleted="boolean">
            <ProcessParameters>string</ProcessParameters>
            <LastChangeByTFID>guid</LastChangeByTFID>
            <QueueIds xsi:nil="true" />
            <Information xsi:nil="true" />
            <ContainerId>long</ContainerId>
          </BuildDetail>
        </Builds>
        <Agents>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
          <BuildAgent Uri="string" ServiceHostUri="string" ControllerUri="string" Name="string" BuildDirectory="string" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime" ReservedForBuild="string">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildAgent>
        </Agents>
        <Controllers>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
          <BuildController Uri="string" ServiceHostUri="string" Name="string" CustomAssemblyPath="string" MaxConcurrentBuilds="int" QueueCount="int" Status="Unavailable or Available or Offline" StatusMessage="string" Enabled="boolean" Url="string" MessageQueueUrl="string" DateCreated="dateTime" DateUpdated="dateTime">
            <Description>string</Description>
            <Properties xsi:nil="true" />
            <Tags xsi:nil="true" />
          </BuildController>
        </Controllers>
        <ServiceHosts>
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
          <BuildServiceHost BaseUrl="string" IsVirtual="boolean" MessageQueueUrl="string" Name="string" RequireClientCertificates="boolean" Status="Online or Offline" StatusChangedOn="dateTime" AcquiredOn="dateTime" ConnectedOn="dateTime" Uri="string" />
        </ServiceHosts>
      </UpdateBuildsResult>
    </UpdateBuildsResponse>
  </soap12:Body>
</soap12:Envelope>