Jump to

• Request
• Response

Get Configuration BOM Instance

post

/rest/v16/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

Supported Media Types

• application/json

Path Parameters

• configId(required): integer
  The configuration identifier used to uniquely identify the Configuration BOM instance.

Body ()

Root Schema : configBomInstance-getConfigBomRequest

Type: object

Show Source

• flattenHierarchy: boolean
  Title: Flatten BOM Hierarchy

  Determines how the BOM structure is returned. Set to 'true' to return a flattened BOM structure (default value). Set to 'false' to return a hierarchical BOM structure.

{
    "type":"object",
    "properties":{
        "flattenHierarchy":{
            "type":"boolean",
            "description":"Determines how the BOM structure is returned. Set to 'true' to return a flattened BOM structure (default value).  Set to 'false' to return a hierarchical BOM structure.",
            "title":"Flatten BOM Hierarchy"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : configBomInstance-getConfigBomResponse

Type: object

Show Source

• configBom: object ABO BOM
  Title: ABO BOM

  The BOM instance hierarchy returned by the configBomInstance endpoint to retrieve the BOM instance created by the ABO process. It only describes a two-level flattened hierarchy and fields populated by the out-of-box ABO process.

{
    "type":"object",
    "properties":{
        "configBom":{
            "$ref":"#/definitions/aboBom"
        }
    }
}

Nested Schema : ABO BOM

Type: object

Title: ABO BOM

The BOM instance hierarchy returned by the configBomInstance endpoint to retrieve the BOM instance created by the ABO process. It only describes a two-level flattened hierarchy and fields populated by the out-of-box ABO process.

Show Source

• asset_fields: object ABO BOM Asset Field Definitions
  Title: ABO BOM Asset Field Definitions

  List of additional Commerce attributes populated by the ABO process.
• attributes: object attributes
• children: array children
• custom_attributes: object ABO BOM Custom Attributes definitions
  Title: ABO BOM Custom Attributes definitions

  List of additional commerce attributes populated by the ABO process
• explodedQuantity: integer
  The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity.
• fields: object ABO BOM Field definitions
  Title: ABO BOM Field definitions

  List of additional Commerce attributes populated by the ABO process
• id: string
  The unique instance identifier for BOM item.
• isModel: integer
  Identifies if the current item is a model.
• parentId: string
  Identifier of parent BOM item, root BOM item will have empty parentId.
• partNumber: string
  Title: Part Number

  The The part number of the BOM item. .
• quantity: integer
  Requested quantity of current line, it can have fractional value.

{
    "type":"object",
    "properties":{
        "partNumber":{
            "title":"Part Number",
            "type":"string",
            "description":"The The part number of the BOM item. ."
        },
        "quantity":{
            "type":"integer",
            "description":"Requested quantity of current line, it can have fractional value."
        },
        "id":{
            "type":"string",
            "description":"The unique instance identifier for BOM item."
        },
        "parentId":{
            "type":"string",
            "description":"Identifier of parent BOM item, root BOM item will have empty parentId."
        },
        "fields":{
            "$ref":"#/definitions/aboBomFieldsDef"
        },
        "custom_attributes":{
            "$ref":"#/definitions/aboBomCustomAttributesDef"
        },
        "asset_fields":{
            "$ref":"#/definitions/aboBomAssetFieldsDef"
        },
        "explodedQuantity":{
            "type":"integer",
            "description":"The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity."
        },
        "attributes":{
            "type":"object"
        },
        "isModel":{
            "type":"integer",
            "description":"Identifies if the current item is a model."
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/aboBomDef"
            }
        }
    },
    "title":"ABO BOM",
    "description":"The BOM instance hierarchy returned by the configBomInstance endpoint to retrieve the BOM instance created by the ABO process. It only describes a two-level flattened hierarchy and fields populated by the out-of-box ABO process."
}

Nested Schema : ABO BOM Asset Field Definitions

Type: object

Title: ABO BOM Asset Field Definitions

List of additional Commerce attributes populated by the ABO process.

Show Source

• amount: object amount
  Amount of the asset associated to the Configuration BOM.
• billingAccount: object billingAccount
  Billing Account of the asset associated to the Configuration BOM.
• endDate: object endDate
  End Date of the asset associated to the Configuration BOM.
• id: object id
  Id of the asset associated to the Configuration BOM.
• serviceAccount: object serviceAccount
  Service Account of the asset associated to the Configuration BOM.
• startDate: object startDate
  Start Date of the asset associated to the Configuration BOM.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"object",
            "description":"Id of the asset associated to the Configuration BOM."
        },
        "startDate":{
            "type":"object",
            "description":"Start Date of the asset associated to the Configuration BOM."
        },
        "endDate":{
            "type":"object",
            "description":"End Date of the asset associated to the Configuration BOM."
        },
        "amount":{
            "type":"object",
            "description":"Amount of the asset associated to the Configuration BOM."
        },
        "billingAccount":{
            "type":"object",
            "description":"Billing Account of the asset associated to the Configuration BOM."
        },
        "serviceAccount":{
            "type":"object",
            "description":"Service Account of the asset associated to the Configuration BOM."
        }
    },
    "title":"ABO BOM Asset Field Definitions",
    "description":"List of additional Commerce attributes populated by the ABO process."
}

