VaultService Web Service

VaultService

Click here for a complete list of operations.

AddLabelImport

Add a label from the Import tool. Only the admin user can call this method.

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

<?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>
    <AddLabelImport xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <vLabel>
        <ItemPath>string</ItemPath>
        <ImportItemPath>string</ImportItemPath>
        <Recursive>boolean</Recursive>
        <Label>string</Label>
        <ObjVerID>long</ObjVerID>
        <Comment>string</Comment>
        <LabelDate>
          <Ticks>long</Ticks>
        </LabelDate>
        <LabelResult>
          <LabelID>long</LabelID>
          <ExistingRootID>long</ExistingRootID>
          <ExistingRootPath>string</ExistingRootPath>
        </LabelResult>
        <IsImportLabel>boolean</IsImportLabel>
      </vLabel>
      <nTxUserID>int</nTxUserID>
    </AddLabelImport>
  </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>
    <AddLabelImportResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <AddLabelImportResult>int</AddLabelImportResult>
      <vLabel>
        <ItemPath>string</ItemPath>
        <ImportItemPath>string</ImportItemPath>
        <Recursive>boolean</Recursive>
        <Label>string</Label>
        <ObjVerID>long</ObjVerID>
        <Comment>string</Comment>
        <LabelDate>
          <Ticks>long</Ticks>
        </LabelDate>
        <LabelResult>
          <LabelID>long</LabelID>
          <ExistingRootID>long</ExistingRootID>
          <ExistingRootPath>string</ExistingRootPath>
        </LabelResult>
        <IsImportLabel>boolean</IsImportLabel>
      </vLabel>
    </AddLabelImportResponse>
  </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>
    <AddLabelImport xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <vLabel>
        <ItemPath>string</ItemPath>
        <ImportItemPath>string</ImportItemPath>
        <Recursive>boolean</Recursive>
        <Label>string</Label>
        <ObjVerID>long</ObjVerID>
        <Comment>string</Comment>
        <LabelDate>
          <Ticks>long</Ticks>
        </LabelDate>
        <LabelResult>
          <LabelID>long</LabelID>
          <ExistingRootID>long</ExistingRootID>
          <ExistingRootPath>string</ExistingRootPath>
        </LabelResult>
        <IsImportLabel>boolean</IsImportLabel>
      </vLabel>
      <nTxUserID>int</nTxUserID>
    </AddLabelImport>
  </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>
    <AddLabelImportResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <AddLabelImportResult>int</AddLabelImportResult>
      <vLabel>
        <ItemPath>string</ItemPath>
        <ImportItemPath>string</ImportItemPath>
        <Recursive>boolean</Recursive>
        <Label>string</Label>
        <ObjVerID>long</ObjVerID>
        <Comment>string</Comment>
        <LabelDate>
          <Ticks>long</Ticks>
        </LabelDate>
        <LabelResult>
          <LabelID>long</LabelID>
          <ExistingRootID>long</ExistingRootID>
          <ExistingRootPath>string</ExistingRootPath>
        </LabelResult>
        <IsImportLabel>boolean</IsImportLabel>
      </vLabel>
    </AddLabelImportResponse>
  </soap12:Body>
</soap12:Envelope>