Follow-On Order
post
/rest/v19/configBomInstance/{configId}/actions/followOnOrder
This operation is used to make changes to an existing order that has not yet been fulfilled. When a follow-on order is created, the projected state of an existing unfulfilled order is calculated and a new configuration URL is returned. The configuration URL can be used to launch the model configurator page, which will reflect the user intended net changes to the subscription.
Request
Supported Media Types
- application/json
Path Parameters
-
configId(required): integer
The configuration identifier used to uniquely identify the Configuration BOM instance.
Root Schema : configBomInstance-followOnOrderRequest
Type:
Show Source
object
-
sourceIdentifier:
string
Title:
Source Id
The variable name of the commerce process or external application identifier. '_external_order' is the default value for external orders when this parameter is not specified. The commerce process variable name 'processVarName' is used for internal orders (e.g. oraclecpqo). -
transactionDate:
string
Title:
Transaction Date
The date and time that the service request needs to be processed or fulfilled. -
transactionId:
string
Title:
Transaction Id
The commerce transaction Id associated with the asset(s).
Response
Supported Media Types
- application/json
Default Response
Root Schema : configBomInstance-followOnOrderResponse
Type:
Show Source
object
-
result:
object ABO Interactive Service Response.
Title:
ABO Interactive Service Response.
The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).
Nested Schema : ABO Interactive Service Response.
Type:
object
Title:
ABO Interactive Service Response.
The response schema for ABO related actions which are used to launch the Configuration UI (e.g. Modify, Reconfigure, Follow-On Order).
Show Source
-
bomkey:
string
The id of the BOM instance calculated by the ABO process. This is used to pass to the URL parameter to configuration, since configuration will only use the BOM if the BOM id inside matches the id passed in the BOM key.
-
configContextKey:
string
The context key passed to the configuration session to retrieve the BOM instance being calculated by the ABO process.
-
configuratorURL:
string
The URL to launch the Configuration UI with the BOM instance calculated by the ABO process.
-
model:
string
The model variable name for the model to launch the Configuration UI.
-
product_line:
string
The product line variable name for the model to launch the Configuration UI.
-
segment:
string
The segment variable name for the model to launch the Configuration UI.