Nested Schema : attributes

Type: object

Nested Schema : children

Type: array

Show Source

• Array of: object BOM Item
  Title: BOM Item

  Structure of BOM Item Object

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

Nested Schema : ABO BOM Custom Attributes definitions

Type: object

Title: ABO BOM Custom Attributes definitions

List of additional commerce attributes populated by the ABO process

Show Source

• field1: object field1
  Custom Attribute for a Part
• field10: object field10
  Custom Attribute for a Part
• field11: object field11
  Custom Attribute for a Part
• field12: object field12
  Custom Attribute for a Part
• field13: object field13
  Custom Attribute for a Part
• field14: object field14
  Custom Attribute for a Part
• field15: object field15
  Custom Attribute for a Part
• field16: object field16
  Custom Attribute for a Part
• field17: object field17
  Custom Attribute for a Part
• field18: object field18
  Custom Attribute for a Part
• field19: object field19
  Custom Attribute for a Part
• field2: object field2
  Custom Attribute for a Part
• field20: object field20
  Custom Attribute for a Part
• field21: object field21
  Custom Attribute for a Part
• field22: object field22
  Custom Attribute for a Part
• field23: object field23
  Custom Attribute for a Part
• field24: object field24
  Custom Attribute for a Part
• field25: object field25
  Custom Attribute for a Part
• field26: object field26
  Custom Attribute for a Part
• field27: object field27
  Custom Attribute for a Part
• field28: object field28
  Custom Attribute for a Part
• field29: object field29
  Custom Attribute for a Part
• field3: object field3
  Custom Attribute for a Part
• field30: object field30
  Custom Attribute for a Part
• field4: object field4
  Custom Attribute for a Part
• field5: object field5
  Custom Attribute for a Part
• field6: object field6
  Custom Attribute for a Part
• field7: object field7
  Custom Attribute for a Part
• field8: object field8
  Custom Attribute for a Part
• field9: object field9
  Custom Attribute for a Part

{
    "type":"object",
    "properties":{
        "field1":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field2":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field3":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field4":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field5":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field6":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field7":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field8":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field9":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field10":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field11":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field12":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field13":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field14":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field15":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field16":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field17":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field18":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field19":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field20":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field21":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field22":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field23":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field24":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field25":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field26":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field27":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field28":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field29":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        },
        "field30":{
            "type":"object",
            "description":"Custom Attribute for a Part"
        }
    },
    "title":"ABO BOM Custom Attributes definitions",
    "description":"List of additional commerce attributes populated by the ABO process"
}

Nested Schema : ABO BOM Field definitions

Type: object

Title: ABO BOM Field definitions

List of additional Commerce attributes populated by the ABO process

Show Source

• _price_unit_price_each: string
  Title: Price Unit Price Each

  Override net unit price populated by the ABO process.
• fulfillmentStatus_l: string
  Title: Fultillment Status

  The fulfillment status identifies the current state of an order and the associated saved BOM instance. Possible values include: CREATED - Upon creating the configured BOM instance, the fulfillment status is set to CREATED and indicates the order has not been submitted for fulfillment; BEING_FULFILLED - Indicates the order was submitted to the fulfillment system and CPQ has not yet been notified of the order 's fulfillment; FULFILLED: Indicates the order is fulfilled and assets have been created in CPQ; and CLOSED - Indicates the order is closed or cancelled.
• itemInstanceId_l: string
  Title: Item Instance ID

  The display Id of the product instance.
• itemInstanceName_l: string
  Title: Item Instance Name

  The display name of the product instance.
• oRCL_ABO_ActionCode_l: string
  Title: Action Code

  The action code for the current transaction line, the possible values are Add, Update, Delete, Terminate, Suspend, etc.

{
    "type":"object",
    "properties":{
        "itemInstanceName_l":{
            "type":"string",
            "title":"Item Instance Name",
            "description":"The display name of the product instance."
        },
        "oRCL_ABO_ActionCode_l":{
            "type":"string",
            "title":"Action Code",
            "description":"The action code for the current transaction line, the possible values are Add, Update, Delete, Terminate, Suspend, etc."
        },
        "_price_unit_price_each":{
            "type":"string",
            "title":"Price Unit Price Each",
            "description":"Override net unit price populated by the ABO process."
        },
        "fulfillmentStatus_l":{
            "type":"string",
            "title":"Fultillment Status",
            "description":"The fulfillment status identifies the current state of an order and the associated saved BOM instance. Possible values include: CREATED - Upon creating the configured BOM instance, the fulfillment status is set to CREATED and indicates the order has not been submitted for fulfillment; BEING_FULFILLED - Indicates the order was submitted to the fulfillment system and CPQ has not yet been notified of the order 's fulfillment; FULFILLED: Indicates the order is fulfilled and assets have been created in CPQ; and CLOSED - Indicates the order is closed or cancelled."
        },
        "itemInstanceId_l":{
            "type":"string",
            "title":"Item Instance ID",
            "description":"The display Id of the product instance."
        }
    },
    "title":"ABO BOM Field definitions",
    "description":"List of additional Commerce attributes populated by the ABO process"
}

