Jump to

• Request
• Response
• Examples

Add Pricing Matrix Template Column

post

/rest/v16/pricingSetup/matrixTemplates/{templateVarName}/columns

Use this endpoint to create a column for the specified pricing matrix template.

Request

Supported Media Types

• application/json

Path Parameters

• templateVarName(required): string

Body ()

Root Schema : PricingMatrixTemplateColumn

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates if the rate card template column is active.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataType(required): string()
  Title: Data Type

  Allowed 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 Added

  Read Only: true

  Creation Date of the Rate Card Template column.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Rate Card Template column.
• defaultOverridable: boolean()
  Title: Default Overridable

  Indicates if the default value is overridable
• defaultValue: string()
  Title: Default Value

  Default Value of the Rate Card Template column.
• description: string()
  Title: Description

  Description of the Rate Card Template column.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Rate Card Template column.
• integrationId: string()
  Title: Integration ID

  Read Only: true

  Identifier for the corresponding entity in QP.
• ioType: string()
  Title: Input/Output Type

  Allowed Values: [ "input", "output" ]

  The Input/Output Type of the Pricing Matrix column.
• key: boolean()
  Title: Active

  Indicates if the rate card template column is a key.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• lookupType: string()
  Title: Lookup Type

  Lookup Type of the Rate Card Template column.
• lookupTypeLabel: string()
  Title: Lookup Type Display Label

  Read Only: true

  The lookup type display label of the Rate Card Template column.
• name: string()
  Title: Name

  Name of the Rate Card Template column.
• negotiable: boolean()
  Title: Negotiable

  Indicates if the value stored in this rate card template column is negotiable.
• operator: string()
  Title: Operator

  Allowed 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 Number

  The sequence number of the column in the template.
• pricingAttribute: string()
  Title: Pricing Attribute

  The pricing attribute refered to in this Pricing Matrix column.
• required: boolean()
  Title: Required

  Indicates if the value of this rate card template column is required.
• templateType: string()
  Title: Template Type

  Read Only: true

  Allowed Values: [ "rateCard", "attributeBasedCharge" ]

  The type of the parent Pricing Matrix Template.
• variableName: string()
  Title: Variable Name

  Variable Name of the Rate Card Template column.
• wildCardSupported: boolean()
  Title: Wild Card Supported

  Indicates if this column supports wild card values.

