CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

getWorkflowById

This webservice fetches workflow for the given workflow Id.

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

<?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>
    <getWorkflowById xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowId>string</workflowId>
    </getWorkflowById>
  </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>
    <getWorkflowByIdResponse xmlns="http://www.birst.com/">
      <getWorkflowByIdResult>
        <workflowId>string</workflowId>
        <name>string</name>
        <description>string</description>
        <createdByUserId>string</createdByUserId>
        <createdByUsername>string</createdByUsername>
        <modifiedByUserId>string</modifiedByUserId>
        <modifiedByUsername>string</modifiedByUsername>
        <restricted>boolean</restricted>
        <accountId>string</accountId>
        <schedulerName>string</schedulerName>
        <schedulerDisplayName>string</schedulerDisplayName>
        <enableUserSyncUp>boolean</enableUserSyncUp>
        <sourceAppLids>
          <string>string</string>
          <string>string</string>
        </sourceAppLids>
        <targetAppLids>
          <string>string</string>
          <string>string</string>
        </targetAppLids>
        <steps>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
        </steps>
        <schedules>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
        </schedules>
        <notificationEmailIds>
          <string>string</string>
          <string>string</string>
        </notificationEmailIds>
      </getWorkflowByIdResult>
    </getWorkflowByIdResponse>
  </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>
    <getWorkflowById xmlns="http://www.birst.com/">
      <token>string</token>
      <workflowId>string</workflowId>
    </getWorkflowById>
  </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>
    <getWorkflowByIdResponse xmlns="http://www.birst.com/">
      <getWorkflowByIdResult>
        <workflowId>string</workflowId>
        <name>string</name>
        <description>string</description>
        <createdByUserId>string</createdByUserId>
        <createdByUsername>string</createdByUsername>
        <modifiedByUserId>string</modifiedByUserId>
        <modifiedByUsername>string</modifiedByUsername>
        <restricted>boolean</restricted>
        <accountId>string</accountId>
        <schedulerName>string</schedulerName>
        <schedulerDisplayName>string</schedulerDisplayName>
        <enableUserSyncUp>boolean</enableUserSyncUp>
        <sourceAppLids>
          <string>string</string>
          <string>string</string>
        </sourceAppLids>
        <targetAppLids>
          <string>string</string>
          <string>string</string>
        </targetAppLids>
        <steps>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
          <Step>
            <name>string</name>
            <description>string</description>
            <stepId>string</stepId>
            <parentStepId>string</parentStepId>
            <tasks xsi:nil="true" />
          </Step>
        </steps>
        <schedules>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
          <Schedule>
            <scheduleId>string</scheduleId>
            <enabled>boolean</enabled>
            <timeZone>string</timeZone>
            <cronExpression>string</cronExpression>
          </Schedule>
        </schedules>
        <notificationEmailIds>
          <string>string</string>
          <string>string</string>
        </notificationEmailIds>
      </getWorkflowByIdResult>
    </getWorkflowByIdResponse>
  </soap12:Body>
</soap12:Envelope>