Jump to

• Request
• Response

assetActions

post

/ccadmin/v1/webhook/assetActions

The WebHook that is triggered to perform actions on assets.

Request

Supported Media Types

• application/json

Body ()

Perform an action on an asset.

Root Schema : service_actions_request

Type: object

Perform an action on an asset.

Show Source

• op(optional): string
  A string identifying the type of operation. This can be MODIFY, RENEW, TERMINATE etc.
• recordId(optional): string
  An ID representing the asset that will have an action performed on it.
• sourceIdentifier(optional): string
  The external application identifier.
• transactionDate(optional): string
  The date on which the service action should take effect.
• transactionId(optional): string
  The current transaction identifier.

{
    "description":"Perform an action on an asset.",
    "type":"object",
    "properties":{
        "recordId":{
            "description":"An ID representing the asset that will have an action performed on it.",
            "type":"string"
        },
        "op":{
            "description":"A string identifying the type of operation. This can be MODIFY, RENEW, TERMINATE etc.",
            "type":"string"
        },
        "sourceIdentifier":{
            "description":"The external application identifier.",
            "type":"string"
        },
        "transactionDate":{
            "description":"The date on which the service action should take effect.",
            "type":"string"
        },
        "transactionId":{
            "description":"The current transaction identifier.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the action details associated with this asset action.

Body ()

Root Schema : service_actions_response

Type: object

Show Source

• bomKey(optional): 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(optional): string
  Context key passed to configurator session to retrieve BOM instance being calculated by ABO process.
• configuratorItem(optional): object item
  The BOM that contains details about the asset action.
• configuratorUrl(optional): string
  URL to launch configurator with the BOM instance calculated by ABO process.
• model(optional): string
  Model variable name for the model to launch configurator UI.
• productLine(optional): string
  Product line variable name for the model to launch configurator UI.
• segment(optional): string
  Segment variable name for the model to launch configurator UI.

{
    "type":"object",
    "properties":{
        "productLine":{
            "description":"Product line variable name for the model to launch configurator UI.",
            "type":"string"
        },
        "configContextKey":{
            "description":"Context key passed to configurator session to retrieve BOM instance being calculated by ABO process.",
            "type":"string"
        },
        "configuratorUrl":{
            "description":"URL to launch configurator with the BOM instance calculated by ABO process.",
            "type":"string"
        },
        "bomKey":{
            "description":"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.",
            "type":"string"
        },
        "segment":{
            "description":"Segment variable name for the model to launch configurator UI.",
            "type":"string"
        },
        "configuratorItem":{
            "$ref":"#/definitions/item"
        },
        "model":{
            "description":"Model variable name for the model to launch configurator UI.",
            "type":"string"
        }
    }
}

Nested Schema : item

Type: object

The BOM that contains details about the asset action.

Show Source

• actionCode(optional): string
  Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.
• activationDate(optional): string
  Date on which the service contract starts.
• amount(optional): string
  The total amount of the item.
• assetId(optional): string
  The id of the account asset.
• billingAccountId(optional): string
  Identifier of billing account.
• catalogRefId(optional): string
  Part number of the BOM item.
• childItems(optional): array childItems
• configuratorId(optional): integer
  Configuration identifier used to uniquely identify the configuration bom instance.
• deactivationDate(optional): string
  Date on which the service contract ends.
• externalData(optional): object externalData
• externalPrice(optional): string
  Override net unit price populated by ABO process.
• externalRecurringCharge(optional): string
  The items recurring charge.
• externalRecurringChargeDuration(optional): string
  The duration of the recurring charges, E.g 1 Year.
• externalRecurringChargeFrequency(optional): string
  The frequency of the recurring charges, E.g Per Month.
• parentServiceId(optional): string
  Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.
• quantity(optional): integer
  Requested quantity of current line. It can have fractional value.
• serviceAccountId(optional): string
  Identifier of service account.
• serviceId(optional): string
  Unique instance identifier for BOM item.
• transactionDate(optional): string
  Date on which the service action should be triggered.

{
    "description":"The BOM that contains details about the asset action.",
    "type":"object",
    "properties":{
        "serviceAccountId":{
            "description":"Identifier of service account.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"Date on which the service contract ends.",
            "type":"string"
        },
        "amount":{
            "description":"The total amount of the item.",
            "type":"string"
        },
        "quantity":{
            "description":"Requested quantity of current line. It can have fractional value.",
            "type":"integer"
        },
        "parentServiceId":{
            "description":"Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.",
            "type":"string"
        },
        "externalRecurringCharge":{
            "description":"The items recurring charge.",
            "type":"string"
        },
        "externalData":{
            "type":"object"
        },
        "billingAccountId":{
            "description":"Identifier of billing account.",
            "type":"string"
        },
        "externalRecurringChargeFrequency":{
            "description":"The frequency of the recurring charges, E.g Per Month.",
            "type":"string"
        },
        "childItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/child"
            }
        },
        "transactionDate":{
            "description":"Date on which the service action should be triggered.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"Part number of the BOM item.",
            "type":"string"
        },
        "configuratorId":{
            "description":"Configuration identifier used to uniquely identify the configuration bom instance.",
            "type":"integer"
        },
        "externalRecurringChargeDuration":{
            "description":"The duration of the recurring charges, E.g 1 Year.",
            "type":"string"
        },
        "externalPrice":{
            "description":"Override net unit price populated by ABO process.",
            "type":"string"
        },
        "assetId":{
            "description":"The id of the account asset.",
            "type":"string"
        },
        "actionCode":{
            "description":"Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.",
            "type":"string"
        },
        "serviceId":{
            "description":"Unique instance identifier for BOM item.",
            "type":"string"
        },
        "activationDate":{
            "description":"Date on which the service contract starts.",
            "type":"string"
        }
    }
}

Nested Schema : childItems

Type: array

Show Source

• Array of: object child
  The BOM that contains details about the asset action.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/child"
    }
}

