REST API Services for Oracle CPQ

Get a Rate Card Template

get

/rest/v19/pricingSetup/rateCardTemplates/{templateVariableName}

Use this endpoint to retrieve the specified rate card template.

Request

Path Parameters

templateVariableName(required): string

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). More than one child can be specified using comma as a separator. Example: ?expand=columns. To include all the children and grandchildren, specify the value of this query parameter to be "all".
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

Root Schema : PricingMatrixTemplate

Type: object

Show Source

name: string
variableName: string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "variableName":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve a Rate Card Template 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/rateCardTemplates/dataUsageRateCardTemplate

Response Body Sample

{
  "name": "Data Usage Rate Card Template",
  "variableName": "dataUsageRateCardTemplate",
  "active": true,
  "description": "Data rate per market (North America, Latin America, EMEA, APAC)",
  "rateCardCount": 1,
  "dateAdded": "2023-08-25T13:56:51Z",
  "dateModified": "2023-08-25T13:56:51Z",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rateCardTemplates"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/rateCardTemplates/dataUsageRateCardTemplate/columns"
    }
  ]
}