Terminate Asset
post
/rest/v16/assets/{id}/actions/terminate
This operation merges a termination request with the projected asset for the requested date, and then stores the results to a Configuration BOM Instance. For termination requests, the root item action code is set to Terminate and subordinate asset action codes are set to Delete.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Primary Key of Asset Resource.
Root Schema : assets-terminateRequest
Type:
Show Source
object
-
sourceIdentifier:
string
Title:
Source Identifier
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). When the Transaction ID is not provided, a new Transaction is created and associated with the requested operation.
Response
Supported Media Types
- application/json
Default Response
Root Schema : assets-terminateResponse
Type:
Show Source
object
-
result:
object ABO Headless Service Response.
Title:
ABO Headless Service Response.
Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume). -
resultTransactionId:
integer
Title:
Result Transaction Id
The commerce transaction Id. If the transaction Id is not provided, a new transaction is created.
Nested Schema : ABO Headless Service Response.
Type:
object
Title:
ABO Headless Service Response.
Response Schema for ABO related actions which are used to create transaction lines without launching the Configuration UI (e.g. terminate, suspend, resume).
Show Source
-
bomkey:
string
Title:
BOM Key
The BOM instance ID, also is asset-key for the newly created order line. -
lineId:
string
Title:
Line Id
The transaction line identifier for the created line. For an internal CPQ Commerce process, it is the ine number. For an external commerce application, it is the config_id which can be used to construct the endpoint to access specific configuration instance.