VaultService Web Service

VaultService

Click here for a complete list of operations.

BeginDownloadShelvedFiles

Begin process of downloading a shelved file or files

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 /VaultService/VaultService.asmx HTTP/1.1
Host: vaultdemo.sourcegear.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sourcegear.com/schemas/vault/BeginDownloadShelvedFiles"

<?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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap:Header>
  <soap:Body>
    <BeginDownloadShelvedFiles xmlns="http://www.sourcegear.com/schemas/vault">
      <repid>int</repid>
      <ssid>long</ssid>
      <requests>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadShelvedFiles>
  </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>
    <BeginDownloadShelvedFilesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginDownloadShelvedFilesResult>int</BeginDownloadShelvedFilesResult>
      <requests>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadShelvedFilesResponse>
  </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 /VaultService/VaultService.asmx HTTP/1.1
Host: vaultdemo.sourcegear.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:Header>
    <VaultAuth xmlns="http://www.sourcegear.com/schemas/vault">
      <VaultSessionID>string</VaultSessionID>
      <Token>string</Token>
    </VaultAuth>
  </soap12:Header>
  <soap12:Body>
    <BeginDownloadShelvedFiles xmlns="http://www.sourcegear.com/schemas/vault">
      <repid>int</repid>
      <ssid>long</ssid>
      <requests>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadShelvedFiles>
  </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>
    <BeginDownloadShelvedFilesResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginDownloadShelvedFilesResult>int</BeginDownloadShelvedFilesResult>
      <requests>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
        <VaultRequestGetShelvedFile>
          <Item>
            <FileToken>string</FileToken>
            <Name>string</Name>
            <RepositoryPath>string</RepositoryPath>
            <Details>string</Details>
            <Type>int</Type>
            <Comment>string</Comment>
            <SerializedContents>base64Binary</SerializedContents>
            <ObjVerId>long</ObjVerId>
            <ObjId>long</ObjId>
            <ObjFullPath>string</ObjFullPath>
            <CompleteObjPath>boolean</CompleteObjPath>
            <DiskPathForUpload>string</DiskPathForUpload>
            <SSID>long</SSID>
            <SSItemID>int</SSItemID>
            <ModifiedDate xsi:nil="true" />
            <IDEClientRowNum>int</IDEClientRowNum>
            <FileLength>long</FileLength>
            <FileCRC>unsignedInt</FileCRC>
          </Item>
          <SsId>long</SsId>
          <RepId>int</RepId>
          <DestDiskPath>string</DestDiskPath>
          <UploadedFileName>string</UploadedFileName>
          <IsFolder>boolean</IsFolder>
        </VaultRequestGetShelvedFile>
      </requests>
      <strDownloadID>string</strDownloadID>
    </BeginDownloadShelvedFilesResponse>
  </soap12:Body>
</soap12:Envelope>