Get All Pricing Matrix Template Columns
post
/rest/v19/pricingSetup/matrixTemplates/{templateVariableName}/columns
Use this endpoint to retrieve a list of columns for the specified pricing matrix template.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : PricingMatrixTemplateColumn
Type:
Show Source
object-
active:
boolean()
Title:
ActiveIndicates if the rate card template column is active. -
chargeAttributeName:
string()
Title:
Charge Attribute NameRead Only:trueCharge Attribute Name. -
chargeAttributeProductPriceEnabled:
boolean()
Title:
Charge Attribute Product Price EnabledRead Only:trueCharge Attribute Product Price Enabled. -
chargeAttributeVariableName:
string()
Title:
Charge Attribute Variable NameRead Only:trueCharge Attribute Variable Name. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dataType(required):
string()
Title:
Data TypeAllowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer" ]Data Type of the Rate Card Template column. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation Date of the Rate Card Template column. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast Modified date of the Rate Card Template column. -
defaultOverridable:
boolean()
Title:
Default OverridableIndicates if the default value is overridable -
defaultValue:
string()
Title:
Default ValueDefault Value of the Rate Card Template column. -
description:
string()
Title:
DescriptionDescription of the Rate Card Template column. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Rate Card Template column. -
integrationId:
string()
Title:
Integration IDRead Only:trueIdentifier for the corresponding entity in QP. -
ioType:
string()
Title:
Input/Output TypeAllowed Values:[ "input", "output" ]The Input/Output Type of the Pricing Matrix column. -
key:
boolean()
Title:
ActiveIndicates if the rate card template column is a key. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
lookupType:
string()
Title:
Lookup TypeLookup Type of the Rate Card Template column. -
lookupTypeLabel:
string()
Title:
Lookup Type Display LabelRead Only:trueThe lookup type display label of the Rate Card Template column. -
lookupUpdatable:
boolean()
Title:
Lookup UpdatableWhether the lookup type is updatable for the matrix template column. -
name:
string()
Title:
NameName of the Rate Card Template column. -
negotiable:
boolean()
Title:
NegotiableIndicates if the value stored in this rate card template column is negotiable. -
operator:
string()
Title:
OperatorAllowed Values:[ "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", "Not Ends With" ]The operator to be applied on this Pricing Matrix column. -
orderNumber:
integer()
Title:
Order NumberThe sequence number of the column in the template. -
pricingAttribute:
string()
Title:
Pricing AttributeThe pricing attribute refered to in this Pricing Matrix column. -
rateCardTemplateVarName:
string
-
required:
boolean()
Title:
RequiredIndicates if the value of this rate card template column is required. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
templateType:
string()
Title:
Template TypeRead Only:trueAllowed Values:[ "rateCard", "attributeBasedCharge", "scriptingPriceModel" ]The type of the parent Pricing Matrix Template. -
variableName:
string()
Title:
Variable NameVariable Name of the Rate Card Template column. -
wildCardSupported:
boolean()
Title:
Wild Card SupportedIndicates if this column supports wild card values.
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified ByRead Only:
trueThe details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object-
emailId:
string()
Title:
Email IdEmail Id of the user -
firstName:
string()
Title:
First NameFirst Name of the user -
lastName:
string()
Title:
Last NameLast Name of the user
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingMatrixTemplateColumn
Type:
Show Source
object-
active:
boolean()
Title:
ActiveIndicates if the rate card template column is active. -
chargeAttributeName:
string()
Title:
Charge Attribute NameRead Only:trueCharge Attribute Name. -
chargeAttributeProductPriceEnabled:
boolean()
Title:
Charge Attribute Product Price EnabledRead Only:trueCharge Attribute Product Price Enabled. -
chargeAttributeVariableName:
string()
Title:
Charge Attribute Variable NameRead Only:trueCharge Attribute Variable Name. -
createdBy:
Created By
Title:
Created ByRead Only:trueThe details of the user who created the record. -
dataType(required):
string()
Title:
Data TypeAllowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer" ]Data Type of the Rate Card Template column. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date AddedRead Only:trueCreation Date of the Rate Card Template column. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date ModifiedRead Only:trueLast Modified date of the Rate Card Template column. -
defaultOverridable:
boolean()
Title:
Default OverridableIndicates if the default value is overridable -
defaultValue:
string()
Title:
Default ValueDefault Value of the Rate Card Template column. -
description:
string()
Title:
DescriptionDescription of the Rate Card Template column. -
groupAccessEnabled:
boolean()
Title:
Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment -
id:
integer()
Title:
IdRead Only:trueThe Unique Identifier of the Rate Card Template column. -
integrationId:
string()
Title:
Integration IDRead Only:trueIdentifier for the corresponding entity in QP. -
ioType:
string()
Title:
Input/Output TypeAllowed Values:[ "input", "output" ]The Input/Output Type of the Pricing Matrix column. -
key:
boolean()
Title:
ActiveIndicates if the rate card template column is a key. -
lastModifiedBy:
Last Modified By
Title:
Last Modified ByRead Only:trueThe details of the user who modified the record. -
links:
array Links
Title:
LinksRead Only:trueThe link relations associated with the resource instance. -
lookupType:
string()
Title:
Lookup TypeLookup Type of the Rate Card Template column. -
lookupTypeLabel:
string()
Title:
Lookup Type Display LabelRead Only:trueThe lookup type display label of the Rate Card Template column. -
lookupUpdatable:
boolean()
Title:
Lookup UpdatableWhether the lookup type is updatable for the matrix template column. -
name:
string()
Title:
NameName of the Rate Card Template column. -
negotiable:
boolean()
Title:
NegotiableIndicates if the value stored in this rate card template column is negotiable. -
operator:
string()
Title:
OperatorAllowed Values:[ "none", "<", "<=", "Not =", "=", ">", ">=", "Contains", "Not Contains", "Starts With", "Not Starts With", "Ends With", "Not Ends With" ]The operator to be applied on this Pricing Matrix column. -
orderNumber:
integer()
Title:
Order NumberThe sequence number of the column in the template. -
pricingAttribute:
string()
Title:
Pricing AttributeThe pricing attribute refered to in this Pricing Matrix column. -
rateCardTemplateVarName:
string
-
required:
boolean()
Title:
RequiredIndicates if the value of this rate card template column is required. -
segmentLevelAccessType:
string()
Title:
Segment-level Access TypeRead Only:trueSegment-level Access Type -
templateType:
string()
Title:
Template TypeRead Only:trueAllowed Values:[ "rateCard", "attributeBasedCharge", "scriptingPriceModel" ]The type of the parent Pricing Matrix Template. -
variableName:
string()
Title:
Variable NameVariable Name of the Rate Card Template column. -
wildCardSupported:
boolean()
Title:
Wild Card SupportedIndicates if this column supports wild card values.
Nested Schema : Created By
Title:
Created ByRead Only:
trueThe details of the user who created the record.
Match All
The details of the user who created the record.
Show Source
Nested Schema : Last Modified By
Title:
Last Modified ByRead Only:
trueThe details of the user who modified the record.
Match All
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksRead Only:
trueThe link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object-
emailId:
string()
Title:
Email IdEmail Id of the user -
firstName:
string()
Title:
First NameFirst Name of the user -
lastName:
string()
Title:
Last NameLast Name of the user
Examples
The following example shows how to create pricing matrix template columns by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/matrixTemplates/testMatrixTemp1/columns
Request Body Sample
{
"name": "To Country",
"variableName": "toCountry",
"dataType": "String",
"defaultOverridable": false,
"description": "To country.",
"active": true,
"negotiable": false,
"required": false,
"ioType": "input",
"lookupType": "custom1_c",
"pricingAttribute": "pricingEngineMainString",
"operator": "="
}
Response Body Sample
{
"id": 3023092501,
"name": "To Country",
"variableName": "toCountry",
"key": false,
"dataType": "String",
"lookupType": "custom1_c",
"defaultOverridable": false,
"description": "To country.",
"active": true,
"negotiable": false,
"required": false,
"dateAdded": "2023-11-27T15:30:25Z",
"dateModified": "2023-11-27T15:30:25Z",
"ioType": "input",
"operator": "=",
"pricingAttribute": "pricingEngineMainString"
}