BuildService

Click here for a complete list of operations.

QueryBuildQueueById

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/QueryBuildQueueById"

<?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>
    <QueryBuildQueueById xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <ids>
        <int>int</int>
        <int>int</int>
      </ids>
      <options>None or Definitions or Agents or Workspaces or Controllers or Process or All</options>
    </QueryBuildQueueById>
  </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>
    <QueryBuildQueueByIdResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueryBuildQueueByIdResult>
        <Builds>
          <QueuedBuild 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 xsi:nil="true" />
          </QueuedBuild>
          <QueuedBuild 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 xsi:nil="true" />
          </QueuedBuild>
        </Builds>
        <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 xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </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 xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
        </Definitions>
        <Agents>
          <BuildAgent MachineName="string" Port="int" RequireSecureChannel="boolean" MaxProcesses="int" BuildDirectory="string" Status="Enabled or Disabled or Unreachable or Initializing" QueueCount="int">
            <StatusMessage>string</StatusMessage>
            <Description>string</Description>
          </BuildAgent>
          <BuildAgent MachineName="string" Port="int" RequireSecureChannel="boolean" MaxProcesses="int" BuildDirectory="string" Status="Enabled or Disabled or Unreachable or Initializing" QueueCount="int">
            <StatusMessage>string</StatusMessage>
            <Description>string</Description>
          </BuildAgent>
        </Agents>
      </QueryBuildQueueByIdResult>
    </QueryBuildQueueByIdResponse>
  </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>
    <QueryBuildQueueById xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <ids>
        <int>int</int>
        <int>int</int>
      </ids>
      <options>None or Definitions or Agents or Workspaces or Controllers or Process or All</options>
    </QueryBuildQueueById>
  </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>
    <QueryBuildQueueByIdResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueryBuildQueueByIdResult>
        <Builds>
          <QueuedBuild 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 xsi:nil="true" />
          </QueuedBuild>
          <QueuedBuild 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 xsi:nil="true" />
          </QueuedBuild>
        </Builds>
        <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 xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </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 xsi:nil="true" />
            <ProcessParameters>string</ProcessParameters>
            <RetentionPolicies xsi:nil="true" />
            <Schedules xsi:nil="true" />
            <WorkspaceTemplate xsi:nil="true" />
          </BuildDefinition>
        </Definitions>
        <Agents>
          <BuildAgent MachineName="string" Port="int" RequireSecureChannel="boolean" MaxProcesses="int" BuildDirectory="string" Status="Enabled or Disabled or Unreachable or Initializing" QueueCount="int">
            <StatusMessage>string</StatusMessage>
            <Description>string</Description>
          </BuildAgent>
          <BuildAgent MachineName="string" Port="int" RequireSecureChannel="boolean" MaxProcesses="int" BuildDirectory="string" Status="Enabled or Disabled or Unreachable or Initializing" QueueCount="int">
            <StatusMessage>string</StatusMessage>
            <Description>string</Description>
          </BuildAgent>
        </Agents>
      </QueryBuildQueueByIdResult>
    </QueryBuildQueueByIdResponse>
  </soap12:Body>
</soap12:Envelope>