CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

createProfile

Creates a profile with default options. Arguments are Login token and Profile Name.

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

<?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>
    <createProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
    </createProfile>
  </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>
    <createProfileResponse xmlns="http://www.birst.com/">
      <createProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </createProfileResult>
    </createProfileResponse>
  </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>
    <createProfile xmlns="http://www.birst.com/">
      <token>string</token>
      <name>string</name>
      <description>string</description>
    </createProfile>
  </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>
    <createProfileResponse xmlns="http://www.birst.com/">
      <createProfileResult>
        <id>string</id>
        <name>string</name>
        <description>string</description>
        <isDefault>string</isDefault>
        <properties>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
          <ProfileProperty>
            <name>string</name>
            <value>string</value>
            <locale>string</locale>
          </ProfileProperty>
        </properties>
      </createProfileResult>
    </createProfileResponse>
  </soap12:Body>
</soap12:Envelope>