CommandWebService


Click here for a complete list of operations.

getDirectoryContents

List the files and directories in a directory for a space. Arguments are Login token, space id and directory (null value means top level). Returns an XML representation of the contents of the directory.

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 /CommandWebService.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.birst.com/getDirectoryContents"

<?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>
    <getDirectoryContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryContents>
  </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>
    <getDirectoryContentsResponse xmlns="http://www.birst.com/">
      <getDirectoryContentsResult>
        <name>string</name>
        <label>string</label>
        <isDirectory>boolean</isDirectory>
        <isWriteable>boolean</isWriteable>
        <lastModified>string</lastModified>
        <isDashboard>boolean</isDashboard>
        <createdBy>string</createdBy>
        <children>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
        </children>
      </getDirectoryContentsResult>
    </getDirectoryContentsResponse>
  </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 /CommandWebService.asmx HTTP/1.1
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>
    <getDirectoryContents xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryContents>
  </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>
    <getDirectoryContentsResponse xmlns="http://www.birst.com/">
      <getDirectoryContentsResult>
        <name>string</name>
        <label>string</label>
        <isDirectory>boolean</isDirectory>
        <isWriteable>boolean</isWriteable>
        <lastModified>string</lastModified>
        <isDashboard>boolean</isDashboard>
        <createdBy>string</createdBy>
        <children>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
          <FileNode>
            <name>string</name>
            <label>string</label>
            <isDirectory>boolean</isDirectory>
            <isWriteable>boolean</isWriteable>
            <lastModified>string</lastModified>
            <isDashboard>boolean</isDashboard>
            <createdBy>string</createdBy>
            <children xsi:nil="true" />
          </FileNode>
        </children>
      </getDirectoryContentsResult>
    </getDirectoryContentsResponse>
  </soap12:Body>
</soap12:Envelope>