CommandWebService Web Service

CommandWebService

Click here for a complete list of operations.

copyWorkflow

Copy the workflow from one account into another. The arguments are the Login token, the source account ID, the workflow ID to copy from, the target account ID, the owner ID of the new workflow in target account, the mode(copy/replicate) which is a optional parameter which in case if the mode isreplicate then if there is any workflow with given name in target account then this APIs overrides that workflow in the target account, the space ID mapping for workflow task parameters, the user ID mapping for workflow task parameters, the connection ID mapping for workflow task parameters, application lid mapping for workflow task parameters

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

<?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>
    <copyWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <fromAccountId>string</fromAccountId>
      <fromWorkflowId>string</fromWorkflowId>
      <toAccountId>string</toAccountId>
      <workflowOwnerId>string</workflowOwnerId>
      <restricted>boolean</restricted>
      <mode>string</mode>
      <toWorkflowName>string</toWorkflowName>
      <spaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
      </spaceIdMapping>
      <userIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
      </userIdMapping>
      <connectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
      </connectionIdMapping>
      <applicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
      </applicationLidMapping>
    </copyWorkflow>
  </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>
    <copyWorkflowResponse xmlns="http://www.birst.com/">
      <copyWorkflowResult>string</copyWorkflowResult>
    </copyWorkflowResponse>
  </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>
    <copyWorkflow xmlns="http://www.birst.com/">
      <token>string</token>
      <fromAccountId>string</fromAccountId>
      <fromWorkflowId>string</fromWorkflowId>
      <toAccountId>string</toAccountId>
      <workflowOwnerId>string</workflowOwnerId>
      <restricted>boolean</restricted>
      <mode>string</mode>
      <toWorkflowName>string</toWorkflowName>
      <spaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
        <SpaceIdMapping>
          <fromSpaceId>string</fromSpaceId>
          <toSpaceId>string</toSpaceId>
        </SpaceIdMapping>
      </spaceIdMapping>
      <userIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
        <UserIdMapping>
          <fromUserId>string</fromUserId>
          <toUserId>string</toUserId>
        </UserIdMapping>
      </userIdMapping>
      <connectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
        <ConnectionIdMapping>
          <fromConnectionId>string</fromConnectionId>
          <toConnectionId>string</toConnectionId>
        </ConnectionIdMapping>
      </connectionIdMapping>
      <applicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
        <ApplicationLidMapping>
          <fromApplicationLId>string</fromApplicationLId>
          <toApplicationLId>string</toApplicationLId>
        </ApplicationLidMapping>
      </applicationLidMapping>
    </copyWorkflow>
  </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>
    <copyWorkflowResponse xmlns="http://www.birst.com/">
      <copyWorkflowResult>string</copyWorkflowResult>
    </copyWorkflowResponse>
  </soap12:Body>
</soap12:Envelope>