REST API Services for CPQ Cloud

Modify an Asset

post

/rest/v7/assets/{id}/actions/modify

This operation calculates the projected state of the asset for the requested date and returns a configuration URL that can be used to launch the model configurator page reflecting the projected state.

Request

Path Parameters

id: integer

Primary Key of Asset Resource.

Root Schema : Service-request

Type: object

Show Source

sourceIdentifier(optional): string

Title: Source Identifier

The variable name of the commerce process or external application identifier.
transactionDate(optional): string

Title: Transaction Date

The date and time on which the service request was made.
transactionId(optional): string

Title: Transaction Id

The current transaction identifier.

{
    "type":"object",
    "properties":{
        "transactionId":{
            "type":"string",
            "description":"The current transaction identifier.",
            "title":"Transaction Id"
        },
        "sourceIdentifier":{
            "type":"string",
            "description":"The variable name of the commerce process or external application identifier.",
            "title":"Source Identifier"
        },
        "transactionDate":{
            "type":"string",
            "description":"The date and time on which the service request was made.",
            "title":"Transaction Date"
        }
    }
}

Response

Default Response

Root Schema : InteractiveService-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.
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.
product_line(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":{
        "configContextKey":{
            "type":"string",
            "description":"Context key passed to configurator session to retrieve BOM instance being calculated by ABO process."
        },
        "product_line":{
            "type":"string",
            "description":"Product line variable name for the model to launch configurator ui."
        },
        "model":{
            "type":"string",
            "description":"Model variable name for the model to launch configurator ui."
        },
        "segment":{
            "type":"string",
            "description":"Segment variable name for the model to launch configurator ui."
        },
        "bomkey":{
            "type":"string",
            "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."
        },
        "configuratorURL":{
            "type":"string",
            "description":"URL to launch configurator with the BOM instance calculated by ABO process."
        }
    }
}