Overview
Oracle CPQ provides sales users with the flexibility of selecting columns, arranging columns, and applying filters in the Line Item Grid. They can also save Line Item Grid personalization, and then apply their saved Line Item Grid personalization to subsequent user sessions. The User Personalization REST APIs provide web services to support Line Item Grid user personalization.
Administration
Get All User Personalizations Get All User Personalizations |
|||
|---|---|---|---|
|
Description |
Use this endpoint to retrieve a list of user Line Item Grid personalizations for the current user. |
||
|
URI Endpoint |
/rest/v17/userPersonalizations |
||
|
Endpoint Parameters |
None |
||
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
|||
|
HTTP Method |
GET |
||
| Request Body Parameters | None | ||
| Response Body Parameters | A collection of user Line Item Grid personalizations. | ||
|
dateAdded |
The date the user personalization was created. | ||
|
dateModified |
The date the user personalization was last modified. | ||
|
entityType |
The functional area with CPQ. For example, COMMERCE. | ||
|
personalizationData |
An array of personalization data, containing the following items: | ||
|
componentName |
The name of the personalized component. |
||
|
modifiedDate |
The date the component properties were last modified. |
||
|
properties |
The properties personalized by the user. |
||
|
personalizationName |
The name of the user personalization. | ||
https://sitename.oracle.com/rest/v17/userPersonalizations
{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/userPersonalizations" } ], "items": [{ "personalizationName": "oraclecpqo-transaction-userState", "entityType": "COMMERCE", "dateModified": null, "personalizationData": [{ "componentName": "table-transactionLine", "properties": { "textWrapMode": "wrap", "hiddenColumns": ["_part_display_number", "oRCL_ABO_ActionCode_l"], "columnOrder": { "_chargeSetControl": 0, "_group_sequence_number": 1, "_part_number-_model_name": 2, "_part_display_number": 5, "listPrice_l": 6, "_price_quantity": 8, "customDiscountValue_l": 7, "customDiscountType_l": 9, "customDiscountAmount_l": 10, "netPrice_l": 11, "priceScore_l": 12, "netAmount_l": 13, "contractListValue_l": 14, "contractDiscount_l": 15, "contractValue_l": 16, "fulfillmentStatus_l": 3, "oRCL_ABO_ActionCode_l": 4 }, "expandMode": true, "columnWidth": { "fulfillmentStatus_l": 200 }, "sortCriteria": { "attribute": "listPrice_l", "direction": "descending" } }, "modifiedDate": "2023-09-29 03:46:08" } ], "dateAdded": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/userPersonalizations/oraclecpqo-transaction-userState" } ] }, { "personalizationName": "transaction_bmClone_2-quote-userState", "entityType": "COMMERCE", "dateModified": null, "personalizationData": [{ "componentName": "table-lineItem", "properties": { "textWrapMode": "wrap", "hiddenColumns": ["_part_number-_model_name", "_price_override_quantity", "_price_configurable_price"], "columnOrder": { "_chargeSetControl": 0, "documentNumber": 1, "_sequence_number": 2, "_part_number-_model_name": 3, "_part_display_number": 7, "_price_quantity": 9, "_price_override_quantity": 6, "_price_item_price_each": 4, "_price_configurable_price": 8, "_price_list_price_each": 5, "_pricing_rule_price_each": 10, "_price_unit_price_each": 11, "_price_subtotal": 12, "_price_override_price": 13, "_price_total_discount": 14, "_price_discount_percent": 15, "_price_override_discount": 16, "_price_net_price": 17 }, "expandMode": true, "columnWidth": { "_part_display_number": 200 }, "sortCriteria": { "attribute": "_price_list_price_each", "direction": "descending" } }, "modifiedDate": "2023-09-29 03:40:18" } ], "dateAdded": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/userPersonalizations/transaction_bmClone_2-quote-userState" } ] } ] }
https://sitename.oracle.com/rest/v17/userPersonalizations/oraclecpqo-transaction-userState
{ "hasMore": false, "links": [ { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/userPersonalizations" } ], "items": [{ "personalizationName": "oraclecpqo-transaction-userState", "entityType": "COMMERCE", "dateModified": null, "personalizationData": [{ "componentName": "table-transactionLine", "properties": { "textWrapMode": "wrap", "hiddenColumns": [ "_part_display_number", "oRCL_ABO_ActionCode_l" ], "columnOrder": { "_chargeSetControl": 0, "_group_sequence_number": 1, "_part_number-_model_name": 2, "_part_display_number": 5, "listPrice_l": 6, "_price_quantity": 8, "customDiscountValue_l": 7, "customDiscountType_l": 9, "customDiscountAmount_l": 10, "netPrice_l": 11, "priceScore_l": 12, "netAmount_l": 13, "contractListValue_l": 14, "contractDiscount_l": 15, "contractValue_l": 16, "fulfillmentStatus_l": 3, "oRCL_ABO_ActionCode_l": 4 }, "expandMode": true, "columnWidth": { "fulfillmentStatus_l": 200 }, "sortCriteria": { "attribute": "listPrice_l", "direction": "descending" } }, "modifiedDate": "2023-09-29 03:46:08" } ], "dateAdded": null, "links": [ { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/userPersonalizations/oraclecpqo-transaction-userState" } ] } ] }
https://sitename.oracle.com/rest/v17/userPersonalizations/actions/reset
{ "personalizationName": "oraclecpqo-transaction-userState", "componentName": "table-lineItem", "entityType": "COMMERCE" }
{ "items": [] }
https://sitename.oracle.com/rest/v17/userPersonalizations/save
{ "personalizations": [{ "personalizationName": "oraclecpqo-transaction-userState", "personalizationData": [{ "properties": { "expandMode": true, "columnOrder": { "_chargeSetControl": 0, "_group_sequence_number": 1, "_part_number-_model_name": 2, "_part_display_number": 5, "listPrice_l": 6, "_price_quantity": 8, "customDiscountValue_l": 7, "customDiscountType_l": 9, "customDiscountAmount_l": 10, "netPrice_l": 11, "priceScore_l": 12, "netAmount_l": 13, "contractListValue_l": 14, "contractDiscount_l": 15, "contractValue_l": 16, "fulfillmentStatus_l": 3, "oRCL_ABO_ActionCode_l": 4 }, "hiddenColumns": ["_part_display_number", "oRCL_ABO_ActionCode_l"], "textWrapMode": "wrap", "columnWidth": { "fulfillmentStatus_l": 200 }, "sortCriteria": { "attribute": "listPrice_l", "direction": "descending" } }, "componentName": "table-transactionLine" } ], "entityType": "COMMERCE" } ] }
{ "result": [{ "personalizationName": "oraclecpqo-transaction-userState", "personalizationData": [{ "componentName": "table-transactionLine", "properties": { "textWrapMode": "wrap", "hiddenColumns": ["_part_display_number", "oRCL_ABO_ActionCode_l"], "columnOrder": { "_chargeSetControl": 0, "_group_sequence_number": 1, "_part_number-_model_name": 2, "_part_display_number": 5, "listPrice_l": 6, "_price_quantity": 8, "customDiscountValue_l": 7, "customDiscountType_l": 9, "customDiscountAmount_l": 10, "netPrice_l": 11, "priceScore_l": 12, "netAmount_l": 13, "contractListValue_l": 14, "contractDiscount_l": 15, "contractValue_l": 16, "fulfillmentStatus_l": 3, "oRCL_ABO_ActionCode_l": 4 }, "expandMode": true, "columnWidth": { "fulfillmentStatus_l": 200 }, "sortCriteria": { "attribute": "listPrice_l", "direction": "descending" } }, "modifiedDate": "2023-11-17 19:35:52" } ], "entityType": "COMMERCE" } ] }
