REST API Services for Oracle CPQ

Get All BOM Mapping Rules

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/bomMappingRules

Use this endpoint to retrieve a list of BOM Mapping Rules for the specified Model.

Request

Supported Media Types

application/json

Path Parameters

allProdFamsVarName(required): string

Variable Name of All Product Families '_allProductFamilies'
modelVarName(required): string

Variable Name of the Model.
prodFamVarName(required): string

Variable Name of the Product Family.
prodLineVarName(required): string

Variable Name of the Product Line

Query Parameters

expand: string

Allows expansion of relationships.
fields: string

Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
limit: integer

The requested page size, which limits the number of elements the collection should max return.
offset: integer

The offset of the page. By default, offset is 0, which means first page will be returned.
orderby: string

Specifies a comma-separated list of pairs to order the response by.
q: string

Allows to specify one or more filtering criteria. By default, no filtering is applied.
totalResults: boolean

Specifies that the total count of records should be included in the response when doing pagination.

Response

Supported Media Types

application/json

Default Response

Root Schema : configBomMappingRuleSetups-collection

Type: object

Show Source

count: integer

The number of resource instances returned in the current range.
hasMore: boolean

Returns true if more resources are available on the server than the subset returned in current page.
items: array items
limit: integer

The actual paging size used by the server.
offset: integer

The offset used in the current page.
totalResults: integer

Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/configBomMappingRuleSetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Bom Mapping Rule

Title: Bom Mapping Rule

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

Nested Schema : Bom Mapping Rule

Type: object

Title: Bom Mapping Rule

Show Source

actionType: object Action Type

Title: Action Type

Action Type of The Rule
bomVariableName: string

Title: BOM Variable Name

Variable Name of the target BOM
conditionExpression: string

Title: Condition Expression

Condition Expression of Rule
conditionType: object Condition Type

Title: Condition Type

Condition Type of Rule
dateAdded: string

Title: Date Added

System field indicating the date on which the Resource was created.
dateModified: string

Title: Date Modified

System field indicating the date on which the Resource was last modified.
description: string

Title: Description

Description of the Bom Mapping Rule
detailType: object Detail Type

Title: Detail Type

Detail Type of Rule
endDate: string

Title: End Date

End Date
id: integer

Title: Id

Primary Key Of The Resource
label: string

Title: Bom Mapping Rule Name

Name of the Bom Mapping Rule
orderNumber: integer

Title: Order Number

Order Number of the Bom Mapping Rule
processVariableName: string

Title: Process Variable Name

Variable Name of the Process
refType: object Reference Type

Title: Reference Type

Type of the Reference
ruleType: object Rule Type

Title: Rule Type

Type of the Rule
startDate: string

Title: Start Date

Start Date
status: object Rule Status

Title: Rule Status

Status of Rule
variableName: string

Title: Variable Name

Variable Name of the Bom Mapping Rule

{
    "type":"object",
    "properties":{
        "actionType":{
            "type":"object",
            "description":"Action Type of The Rule",
            "title":"Action Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "bomVariableName":{
            "type":"string",
            "description":"Variable Name of the target BOM",
            "title":"BOM Variable Name"
        },
        "conditionExpression":{
            "type":"string",
            "description":"Condition Expression of Rule",
            "title":"Condition Expression"
        },
        "conditionType":{
            "type":"object",
            "description":"Condition Type of Rule",
            "title":"Condition Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Description of the Bom Mapping Rule",
            "title":"Description"
        },
        "detailType":{
            "type":"object",
            "description":"Detail Type of Rule",
            "title":"Detail Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "endDate":{
            "type":"string",
            "description":"End Date",
            "title":"End Date"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Bom Mapping Rule",
            "title":"Bom Mapping Rule Name"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number of the Bom Mapping Rule",
            "title":"Order Number"
        },
        "processVariableName":{
            "type":"string",
            "description":"Variable Name of the Process",
            "title":"Process Variable Name"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "ruleType":{
            "type":"object",
            "description":"Type of the Rule",
            "title":"Rule Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "startDate":{
            "type":"string",
            "description":"Start Date",
            "title":"Start Date"
        },
        "status":{
            "type":"object",
            "description":"Status of Rule",
            "title":"Rule Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Bom Mapping Rule",
            "title":"Variable Name"
        }
    },
    "title":"Bom Mapping Rule"
}

Nested Schema : Action Type

Type: object

Title: Action Type

Action Type of The Rule

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Action Type of The Rule",
    "title":"Action Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Condition Type

Type: object

Title: Condition Type

Condition Type of Rule

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Condition Type of Rule",
    "title":"Condition Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Detail Type

Type: object

Title: Detail Type

Detail Type of Rule

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Detail Type of Rule",
    "title":"Detail Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Reference Type

Type: object

Title: Reference Type

Type of the Reference

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Rule Type

Type: object

Title: Rule Type

Type of the Rule

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Type of the Rule",
    "title":"Rule Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Rule Status

Type: object

Title: Rule Status

Status of Rule

Show Source

displayValue: string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
id: integer

Title: Id

Primary Key of the fixed list of value resource.
lookupCode: string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "type":"object",
    "description":"Status of Rule",
    "title":"Rule Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Examples

The following example shows how to retrieve a list of BOM Mapping Rules for the specified Model by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines/tablets/models/customTablet/bomMappingRules

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines/tablets/models/customTablet/bomMappingRules"
    }
  ],
  "items": [{
      "orderNumber": 1,
      "bomVariableName": "varioTablet",
      "endDate": null,
      "refType": {
        "lookupCode": "4",
        "displayValue": "Model",
        "id": 38731888,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_REF_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/38731888"
          }
        ]
      },
      "description": null,
      "dateAdded": "2017-11-13T13:30:01.000Z",
      "detailType": {
        "lookupCode": "3",
        "displayValue": "Table Based",
        "id": 38731882,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_DETAIL_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/38731882"
          }
        ]
      },
      "ruleType": {
        "lookupCode": "23",
        "displayValue": "Bom Mapping Rule",
        "id": 38731896,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com//rest/v19/lookupValues/38731896"
          }
        ]
      },
      "processVariableName": "oraclecpqo",
      "id": 36594469,
      "conditionExpression": null,
      "variableName": "defaultBOMMappingRule",
      "dateModified": "2019-10-04T12:39:45.000Z",
      "label": "Default BOM Mapping Rule",
      "actionType": {
        "lookupCode": "1",
        "displayValue": "Standard",
        "id": 38731870,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_ACTION_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/38731870"
          }
        ]
      },
      "conditionType": {
        "lookupCode": "3",
        "displayValue": "Always True",
        "id": 38731877,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_CONDITION_TYPE%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/38731877"
          }
        ]
      },
      "startDate": null,
      "status": {
        "lookupCode": "1",
        "displayValue": "Active",
        "id": 38731891,
        "links": [{
            "rel": "domain",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_RULE_STATUS%22%7D%7D"
          }, {
            "rel": "canonical",
            "href": "https://sitename.oracle.com/rest/v19/lookupValues/38731891"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines/tablets/models/customTablet/bomMappingRules/36594469"
        }, {
          "kind": "",
          "rel": "child",
          "name": "conditions",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines/tablets/models/customTablet/bomMappingRules/36594469/conditions"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines/tablets/models/customTablet"
        }
      ]
    }
  ]
}