Jump to

• Request
• Response
• Examples

Update Pricing Attributes

patch

/rest/v16/pricingSetup/attributes

Use this endpoint to update or delete pricing attributes.

Request

Supported Media Types

• application/json

Body ()

Root Schema : PricingJsonPatch

Type: object

Show Source

• operations: array Patch Operations
  Title: Patch Operations

  The array of Json Patch operations.

{
    "properties":{
        "operations":{
            "type":"array",
            "format":"",
            "description":"The array of Json Patch operations.",
            "title":"Patch Operations",
            "items":{
                "$ref":"#/definitions/PricingJsonPatchOperation"
            }
        }
    }
}

Nested Schema : Patch Operations

Type: array

Title: Patch Operations

The array of Json Patch operations.

Show Source

• Array of: object PricingJsonPatchOperation

{
    "type":"array",
    "format":"",
    "description":"The array of Json Patch operations.",
    "title":"Patch Operations",
    "items":{
        "$ref":"#/definitions/PricingJsonPatchOperation"
    }
}

Nested Schema : PricingJsonPatchOperation

Type: object

Show Source

• op: string()
  Title: Op

  Allowed Values: [ "add", "remove", "replace" ]

  The operation to be performed.
• path: string()
  Title: Path

  The JSON Pointer string for "path" property.
• value: object Value
  Title: Value

  The target value.

{
    "properties":{
        "op":{
            "type":"string",
            "format":"",
            "description":"The operation to be performed.",
            "title":"Op",
            "enum":[
                "add",
                "remove",
                "replace"
            ]
        },
        "path":{
            "type":"string",
            "format":"",
            "description":"The JSON Pointer string for \"path\" property.",
            "title":"Path"
        },
        "value":{
            "type":"object",
            "format":"",
            "description":"The target value.",
            "title":"Value"
        }
    }
}

Nested Schema : Value

Type: object

Title: Value

The target value.

Back to Top

Response

204 Response

Success

Back to Top

Examples

The following examples show how to update or delete pricing attributes in Pricing Engine by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X PATCH - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/attributes

Request Body Sample

There are three operations included in this example:

• Add the new line-level attribute 'testAdd'
• Remove the '_quantityValidator' attribute
• Replace the 'myAttribute' Name

[{
    "op": "add",
    "path": "/",
    "value": {
      "name": "New",
      "variableName": "testAdd",
      "dataType": "boolean",
      "attributeLevel": "line"
    }
  }, {
    "op": "remove",
    "path": "/_quantityValidator",
    "value": {
      "variableName": "_quantityValidator"
    }
  }, {
    "op": "replace",
    "path": "/myAttribute",
    "value": {
      "name": "Updated Attribute Name",
      "variableName": "myAttribute"
    }
  }
]

Back to Top