BuildService

Click here for a complete list of operations.

QueryBuildQueue

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

<?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>
    <QueryBuildQueue xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <specs>
        <BuildQueueSpec Options="None or Definitions or Agents or Workspaces or Controllers or Process or All" StatusFlags="None or InProgress or Queued or Postponed or Completed or Canceled or All" CompletedAge="int">
          <AgentSpec MachineName="string" Port="int" />
          <DefinitionSpec>
            <ContinuousIntegrationType>None or Individual or Batch or Schedule or ScheduleForced or Gated or All</ContinuousIntegrationType>
            <Options>None or Definitions or Agents or Workspaces or Controllers or Process or All</Options>
          </DefinitionSpec>
        </BuildQueueSpec>
        <BuildQueueSpec Options="None or Definitions or Agents or Workspaces or Controllers or Process or All" StatusFlags="None or InProgress or Queued or Postponed or Completed or Canceled or All" CompletedAge="int">
          <AgentSpec MachineName="string" Port="int" />
          <DefinitionSpec>
            <ContinuousIntegrationType>None or Individual or Batch or Schedule or ScheduleForced or Gated or All</ContinuousIntegrationType>
            <Options>None or Definitions or Agents or Workspaces or Controllers or Process or All</Options>
          </DefinitionSpec>
        </BuildQueueSpec>
      </specs>
    </QueryBuildQueue>
  </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>
    <QueryBuildQueueResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueryBuildQueueResult>
        <BuildQueueQueryResult>
          <Builds>
            <QueuedBuild xsi:nil="true" />
            <QueuedBuild xsi:nil="true" />
          </Builds>
          <Definitions>
            <BuildDefinition xsi:nil="true" />
            <BuildDefinition xsi:nil="true" />
          </Definitions>
          <Agents>
            <BuildAgent xsi:nil="true" />
            <BuildAgent xsi:nil="true" />
          </Agents>
        </BuildQueueQueryResult>
        <BuildQueueQueryResult>
          <Builds>
            <QueuedBuild xsi:nil="true" />
            <QueuedBuild xsi:nil="true" />
          </Builds>
          <Definitions>
            <BuildDefinition xsi:nil="true" />
            <BuildDefinition xsi:nil="true" />
          </Definitions>
          <Agents>
            <BuildAgent xsi:nil="true" />
            <BuildAgent xsi:nil="true" />
          </Agents>
        </BuildQueueQueryResult>
      </QueryBuildQueueResult>
    </QueryBuildQueueResponse>
  </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>
    <QueryBuildQueue xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <specs>
        <BuildQueueSpec Options="None or Definitions or Agents or Workspaces or Controllers or Process or All" StatusFlags="None or InProgress or Queued or Postponed or Completed or Canceled or All" CompletedAge="int">
          <AgentSpec MachineName="string" Port="int" />
          <DefinitionSpec>
            <ContinuousIntegrationType>None or Individual or Batch or Schedule or ScheduleForced or Gated or All</ContinuousIntegrationType>
            <Options>None or Definitions or Agents or Workspaces or Controllers or Process or All</Options>
          </DefinitionSpec>
        </BuildQueueSpec>
        <BuildQueueSpec Options="None or Definitions or Agents or Workspaces or Controllers or Process or All" StatusFlags="None or InProgress or Queued or Postponed or Completed or Canceled or All" CompletedAge="int">
          <AgentSpec MachineName="string" Port="int" />
          <DefinitionSpec>
            <ContinuousIntegrationType>None or Individual or Batch or Schedule or ScheduleForced or Gated or All</ContinuousIntegrationType>
            <Options>None or Definitions or Agents or Workspaces or Controllers or Process or All</Options>
          </DefinitionSpec>
        </BuildQueueSpec>
      </specs>
    </QueryBuildQueue>
  </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>
    <QueryBuildQueueResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/Build/BuildService/03">
      <QueryBuildQueueResult>
        <BuildQueueQueryResult>
          <Builds>
            <QueuedBuild xsi:nil="true" />
            <QueuedBuild xsi:nil="true" />
          </Builds>
          <Definitions>
            <BuildDefinition xsi:nil="true" />
            <BuildDefinition xsi:nil="true" />
          </Definitions>
          <Agents>
            <BuildAgent xsi:nil="true" />
            <BuildAgent xsi:nil="true" />
          </Agents>
        </BuildQueueQueryResult>
        <BuildQueueQueryResult>
          <Builds>
            <QueuedBuild xsi:nil="true" />
            <QueuedBuild xsi:nil="true" />
          </Builds>
          <Definitions>
            <BuildDefinition xsi:nil="true" />
            <BuildDefinition xsi:nil="true" />
          </Definitions>
          <Agents>
            <BuildAgent xsi:nil="true" />
            <BuildAgent xsi:nil="true" />
          </Agents>
        </BuildQueueQueryResult>
      </QueryBuildQueueResult>
    </QueryBuildQueueResponse>
  </soap12:Body>
</soap12:Envelope>