1. REST API Guide
  2. Configuration Runtime APIs

Configuration Runtime APIs

These APIs manage configuration instances throughout their lifecycle, from initialization through updates and final persistence. Except the Integration Object for the ‘Instance’ in the request and response, these APIs share the same request and response.

ShoppingCartConfiguratorService

This service manages product configurations within the context of shopping cart or quotes line items. It provides operations for loading, updating, and saving configuration instances.

HTTP Method: POST

URI:

https://<server>:<port>/siebel/v1.0/service/ShoppingCartConfiguratorService/Execute

ProductOrderConfiguratorService

This service manages product configurations within the context of orders. It provides similar operations to ShoppingCartConfiguratorService but operates on order line items rather than quote line items.

HTTP Method: POST

URI:

https://<server>:<port>/siebel/v1.0/service/ProductOrderConfiguratorService/Execute

Request Message: ShoppingCartConfiguratorService, ProductOrderConfiguratorService

For a description of this request message, see the following table:

Node, values, and description table

Node Values Description
HeaderId Header Row Id

Row_id of the Quote/Order.
RootId Root Row Id

Row_id of the Root Quote/Order Line Item.
ProductId Product Row Id Whether to return full instance.
SkipCfgEligibilityCheck

Y: Yes

N: No		 Y: Skips Eligibility Check
InitInstanceOperation

LOAD, SET

DEFAULT, ADD
Required Begin configuration from
  • LOAD - Existing instance from DB.
  • SET – Given Instance from input.
  • ADD - Create New Instance.
  • DEFAULT – Use Existing Quote/Order to create new line items.
ReturnFullInstance Y / N Whether to return full instance.
SkipLoadingDefaultInstance Y / N For LOAD operation, should be set to N.
FinishConfigurationInFlag Y / N Y: Finish Configuration;N: Will keep Has Generics
SaveInstanceFlag Y / N Y: write the instance to the database;N: do not save instanceUseful for headless configuration.
Instance PDS Quote or PDS Order IO Integration Object for the instance.
InteractRequest CfgInteractRequest IO Integration object for Requests ex/AddItem, DeleteItem, SetAttribute, etc.
GetProductDataRequest CfgInteractData IO Query by template for run-time product data. 
Response Message: ShoppingCartConfiguratorService, ProductOrderConfiguratorService

For a description of this request message, see the following table:

Table with node, values, and description.

Node Values Description
Instance PDS Quote or PDS Order IO Integration Object for the instance.
Status CfgInteractStatus IO Integration object for overall status including messages for conflicts, E&C, and display messages.
GetProductDataResponse CfgInteractData IO Content for query by template for run-time product data.