Jump to

• Request
• Response
• Examples

Update Charge Attributes

patch

/rest/v16/pricingSetup/chargeAttributes

Use this endpoint to create, delete, and update Charge 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 create, delete, and update Charge Attributes 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/chargeAttributes

Request Body Sample

[
  {
    "op": "add",
    "path": "/",
    "value": {
      "name": "New Boolean Charge",
      "variableName": "newBooleanCharge_c",
      "dataType": "Boolean",
      "key": true,
      "defaultValue": "true",
      "required": true,
      "active": true,
      "visibility": "Runtime",
      "negotiable": true
    }
  }, {
    "op": "remove",
    "path": "/newChargeAttribute2_c"
  }, {
    "op": "replace",
    "path": "/newChargeAttribute_c",
    "value": {
      "description": "Updated New Charge Attribute Description"
    }
  }
]

Back to Top