CommandWebService


Click here for a complete list of operations.

cloneDashboardPage

Creates a copy of given dashboard with an option of cloning the dashlets of the dashboard as well.

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

<?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>
    <cloneDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcDashboardLocation>PUBLIC or PRIVATE</srcDashboardLocation>
        <srcDashboardName>string</srcDashboardName>
        <srcPageName>string</srcPageName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
        <destDashboardName>string</destDashboardName>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
      </request>
    </cloneDashboardPage>
  </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>
    <cloneDashboardPageResponse xmlns="http://www.birst.com/">
      <cloneDashboardPageResult>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageResult>
    </cloneDashboardPageResponse>
  </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>
    <cloneDashboardPage xmlns="http://www.birst.com/">
      <token>string</token>
      <spaceID>string</spaceID>
      <request>
        <srcDashboardLocation>PUBLIC or PRIVATE</srcDashboardLocation>
        <srcDashboardName>string</srcDashboardName>
        <srcPageName>string</srcPageName>
        <destDashboardLocation>PUBLIC or PRIVATE</destDashboardLocation>
        <destDashboardName>string</destDashboardName>
        <destPageName>string</destPageName>
        <mode>DEEP or SHALLOW</mode>
      </request>
    </cloneDashboardPage>
  </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>
    <cloneDashboardPageResponse xmlns="http://www.birst.com/">
      <cloneDashboardPageResult>
        <status>PASS or FAIL</status>
        <destPageId>string</destPageId>
        <destDashboardId>string</destDashboardId>
        <destDashboardPath>string</destDashboardPath>
        <errorList>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
          <ErrorMessage>
            <description>string</description>
            <type>string</type>
            <name>string</name>
          </ErrorMessage>
        </errorList>
      </cloneDashboardPageResult>
    </cloneDashboardPageResponse>
  </soap12:Body>
</soap12:Envelope>