REST API for Oracle Commerce Cloud December 2017

assetActions

post

/ccadmin/v1/webhook/assetActions

The WebHook that is triggered to perform actions on assets.

Supported Media Types

Body Parameter

Perform an action on an asset.

Root Schema : service_actions_request

Type: object

Perform an action on an asset.

op: Type: string

A string identifying the type of operation. This can be MODIFY, RENEW, TERMINATE etc.
recordId: Type: string

An ID representing the asset that will have an action performed on it.
sourceIdentifier: Type: string

The external application identifier.
transactionDate: Type: string

The date on which the service action should take effect.
transactionId: Type: string

The current transaction identifier.

Supported Media Types

200 Response

Returns the action details associated with this asset action.

Body

Root Schema : service_actions_response

Type: object

bomKey: Type: string

The instance id for the BOM instance calculated by ABO process. This is needed to pass to configurator as URL parameter, as configurator will only use the BOM if the BOM instance ID inside match the passed in BOM key.
configContextKey: Type: string

Context key passed to configurator session to retrieve BOM instance being calculated by ABO process.
configuratorItem: Type: object item

Additional Properties Allowed:

The BOM that contains details about the asset action.
configuratorUrl: Type: string

URL to launch configurator with the BOM instance calculated by ABO process.
model: Type: string

Model variable name for the model to launch configurator UI.
productLine: Type: string

Product line variable name for the model to launch configurator UI.
segment: Type: string

Segment variable name for the model to launch configurator UI.

Nested Schema : item

Type: object

The BOM that contains details about the asset action.

actionCode: Type: string

Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.
activationDate: Type: string

Date on which the service contract starts.
amount: Type: string

The total amount of the item.
assetId: Type: string

The id of the account asset.
catalogRefId: Type: string

Part number of the BOM item.
childItems: Type: array childItems

Additional Properties Allowed:
configuratorId: Type: integer

Configuration identifier used to uniquely identify the configuration bom instance.
deactivationDate: Type: string

Date on which the service contract ends.
externalData: Type: object externalData

Additional Properties Allowed:
externalPrice: Type: string

Override net unit price populated by ABO process.
externalRecurringCharge: Type: string

The items recurring charge.
externalRecurringChargeFrequency: Type: string

The frequency of the recurring charges, E.g Per Month.
externalRecurringDuration: Type: string

The duration of the recurring charges, E.g 1 Year.
parentServiceId: Type: string

Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.
quantity: Type: integer

Requested quantity of current line. It can have fractional value.
serviceId: Type: string

Unique instance identifier for BOM item.

Nested Schema : childItems

Type: array

Type: object child

Additional Properties Allowed:

The BOM that contains details about the asset action.

Nested Schema : externalData

Type: object

Nested Schema : child

Type: object

The BOM that contains details about the asset action.

actionCode: Type: string

Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.
activationDate: Type: string

Date on which the service contract starts.
amount: Type: string

The total amount of the item.
assetId: Type: string

The id of the account asset.
catalogRefId: Type: string

Part number of the BOM item.
deactivationDate: Type: string

Date on which the service contract ends.
externalData: Type: object externalData

Additional Properties Allowed:
externalPrice: Type: string

Override net unit price populated by ABO process.
externalRecurringCharge: Type: string

The items recurring charge.
externalRecurringChargeFrequency: Type: string

The frequency of the recurring charges, E.g Per Month.
externalRecurringDuration: Type: string

The duration of the recurring charges, E.g 1 Year.
parentServiceId: Type: string

Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.
quantity: Type: integer

Requested quantity of current line. It can have fractional value.
serviceId: Type: string

Unique instance identifier for BOM item.

Nested Schema : externalData

Type: object