Repository Web Service

Repository

Click here for a complete list of operations.

Shelve

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/VersionControl/v1.0/Repository.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/VersionControl/ClientServices/03/Shelve"

<?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>
    <Shelve xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03">
      <workspaceName>string</workspaceName>
      <workspaceOwner>string</workspaceOwner>
      <serverItems>
        <string>string</string>
        <string>string</string>
      </serverItems>
      <shelveset date="dateTime" name="string" owner="string" ownerdisp="string" owneruniq="string" ce="boolean">
        <Comment>string</Comment>
        <PolicyOverrideComment>string</PolicyOverrideComment>
        <CheckinNote>
          <Values>
            <CheckinNoteFieldValue xsi:nil="true" />
            <CheckinNoteFieldValue xsi:nil="true" />
          </Values>
        </CheckinNote>
        <Links>
          <VersionControlLink type="int" url="string" />
          <VersionControlLink type="int" url="string" />
        </Links>
        <Properties>
          <PropertyValue pname="string">
            <val />
            <ChangedBy>guid</ChangedBy>
            <ChangedDate>dateTime</ChangedDate>
          </PropertyValue>
          <PropertyValue pname="string">
            <val />
            <ChangedBy>guid</ChangedBy>
            <ChangedDate>dateTime</ChangedDate>
          </PropertyValue>
        </Properties>
      </shelveset>
      <replace>boolean</replace>
    </Shelve>
  </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>
    <ShelveResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03">
      <ShelveResult>
        <Failure req="None or Add or Branch or Encoding or Edit or Delete or Lock or Rename or Undelete or Property" code="string" sev="Error or Warning" computer="string" ident="string" local="string" res="string" item="string" itemid="int" ws="string" owner="string">
          <Warnings>
            <Warning xsi:nil="true" />
            <Warning xsi:nil="true" />
          </Warnings>
          <Message>string</Message>
        </Failure>
        <Failure req="None or Add or Branch or Encoding or Edit or Delete or Lock or Rename or Undelete or Property" code="string" sev="Error or Warning" computer="string" ident="string" local="string" res="string" item="string" itemid="int" ws="string" owner="string">
          <Warnings>
            <Warning xsi:nil="true" />
            <Warning xsi:nil="true" />
          </Warnings>
          <Message>string</Message>
        </Failure>
      </ShelveResult>
    </ShelveResponse>
  </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/VersionControl/v1.0/Repository.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>
    <Shelve xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03">
      <workspaceName>string</workspaceName>
      <workspaceOwner>string</workspaceOwner>
      <serverItems>
        <string>string</string>
        <string>string</string>
      </serverItems>
      <shelveset date="dateTime" name="string" owner="string" ownerdisp="string" owneruniq="string" ce="boolean">
        <Comment>string</Comment>
        <PolicyOverrideComment>string</PolicyOverrideComment>
        <CheckinNote>
          <Values>
            <CheckinNoteFieldValue xsi:nil="true" />
            <CheckinNoteFieldValue xsi:nil="true" />
          </Values>
        </CheckinNote>
        <Links>
          <VersionControlLink type="int" url="string" />
          <VersionControlLink type="int" url="string" />
        </Links>
        <Properties>
          <PropertyValue pname="string">
            <val />
            <ChangedBy>guid</ChangedBy>
            <ChangedDate>dateTime</ChangedDate>
          </PropertyValue>
          <PropertyValue pname="string">
            <val />
            <ChangedBy>guid</ChangedBy>
            <ChangedDate>dateTime</ChangedDate>
          </PropertyValue>
        </Properties>
      </shelveset>
      <replace>boolean</replace>
    </Shelve>
  </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>
    <ShelveResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2005/06/VersionControl/ClientServices/03">
      <ShelveResult>
        <Failure req="None or Add or Branch or Encoding or Edit or Delete or Lock or Rename or Undelete or Property" code="string" sev="Error or Warning" computer="string" ident="string" local="string" res="string" item="string" itemid="int" ws="string" owner="string">
          <Warnings>
            <Warning xsi:nil="true" />
            <Warning xsi:nil="true" />
          </Warnings>
          <Message>string</Message>
        </Failure>
        <Failure req="None or Add or Branch or Encoding or Edit or Delete or Lock or Rename or Undelete or Property" code="string" sev="Error or Warning" computer="string" ident="string" local="string" res="string" item="string" itemid="int" ws="string" owner="string">
          <Warnings>
            <Warning xsi:nil="true" />
            <Warning xsi:nil="true" />
          </Warnings>
          <Message>string</Message>
        </Failure>
      </ShelveResult>
    </ShelveResponse>
  </soap12:Body>
</soap12:Envelope>