Workflow Invocation as REST API

This API enables you to run a workflow as Siebel REST API.

In this 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/json

• Request body:

  {
      "Object Id":Opt_Id", 
      "Process Instance Id":Opt_Id",
      "Siebel Operation Object Id":Opt_Id"       
      "SiebelMessage":{
           "MessageId":"",
           "MessageType":"Integration Object",
           "IntObjectName":"EAI Account",
           "IntObjectFormat":"Siebel Hierarchical",
           "ListOfEAI Account":{
              "Account": [{
                 "Name":"REST Acc7",
                 "Location": "HQ-Distribution",
                 "Description": "AccountData6",
                 "ListOfContact": {
                          "Contact": [ {
                              "First Name": "Test_12367",
                              "Middle Name": "Test_1236",
                              "Last Name": "Test_12367"
                                      } ]
                              }
                      }]
                  }
          }
  }

• Response body:

  {
      "InOut1": "",
      "Error Code": "",
      "Siebel Operation Object Id": "",
      "Process Instance Id": "88-2ZA5HG",
      "Error Message": "",
      "Object Id": "",
      "SiebelMessage": {
          "IntObjectFormat": "Siebel Hierarchical",
          "MessageId": "88-4JURI",
          "IntObjectName": "EAI Account",
          "MessageType": "Integration Object",
          "ListOfEAI Account": {
              "Account": [
                  {
                      "Freight Terms": "",
                      "Location": "HQ-Distribution",
                      "EAI Sync Status Code": "",
                      "Region": "",
                      "Home Page": "",
                      "Name": "REST Acc7",
                      "EAI Sync Date": "",
                      "Last Manager Review Date": "",
                      "Type": "Customer",
                      "Freight Terms Info": "",
                      "Competitor": "N",
                      "Integration Id": "",
                      "Price List Id": "",
                      "DUNS Number": "",
                      "Division": "",
                      "GSA Flag": "",
                      "Partner Flag": "N",
                      "CSN": "88-2Z64JB",
                      "Main Fax Number": "",
                      "Price List": "",
                      "Account Status": "Active",
                      "Language Code": "ENU",
                      "Alias": "",
                      "Main Phone Number": "",
                      "Description": "AccountData6",
                      "Currency Code": "USD",
                      "EAI Sync Error Text": "",
                      "Prospect Flag": "N",
                      "Managers Review": "",
                      "Price List Integration Id": "",
                      "ListOfContact": {
                          "Contact": [
                              {
                                  "M/M": "",
                                  "Active Status": "Y",
                                  "Fax Phone #": "",
                                  "Preferred Language Code": "",
                                  "Email Address": "",
                                  "Preferred Communications": "",
                                  "First Name": "Test_12367",
                                  "M/F": "",
                                  "Middle Name": "Test_1236",
                                  "Cellular Phone #": "",
                                  "Job Title": "",
                                  "Home Phone #": "",
                                  "Assistant Phone #": "",
                                  "Work Phone #": "",
                                  "Integration Id": "",
                                  "Last Name": "Test_12367",
                                  "ListOfContact_Organization": {
                                      "Contact_Organization": [
                                          {
                                              "Organization": "Default Organization",
                                              "Organization Integration Id": ""
                                          }
                                      ]
                                  }
                              }
                          ]
                      },
                      "ListOfAccount_Position": {
                          "Account_Position": [
                              {
                                  "Position": "Siebel Administrator",
                                  "Position Integration Id": ""
                              }
                          ]
                      },
                      "ListOfAccount_Organization": {
                          "Account_Organization": [
                              {
                                  "Organization": "Default Organization",
                                  "Organization Id": "0-R9NH",
                                  "Organization Integration Id": ""
                              }
                          ]
                      }
                  }
              ]
          }
      }
  }

In the example below, you invoke a workflow named eSales - Save Account Shipping Address. 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/json

• Request body:

  {
     "Object Id":"89-ZCBD",
     "Address Id": "89-ZCBY",
     "Street Address":"Street address sample1",
     "State":"CA",
     "City":"SM"
  }

• Response body:

  {
      "Error Code": "",
      "Address Id": "89-ZCBY",
      "Street Address": "Street address sample1",
      "Siebel Operation Object Id": "89-ZCBY",
      "Process Instance Id": "88-2ZO387",
      "Object Id": "89-ZCBD",
      "Error Message": "",
      "Street Address 2": "",
      "City": "SM",
      "State": "CA",
      "Country": "",
      "Postal Code": ""
  }