Workflow APIs

Siebel Open Integration can expose Siebel Workflows as REST API. Users can run the workflows by giving workflow name in the URL and parameters in the body of http POST request.

Users can invoke all active, completed workflows, that are not of type interactive flow and long running flow as Siebel REST API.

Workflow execution as REST API is access-controlled. To provide access, please see Configuring Siebel Workflows

Configuring Workflow APIs

Example configuration in config.json below shows multiple Workflows

"apigen": {
    "resources": {
      "openintegration/v1.0/workflow": [
        "EAISiebDemo",
        "ISS Promotion WS - ApplyProductPromotion - Order"
      ]      
   }
}

Examples

1. To run EAISiebDemo Workflow
   1. POST URL : https://<hostname>:<port>/<context>/openintegration/v1.0/workflow/EAISiebDemo
   2. Request Body

      {
          "SiebelMessage": {
              "MessageId": "",
              "MessageType": "Integration Object",
              "IntObjectName": "EAI Account",
              "IntObjectFormat": "Siebel Hierarchical",
              "ListOfEAI Account": {
                  "Account": [
                      {
                          "Name": "TestPA",
                          "Location": "HQ-Distribution"
                      }
                  ]
              }
          }
      }

   3. Response Body

      {
          "Error Code": "",
          "Error Message": "",
          "InOut1": "",
          "Object Id": "",
          "Process Instance Id": "88-3A61U9",
          "Siebel Operation Object Id": "",
          "SiebelMessage": {
              "MessageId": "88-9VY99",
              "MessageType": "Integration Object",
              "IntObjectName": "EAI Account",
              "IntObjectFormat": "Siebel Hierarchical",
              "ListOfEAI Account": {
                  "Account": [
                      {
                          "Account Status": "Active",
                          "Alias": "",
                          "CSN": "88-39R63B",
                          "Competitor": "N",
                          "Currency Code": "USD",
                          "DUNS Number": "",
                          "Description": "",
                          "Division": "",
                          "EAI Sync Date": "",
                          "EAI Sync Error Text": "",
                          "EAI Sync Status Code": "",
                          "Freight Terms": "",
                          "Freight Terms Info": "",
                          "GSA Flag": "",
                          "Home Page": "",
                          "Integration Id": "",
                          "Language Code": "ENU",
                          "Last Manager Review Date": "",
                          "Location": "HQ-Distribution",
                          "Main Fax Number": "",
                          "Main Phone Number": "",
                          "Managers Review": "",
                          "Name": "TestPA",
                          "Partner Flag": "N",
                          "Price List": "",
                          "Price List Id": "",
                          "Price List Integration Id": "",
                          "Prospect Flag": "N",
                          "Region": "",
                          "Type": "Customer",
                          "ListOfContact": {
                              "Contact": [
                                  {
                                      "Active Status": "Y",
                                      "Assistant Phone #": "",
                                      "Cellular Phone #": "",
                                      "Email Address": "",
                                      "Fax Phone #": "",
                                      "First Name": "HIMANSHU",
                                      "Home Phone #": "",
                                      "Integration Id": "",
                                      "Job Title": "",
                                      "Last Name": "AGRAWAL",
                                      "M/F": "",
                                      "M/M": "",
                                      "Middle Name": "",
                                      "Preferred Communications": "",
                                      "Preferred Language Code": "",
                                      "Work Phone #": "",
                                      "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": ""
                                  }
                              ]
                          }
                      }
                  ]
              }
          }
      }