Jump to

• Request
• Response

Update Configuration

post

/rest/v16/assets/actions/updateConfiguration

This operation gathers a projection of all involved configuration attributes from open order lines related to an asset and updates the internal configuration on the root asset.

Request

Supported Media Types

• application/json

Body ()

Root Schema : assets-updateConfigurationCollectionRequest

Type: object

Show Source

• assetList: array Asset Order List
  Title: Asset Order List

  Contains a list of asset key and order lines.

{
    "type":"object",
    "properties":{
        "assetList":{
            "$ref":"#/definitions/assetOrderListDef"
        }
    }
}

Nested Schema : Asset Order List

Type: array

Title: Asset Order List

Contains a list of asset key and order lines.

Show Source

• Array of: object Asset order definition
  Title: Asset order definition

  Captures asset key and order lines.

{
    "title":"Asset Order List",
    "type":"array",
    "description":"Contains a list of asset key and order lines.",
    "items":{
        "$ref":"#/definitions/assetOrderDef"
    }
}

Nested Schema : Asset order definition

Type: object

Title: Asset order definition

Captures asset key and order lines.

Show Source

• assetKey: string
  Asset key value
• orderLines: array orderLines

{
    "type":"object",
    "properties":{
        "assetKey":{
            "type":"string",
            "description":"Asset key value"
        },
        "orderLines":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/orderLineDef"
            }
        }
    },
    "title":"Asset order definition",
    "description":"Captures asset key and order lines."
}

Nested Schema : orderLines

Type: array

Show Source

• Array of: object Order line
  Title: Order line

  Root line item from open orders.

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

Nested Schema : Order line

Type: object

Title: Order line

Root line item from open orders.

Show Source

• _document_number: integer
  Title: Document Number

  Unique document number for this sub-document to be used as document identifier in a commerce process.
• bs_id: integer
  Title: Transaction Internal ID

  Current Unique Buy-side ID. This is the internal identifier for a transaction within a CPQ site.
• configId: integer
  Configuration Identifier used to uniquely identify the configuration BOM instance.
• type: string
  Order type identifier - internalOrder or externalOrder. For internal orders, supply the _bs_id and _document_number(s), for external orders, supply the configId.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Order type identifier - internalOrder or externalOrder. For internal orders, supply the _bs_id and _document_number(s), for external orders, supply the configId."
        },
        "bs_id":{
            "title":"Transaction Internal ID",
            "description":"Current Unique Buy-side ID.  This is the internal identifier for a transaction within a CPQ site.",
            "type":"integer"
        },
        "_document_number":{
            "title":"Document Number",
            "description":"Unique document number for this sub-document to be used as document identifier in a commerce process.",
            "type":"integer"
        },
        "configId":{
            "description":"Configuration Identifier used to uniquely identify the configuration BOM instance.",
            "type":"integer"
        }
    },
    "title":"Order line",
    "description":"Root line item from open orders."
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Back to Top