REST API Services for Oracle CPQ

Get a Pricing Matrix Template

get

/rest/v19/pricingSetup/matrixTemplates/{templateVariableName}

Use this endpoint to retrieve the specified pricing matrix 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 the specified pricing matrix 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/matrixTemplates/testMatrixTemp1

Response Body Sample

{
  "name": "testMatrixTemp1",
  "variableName": "testMatrixTemp1",
  "active": true,
  "description": "testMatrixTemp1",
  "pricingMatrixCount": 0,
  "dateAdded": "2023-11-08T06:01:08Z",
  "dateModified": "2023-11-08T06:01:08Z",
  "templateType": "attributeBasedCharge"
}