1. Search Administration Guide
  2. Siebel OpenSearch APIs

Siebel OpenSearch APIs

Following table describes the Siebel OpenSearch APIs:

API Description Trigger via a Business Service in Siebel Trigger via Siebel REST API
URL Request Body Response
RegisterModel Register a machine learning (ML) model in Siebel Modern Search.

Trigger Business Service via Runtime Event :

This event is triggered when an OpenSearch Engine entry is created in Administration - Search > Search Engines with Engine set to 'Open Search' and Active Flag set to 'Y'.

 https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/RegisterModel {} (Empty Body) {"Status" : "Accepted"}
SearchPipeline Update a search pipeline with a weight factor.

Trigger Business Service via Runtime Event :

This event is triggered when adding a Driver Parameter in Administration - Search > Search Engines with the Name "Search Pipeline" and Default Value "True".

 https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/SearchPipeline {} (Empty Body) {"Status" : "Accepted"}
DeleteIndex Delete an index in Siebel Modern Search

Trigger Business Service via DeleteIndex Button:

The event is triggered upon clicking the DeleteIndex button in Administration - Search > Search Engines when the Category has already been indexed.

 https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/DeleteIndex

For Single Category :{ "body": { "CategoryName": "<categoryName>"}}

For all categories :{ "body": {"CategoryName": "All"}}

{"Response": "Ok"}
SearchConfiguration Reload modernsearchconfig.yaml Trigger via Siebel REST API Only https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/SearchConfiguration {} (Empty Body) {"Status": "Ok"}
SiebelSearch Perform a Search in Siebel Modern Search Trigger via Siebel REST API only https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/SiebelSearch 
{
    "body": {
        "SearchText": "<Search Keyword>",
        "CategoryName": "<CategoryName>", 
        "To": <Starting Index>,  // optional
        "From": <Ending Index>, // optional
        "VisibilityField" : "<VisibilityField>", //optional
        "VisibilityValue" : "<VisibilityValue>"  //optional
    }
}



For Multiple Categories

<CategoryName> : "CategoryName1,CategoryName2"

For All Categories :

<CategoryName> : "All"

N/A
Deploy Model Deploy or Redeploy a machine learning (ML) model in Siebel Modern Search.

Trigger Business Service via Runtime Event :

This event is triggered when adding a Driver Parameter inAdministration - Search > Search Engines with the Name "Deploy Model" and Default Value "True".

 https://<hostname>:<port>/siebel/v1.0/service/SiebelModernSearchJBS/DeployModel

Request Body Type 1 :

{} (Empty Body)

Request Body Type 2:

{ "body": { "ModelId": "<ModelId>"}}

{"Status" : "Accepted"}
Index Perform a create schema and Index by REST API. N/A https://<hostname>:<port>/siebel/v1.0/service/Open Search Adapter Service/Index

Non-Attachment Category:

{
  "body":
  {
    "CategoryName":<CategoryName>
   }
}

Attachment Category :

{
  "body":
  {
    "CategoryName":<CategoryName>

      "IndexFile": "Y"

    }
}
{ "Status": "Ok", "reqId": "Batch-id"}