{
    "required":[
        "dataType"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Rate Card Template column.",
            "title":"Id",
            "readOnly":true
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The sequence number of the column in the template.",
            "title":"Order Number"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Rate Card Template column.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Rate Card Template column.",
            "title":"Variable Name"
        },
        "key":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is a key.",
            "title":"Active"
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Rate Card Template column.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer"
            ]
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"Lookup Type of the Rate Card Template column.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label of the Rate Card Template column.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "defaultValue":{
            "type":"string",
            "format":"",
            "description":"Default Value of the Rate Card Template column.",
            "title":"Default Value"
        },
        "defaultOverridable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the default value is overridable",
            "title":"Default Overridable"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Rate Card Template column.",
            "title":"Description"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is active.",
            "title":"Active"
        },
        "negotiable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value stored in this rate card template column is negotiable.",
            "title":"Negotiable"
        },
        "required":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value of this rate card template column is required.",
            "title":"Required"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Identifier for the corresponding entity in QP.",
            "title":"Integration ID",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Rate Card Template column.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Rate Card Template column.",
            "title":"Date Modified",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"The Input/Output Type of the Pricing Matrix column.",
            "title":"Input/Output Type",
            "enum":[
                "input",
                "output"
            ]
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"The operator to be applied on this Pricing Matrix column.",
            "title":"Operator",
            "enum":[
                "none",
                "<",
                "<=",
                "Not =",
                "=",
                ">",
                ">=",
                "Contains",
                "Not Contains",
                "Starts With",
                "Not Starts With",
                "Ends With",
                "Not Ends With"
            ]
        },
        "pricingAttribute":{
            "type":"string",
            "format":"",
            "description":"The pricing attribute refered to in this Pricing Matrix column.",
            "title":"Pricing Attribute"
        },
        "wildCardSupported":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this column supports wild card values.",
            "title":"Wild Card Supported"
        },
        "templateType":{
            "type":"string",
            "format":"",
            "description":"The type of the parent Pricing Matrix Template.",
            "title":"Template Type",
            "readOnly":true,
            "enum":[
                "rateCard",
                "attributeBasedCharge"
            ]
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingMatrixTemplateColumn

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates if the rate card template column is active.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataType(required): string()
  Title: Data Type

  Allowed 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 Added

  Read Only: true

  Creation Date of the Rate Card Template column.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Rate Card Template column.
• defaultOverridable: boolean()
  Title: Default Overridable

  Indicates if the default value is overridable
• defaultValue: string()
  Title: Default Value

  Default Value of the Rate Card Template column.
• description: string()
  Title: Description

  Description of the Rate Card Template column.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Rate Card Template column.
• integrationId: string()
  Title: Integration ID

  Read Only: true

  Identifier for the corresponding entity in QP.
• ioType: string()
  Title: Input/Output Type

  Allowed Values: [ "input", "output" ]

  The Input/Output Type of the Pricing Matrix column.
• key: boolean()
  Title: Active

  Indicates if the rate card template column is a key.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• lookupType: string()
  Title: Lookup Type

  Lookup Type of the Rate Card Template column.
• lookupTypeLabel: string()
  Title: Lookup Type Display Label

  Read Only: true

  The lookup type display label of the Rate Card Template column.
• name: string()
  Title: Name

  Name of the Rate Card Template column.
• negotiable: boolean()
  Title: Negotiable

  Indicates if the value stored in this rate card template column is negotiable.
• operator: string()
  Title: Operator

  Allowed 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 Number

  The sequence number of the column in the template.
• pricingAttribute: string()
  Title: Pricing Attribute

  The pricing attribute refered to in this Pricing Matrix column.
• required: boolean()
  Title: Required

  Indicates if the value of this rate card template column is required.
• templateType: string()
  Title: Template Type

  Read Only: true

  Allowed Values: [ "rateCard", "attributeBasedCharge" ]

  The type of the parent Pricing Matrix Template.
• variableName: string()
  Title: Variable Name

  Variable Name of the Rate Card Template column.
• wildCardSupported: boolean()
  Title: Wild Card Supported

  Indicates if this column supports wild card values.

{
    "required":[
        "dataType"
    ],
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Rate Card Template column.",
            "title":"Id",
            "readOnly":true
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The sequence number of the column in the template.",
            "title":"Order Number"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Rate Card Template column.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Rate Card Template column.",
            "title":"Variable Name"
        },
        "key":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is a key.",
            "title":"Active"
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Rate Card Template column.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer"
            ]
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"Lookup Type of the Rate Card Template column.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label of the Rate Card Template column.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "defaultValue":{
            "type":"string",
            "format":"",
            "description":"Default Value of the Rate Card Template column.",
            "title":"Default Value"
        },
        "defaultOverridable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the default value is overridable",
            "title":"Default Overridable"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Rate Card Template column.",
            "title":"Description"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the rate card template column is active.",
            "title":"Active"
        },
        "negotiable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value stored in this rate card template column is negotiable.",
            "title":"Negotiable"
        },
        "required":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the value of this rate card template column is required.",
            "title":"Required"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Identifier for the corresponding entity in QP.",
            "title":"Integration ID",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Rate Card Template column.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Rate Card Template column.",
            "title":"Date Modified",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"The Input/Output Type of the Pricing Matrix column.",
            "title":"Input/Output Type",
            "enum":[
                "input",
                "output"
            ]
        },
        "operator":{
            "type":"string",
            "format":"",
            "description":"The operator to be applied on this Pricing Matrix column.",
            "title":"Operator",
            "enum":[
                "none",
                "<",
                "<=",
                "Not =",
                "=",
                ">",
                ">=",
                "Contains",
                "Not Contains",
                "Starts With",
                "Not Starts With",
                "Ends With",
                "Not Ends With"
            ]
        },
        "pricingAttribute":{
            "type":"string",
            "format":"",
            "description":"The pricing attribute refered to in this Pricing Matrix column.",
            "title":"Pricing Attribute"
        },
        "wildCardSupported":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this column supports wild card values.",
            "title":"Wild Card Supported"
        },
        "templateType":{
            "type":"string",
            "format":"",
            "description":"The type of the parent Pricing Matrix Template.",
            "title":"Template Type",
            "readOnly":true,
            "enum":[
                "rateCard",
                "attributeBasedCharge"
            ]
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/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"
}

Back to Top