Workflow Invocation as REST API

This API enables you to access a workflow in Siebel REST API.

In the example below, you invoke a workflow named EAISiebDemo1. The inputs and outputs depict a workflow that accepts a Siebel message as input, and then responds with a Siebel message, in this case a EAI Siebel Adapter query.

  • URI: https://ServerName:port/siebel/v1.0/workflow/EAISiebDemo1

  • HTTP Method: POST

  • Accept: application/xml

  • Request body:
    <?xml version="1.0" encoding="UTF-8"?>
    <request>
       <SiebelMessage>
          <MessageId />
          <MessageType>Integration Object</MessageType>
          <IntObjectName>EAI Account</IntObjectName>
          <IntObjectFormat>Siebel Hierarchical</IntObjectFormat>
          <ListOfEAI_spcAccount>
             <Account>
                <Name>REST Acc7</Name>
                <Location>HQ-Distribution</Location>
             </Account>
          </ListOfEAI_spcAccount>
       </SiebelMessage>
    </request>
  • Response body:
    <?xml version="1.0" encoding="UTF-8"?>
    <response>
       <InOut1 />
       <Error_spcCode />
       <Siebel_spcOperation_spcObject_spcId />
       <Process_spcInstance_spcId>88-2ZA5HY</Process_spcInstance_spcId>
       <Error_spcMessage />
       <Object_spcId />
       <SiebelMessage>
          <IntObjectFormat>Siebel Hierarchical</IntObjectFormat>
          <MessageId>88-4JURS</MessageId>
          <IntObjectName>EAI Account</IntObjectName>
          <MessageType>Integration Object</MessageType>
          <ListOfEAI_spcAccount>
             <Account>
                <Location>HQ-Distribution</Location>
                <EAI_spcSync_spcStatus_spcCode />
                <Region />
                <Home_spcPage />
                <Name>REST Acc7</Name>
                <EAI_spcSync_spcDate />
                ..........................
    			<Managers_spcReview />
                <Price_spcList_spcIntegration_spcId />
                <ListOfContact>
                   <Contact>
                      <Preferred_spcCommunications />
                      <First_spcName>Test_123467</First_spcName>
                      <M_slhF />
                      <Middle_spcName>Test_12346</Middle_spcName>
                      <Cellular_spcPhone_spc_pnd />
                      <Job_spcTitle />
                      <Home_spcPhone_spc_pnd />
                      ............................
                      <ListOfContact_undOrganization>
                         <Contact_undOrganization>
                            <Organization>Default Organization</Organization>
                            <Organization_spcIntegration_spcId />
                         </Contact_undOrganization>
                      </ListOfContact_undOrganization>
                   </Contact>
                </ListOfContact>
                <ListOfAccount_undPosition>
                   <Account_undPosition>
                      <Position>Siebel Administrator</Position>
                      <Position_spcIntegration_spcId />
                   </Account_undPosition>
                </ListOfAccount_undPosition>
                <ListOfAccount_undOrganization>
                   <Account_undOrganization>
                      <Organization>Default Organization</Organization>
                      <Organization_spcId>0-R9NH</Organization_spcId>
                      <Organization_spcIntegration_spcId />
                   </Account_undOrganization>
                </ListOfAccount_undOrganization>
             </Account>
          </ListOfEAI_spcAccount>
       </SiebelMessage>
    </response>

In the example below, you also invoke a workflow named eSales - Save Account ShippingAddress. However, the inputs and outputs depict a workflow that accepts address details as input, and then responds with an updated CUT address.

  • URL: https://ServerName:port/siebel/v1.0/workflow/eSales - Save Account Shipping Address

  • HTTP Method: POST

  • Accept: application/xml

  • Request body:
    <?xml version="1.0" ?>
    <request>
     <Object_spcId>89-ZCBD</Object_spcId>
      <Address_spcId>89-ZCBY</Address_spcId>
      <Street_spcAddress>Street address sample1</Street_spcAddress>
      <State>CA</State>
      <City>SM</City>
    </request>
  • Response body:
    <?xml version="1.0" ?>
    <response>
        <Error_spcCode></Error_spcCode>
        <Address_spcId>89-ZCBY</Address_spcId>
        <Street_spcAddress>Street address sample1</Street_spcAddress>
        <Siebel_spcOperation_spcObject_spcId>89-ZCBY</Siebel_spcOperation_spcObject_spcId>
        <Process_spcInstance_spcId>88-2ZO38H</Process_spcInstance_spcId>
        <Object_spcId>89-ZCBD</Object_spcId>
        <Error_spcMessage></Error_spcMessage>
        <Street_spcAddress_spc2></Street_spcAddress_spc2>
        <City>SM</City>
        <State>CA</State>
        <Country></Country>
        <Postal_spcCode></Postal_spcCode>
    </response>