VaultService


Click here for a complete list of operations.

BeginLabelQuery

Open a query on the server for labels

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

<?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>
    <BeginLabelQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strItemPath>string</strItemPath>
      <nObjID>long</nObjID>
      <bGetRecursive>boolean</bGetRecursive>
      <bGetInherited>boolean</bGetInherited>
      <nObjTypeFlags>unsignedShort</nObjTypeFlags>
      <nRowLimit>long</nRowLimit>
    </BeginLabelQuery>
  </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>
    <BeginLabelQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginLabelQueryResult>int</BeginLabelQueryResult>
      <nRowsRetrieved>long</nRowsRetrieved>
      <nRowsRetrievedRecursive>long</nRowsRetrievedRecursive>
      <strQryToken>string</strQryToken>
    </BeginLabelQueryResponse>
  </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>
    <BeginLabelQuery xmlns="http://www.sourcegear.com/schemas/vault">
      <nRepID>int</nRepID>
      <strItemPath>string</strItemPath>
      <nObjID>long</nObjID>
      <bGetRecursive>boolean</bGetRecursive>
      <bGetInherited>boolean</bGetInherited>
      <nObjTypeFlags>unsignedShort</nObjTypeFlags>
      <nRowLimit>long</nRowLimit>
    </BeginLabelQuery>
  </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>
    <BeginLabelQueryResponse xmlns="http://www.sourcegear.com/schemas/vault">
      <BeginLabelQueryResult>int</BeginLabelQueryResult>
      <nRowsRetrieved>long</nRowsRetrieved>
      <nRowsRetrievedRecursive>long</nRowsRetrievedRecursive>
      <strQryToken>string</strQryToken>
    </BeginLabelQueryResponse>
  </soap12:Body>
</soap12:Envelope>