Nested Schema : externalData

Type: object

Nested Schema : child

Type: object

The BOM that contains details about the asset action.

Show Source

• actionCode(optional): string
  Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.
• activationDate(optional): string
  Date on which the service contract starts.
• amount(optional): string
  The total amount of the item.
• assetId(optional): string
  The id of the account asset.
• billingAccountId(optional): string
  Identifier of billing account.
• catalogRefId(optional): string
  Part number of the BOM item.
• childItems(optional): array childItems
• deactivationDate(optional): string
  Date on which the service contract ends.
• externalData(optional): object externalData
• externalPrice(optional): string
  Override net unit price populated by ABO process.
• externalRecurringCharge(optional): string
  The items recurring charge.
• externalRecurringChargeDuration(optional): string
  The duration of the recurring charges, E.g 1 Year.
• externalRecurringChargeFrequency(optional): string
  The frequency of the recurring charges, E.g Per Month.
• parentServiceId(optional): string
  Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.
• quantity(optional): integer
  Requested quantity of current line. It can have fractional value.
• serviceAccountId(optional): string
  Identifier of service account.
• serviceId(optional): string
  Unique instance identifier for BOM item.
• transactionDate(optional): string
  Date on which the service action should be triggered.

{
    "description":"The BOM that contains details about the asset action.",
    "type":"object",
    "properties":{
        "serviceAccountId":{
            "description":"Identifier of service account.",
            "type":"string"
        },
        "deactivationDate":{
            "description":"Date on which the service contract ends.",
            "type":"string"
        },
        "amount":{
            "description":"The total amount of the item.",
            "type":"string"
        },
        "quantity":{
            "description":"Requested quantity of current line. It can have fractional value.",
            "type":"integer"
        },
        "parentServiceId":{
            "description":"Identifier of parent BOM item. Root BOM item will have an empty parentServiceId.",
            "type":"string"
        },
        "externalRecurringCharge":{
            "description":"The items recurring charge.",
            "type":"string"
        },
        "externalData":{
            "type":"object"
        },
        "billingAccountId":{
            "description":"Identifier of billing account.",
            "type":"string"
        },
        "externalRecurringChargeFrequency":{
            "description":"The frequency of the recurring charges, E.g Per Month.",
            "type":"string"
        },
        "childItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/child"
            }
        },
        "transactionDate":{
            "description":"Date on which the service action should be triggered.",
            "type":"string"
        },
        "catalogRefId":{
            "description":"Part number of the BOM item.",
            "type":"string"
        },
        "externalRecurringChargeDuration":{
            "description":"The duration of the recurring charges, E.g 1 Year.",
            "type":"string"
        },
        "externalPrice":{
            "description":"Override net unit price populated by ABO process.",
            "type":"string"
        },
        "assetId":{
            "description":"The id of the account asset.",
            "type":"string"
        },
        "actionCode":{
            "description":"Action code for the current transaction line. Values include Add, Update, Terminate, Renew, Suspend etc.",
            "type":"string"
        },
        "serviceId":{
            "description":"Unique instance identifier for BOM item.",
            "type":"string"
        },
        "activationDate":{
            "description":"Date on which the service contract starts.",
            "type":"string"
        }
    }
}

Nested Schema : childItems

Type: array

Show Source

• Array of: object child
  The BOM that contains details about the asset action.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/child"
    }
}

Nested Schema : externalData

Type: object

Back to Top