Jump to

• Request
• Response
• Examples

Get All User Personalizations

get

/rest/v19/userPersonalizations

Use this endpoint to retrieve a list of user personalizations for the current user.

Request

Supported Media Types

• application/json

Query Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : User Personalization Collection Definitions

Type: object

Title: User Personalization Collection Definitions

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/userPersonalizations"
            }
        }
    },
    "title":"User Personalization Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object User Personalization Instance Definitions
  Title: User Personalization Instance Definitions

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

Nested Schema : User Personalization Instance Definitions

Type: object

Title: User Personalization Instance Definitions

Show Source

• 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.
• entityType: string
  Title: Entity Type

  Entity Type of personalization
• personalizationData: array Personalization Data
  Title: Personalization Data

  Data for saving personalization properties
• personalizationName: string
  Title: Personalization Name

  Name of personalization

{
    "type":"object",
    "properties":{
        "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"
        },
        "entityType":{
            "type":"string",
            "description":"Entity Type of personalization",
            "title":"Entity Type"
        },
        "personalizationData":{
            "$ref":"#/definitions/personalizationData"
        },
        "personalizationName":{
            "type":"string",
            "description":"Name of personalization",
            "title":"Personalization Name"
        }
    },
    "title":"User Personalization Instance Definitions"
}

Nested Schema : Personalization Data

Type: array

Title: Personalization Data

Data for saving personalization properties

Show Source

• Array of: object items

{
    "title":"Personalization Data",
    "type":"array",
    "description":"Data for saving personalization properties",
    "items":{
        "type":"object",
        "properties":{
            "componentName":{
                "type":"string",
                "description":"Component Name for which personalization properties are added",
                "title":"Name of the Component"
            },
            "properties":{
                "type":"object",
                "description":"Properties which are personalized by the user",
                "title":"Properties"
            },
            "modifiedDate":{
                "type":"string",
                "format":"date",
                "description":"last modified date of Properties",
                "title":"Modified Date"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• componentName: string
  Title: Name of the Component

  Component Name for which personalization properties are added
• modifiedDate: string(date)
  Title: Modified Date

  last modified date of Properties
• properties: object Properties
  Title: Properties

  Properties which are personalized by the user

{
    "type":"object",
    "properties":{
        "componentName":{
            "type":"string",
            "description":"Component Name for which personalization properties are added",
            "title":"Name of the Component"
        },
        "properties":{
            "type":"object",
            "description":"Properties which are personalized by the user",
            "title":"Properties"
        },
        "modifiedDate":{
            "type":"string",
            "format":"date",
            "description":"last modified date of Properties",
            "title":"Modified Date"
        }
    }
}

Nested Schema : Properties

Type: object

Title: Properties

Properties which are personalized by the user

Back to Top

Examples

The following examples show how to retrieve a list of all user Line Item Grid personalizations 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 "Content-type: application/json"
"https://sitename.oracle.com/rest/v19/userPersonalizations

Response Body Sample

{
 {
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/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/v19/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/v19/userPersonalizations/transaction_bmClone_2-quote-userState"
        }
      ]
    }
  ]
}

Back to Top