CommandWebService


Click here for a complete list of operations.

getDirectoryPermissions

List the permissions for a particular directory. Arguments are Login token, space Id and directory (a null value means top level). Returns an XML representation of the directory permissions.

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

<?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>
    <getDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryPermissions>
  </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>
    <getDirectoryPermissionsResponse xmlns="http://www.birst.com/">
      <getDirectoryPermissionsResult>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
      </getDirectoryPermissionsResult>
    </getDirectoryPermissionsResponse>
  </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>
    <getDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dir>string</dir>
    </getDirectoryPermissions>
  </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>
    <getDirectoryPermissionsResponse xmlns="http://www.birst.com/">
      <getDirectoryPermissionsResult>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
        <GroupPermission>
          <groupName>string</groupName>
          <canView>boolean</canView>
          <canModify>boolean</canModify>
        </GroupPermission>
      </getDirectoryPermissionsResult>
    </getDirectoryPermissionsResponse>
  </soap12:Body>
</soap12:Envelope>