REST API Services for Oracle CPQ

Get a Charge Attribute

get

/rest/v19/pricingSetup/chargeAttributes/{attributeVariableName}

Use this endpoint to retrieve the specified charge attribute.

Request

Path Parameters

attributeVariableName(required): string

Query Parameters

fields: string

This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.

Response

Supported Media Types

application/json

200 Response

Success

Examples

The following example shows how to retrieve a Charge Attribute 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/pricingSetup/chargeAttributes/newChargeAttribute_c

Response Body Sample

{
  "name": "New Charge Attribute",
  "variableName": "newChargeAttribute_c",
  "description": "Updated New Charge Attribute Decription",
  "dateModified": "2023-09-21T20:33:07Z",
  "dateAdded": "2023-09-21T19:45:22Z",
  "dataType": "String",
  "templateVariableKey": "Custom",
  "orderNumber": 261,
  "key": false,
  "required": false,
  "active": true,
  "visibility": "Runtime",
  "negotiable": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes/newChargeAttribute_c"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes"
    }
  ]
}