REST API Services for CPQ Cloud

Get Configuration BOM Instance

post

/rest/v7/configBomInstance/{configId}/actions/getConfigBom

This operation will use one of the lineId or config_id to retrieve a saved Configuration BOM Instance. The lineId is returned from a Terminate, Suspend, Resume, or Renew service. The config_id is returned by client side JSON object for client integration case. NOTE: Get Configuration Instance is only available for external integrations.

Request

Path Parameters

configId: integer

Configuration Identifier used to uniquely identify the configuration bom instance.

Root Schema : ConfigurationBOM-request

Type: object

Show Source

flattenHierarchy(optional): boolean

{
    "properties":{
        "flattenHierarchy":{
            "type":"boolean"
        }
    }
}

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."
        }
    }
}