CommandWebService


Click here for a complete list of operations.

setDirectoryPermissions

Sets permissions for a user on a space (bulk operation). Arguments are Login token, space id, directories, group names, permissions and values for 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/setDirectoryPermissions"

<?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>
    <setDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dirs>
        <string>string</string>
        <string>string</string>
      </dirs>
      <perms>
        <ArrayOfGroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
        </ArrayOfGroupPermission>
        <ArrayOfGroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
        </ArrayOfGroupPermission>
      </perms>
    </setDirectoryPermissions>
  </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>
    <setDirectoryPermissionsResponse xmlns="http://www.birst.com/" />
  </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>
    <setDirectoryPermissions xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <dirs>
        <string>string</string>
        <string>string</string>
      </dirs>
      <perms>
        <ArrayOfGroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
        </ArrayOfGroupPermission>
        <ArrayOfGroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
          <GroupPermission>
            <groupName>string</groupName>
            <canView>boolean</canView>
            <canModify>boolean</canModify>
          </GroupPermission>
        </ArrayOfGroupPermission>
      </perms>
    </setDirectoryPermissions>
  </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>
    <setDirectoryPermissionsResponse xmlns="http://www.birst.com/" />
  </soap12:Body>
</soap12:Envelope>