BuildDeploymentService Web Service

BuildDeploymentService

Click here for a complete list of operations.

QueryDeployments

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/BuildDeploymentService.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/QueryDeployments"

<?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>
    <QueryDeployments xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <spec DefinitionPath="string" EnvironmentName="string" MaxDeployments="int" MinFinishTime="dateTime" MaxFinishTime="dateTime" DeploymentStatus="None or InProgress or Succeeded or PartiallySucceeded or Failed or Stopped or NotStarted or All" QueryOrder="StartTimeAscending or StartTimeDescending or FinishTimeAscending or FinishTimeDescending" RequestedFor="string" TeamProject="string" />
    </QueryDeployments>
  </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>
    <QueryDeploymentsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <QueryDeploymentsResult>
        <BuildDeployment DeploymentDefinitionName="string" WebsiteUrl="string">
          <Deployment Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Deployment>
          <Source Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Source>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
        </BuildDeployment>
        <BuildDeployment DeploymentDefinitionName="string" WebsiteUrl="string">
          <Deployment Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Deployment>
          <Source Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Source>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
        </BuildDeployment>
      </QueryDeploymentsResult>
    </QueryDeploymentsResponse>
  </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/BuildDeploymentService.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>
    <QueryDeployments xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <spec DefinitionPath="string" EnvironmentName="string" MaxDeployments="int" MinFinishTime="dateTime" MaxFinishTime="dateTime" DeploymentStatus="None or InProgress or Succeeded or PartiallySucceeded or Failed or Stopped or NotStarted or All" QueryOrder="StartTimeAscending or StartTimeDescending or FinishTimeAscending or FinishTimeDescending" RequestedFor="string" TeamProject="string" />
    </QueryDeployments>
  </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>
    <QueryDeploymentsResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2010/Build">
      <QueryDeploymentsResult>
        <BuildDeployment DeploymentDefinitionName="string" WebsiteUrl="string">
          <Deployment Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Deployment>
          <Source Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Source>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
        </BuildDeployment>
        <BuildDeployment DeploymentDefinitionName="string" WebsiteUrl="string">
          <Deployment Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Deployment>
          <Source Uri="string" Number="string" 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" StartTime="dateTime" FinishTime="dateTime" KeepForever="boolean">
            <ChangeSet xsi:nil="true" />
            <RequestedFor xsi:nil="true" />
          </Source>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
        </BuildDeployment>
      </QueryDeploymentsResult>
    </QueryDeploymentsResponse>
  </soap12:Body>
</soap12:Envelope>