Nested Schema : amount

Type: object

Amount of the asset associated to the Configuration BOM.

Nested Schema : billingAccount

Type: object

Billing Account of the asset associated to the Configuration BOM.

Nested Schema : endDate

Type: object

End Date of the asset associated to the Configuration BOM.

Nested Schema : id

Type: object

Id of the asset associated to the Configuration BOM.

Nested Schema : serviceAccount

Type: object

Service Account of the asset associated to the Configuration BOM.

Nested Schema : startDate

Type: object

Start Date of the asset associated to the Configuration BOM.

Nested Schema : BOM Item

Type: object

Title: BOM Item

Structure of BOM Item Object

Show Source

• asset_fields: object ABO BOM Asset Field Definitions
  Title: ABO BOM Asset Field Definitions

  List of additional Commerce attributes populated by the ABO process.
• attributes: object attributes
• custom_attributes: object ABO BOM Custom Attributes definitions
  Title: ABO BOM Custom Attributes definitions

  List of additional commerce attributes populated by the ABO process
• explodedQuantity: integer
  The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity.
• fields: object ABO BOM Field definitions
  Title: ABO BOM Field definitions

  List of additional Commerce attributes populated by the ABO process
• id: string
  Unique instance identifier for the BOM item
• isModel: integer
  Identifies if the current item is a model.
• parentId: string
  Identifier of the parent BOM item, the root BOM item will have an empty parent Id.
• partNumber: string
  The part number of the BOM item.
• quantity: integer
  Requested quantity of the current line, it can have a fractional value

{
    "type":"object",
    "properties":{
        "partNumber":{
            "type":"string",
            "description":"The part number of the BOM item."
        },
        "quantity":{
            "type":"integer",
            "description":"Requested quantity of the current line, it can have a fractional value"
        },
        "id":{
            "type":"string",
            "description":"Unique instance identifier for the BOM item"
        },
        "parentId":{
            "type":"string",
            "description":"Identifier of the parent BOM item, the root BOM item will have an empty parent Id."
        },
        "fields":{
            "$ref":"#/definitions/aboBomFieldsDef"
        },
        "custom_attributes":{
            "$ref":"#/definitions/aboBomCustomAttributesDef"
        },
        "asset_fields":{
            "$ref":"#/definitions/aboBomAssetFieldsDef"
        },
        "explodedQuantity":{
            "type":"integer",
            "description":"The exploded quantity of current BOM item, which is the multiplication of the parent BOM item exploded quantiy and the current BOM item quantity."
        },
        "attributes":{
            "type":"object"
        },
        "isModel":{
            "type":"integer",
            "description":"Identifies if the current item is a model."
        }
    },
    "title":"BOM Item",
    "description":"Structure of BOM Item Object"
}

Nested Schema : attributes

Type: object

Nested Schema : field1

Type: object

Custom Attribute for a Part

Nested Schema : field10

Type: object

Custom Attribute for a Part

Nested Schema : field11

Type: object

Custom Attribute for a Part

Nested Schema : field12

Type: object

Custom Attribute for a Part

Nested Schema : field13

Type: object

Custom Attribute for a Part

Nested Schema : field14

Type: object

Custom Attribute for a Part

Nested Schema : field15

Type: object

Custom Attribute for a Part

Nested Schema : field16

Type: object

Custom Attribute for a Part

Nested Schema : field17

Type: object

Custom Attribute for a Part

Nested Schema : field18

Type: object

Custom Attribute for a Part

Nested Schema : field19

Type: object

Custom Attribute for a Part

Nested Schema : field2

Type: object

Custom Attribute for a Part

Nested Schema : field20

Type: object

Custom Attribute for a Part

Nested Schema : field21

Type: object

Custom Attribute for a Part

Nested Schema : field22

Type: object

Custom Attribute for a Part

Nested Schema : field23

Type: object

Custom Attribute for a Part

Nested Schema : field24

Type: object

Custom Attribute for a Part

Nested Schema : field25

Type: object

Custom Attribute for a Part

Nested Schema : field26

Type: object

Custom Attribute for a Part

Nested Schema : field27

Type: object

Custom Attribute for a Part

Nested Schema : field28

Type: object

Custom Attribute for a Part

Nested Schema : field29

Type: object

Custom Attribute for a Part

Nested Schema : field3

Type: object

Custom Attribute for a Part

Nested Schema : field30

Type: object

Custom Attribute for a Part

Nested Schema : field4

Type: object

Custom Attribute for a Part

Nested Schema : field5

Type: object

Custom Attribute for a Part

Nested Schema : field6

Type: object

Custom Attribute for a Part

Nested Schema : field7

Type: object

Custom Attribute for a Part

Nested Schema : field8

Type: object

Custom Attribute for a Part

Nested Schema : field9

Type: object

Custom Attribute for a Part

Back to Top