Jump to

• Request
• Response
• Examples

Add a Pricing Attribute Mapping

post

/rest/v19/pricingSetup/attributes/{attributeVariableName}/mappings

Use this endpoint to add mapping information to the specified pricing attribute.

Request

Supported Media Types

• application/json

Path Parameters

• attributeVariableName(required): string

Body ()

Root Schema : PricingMappedDataSourceAttribute

Type: object

Show Source

• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  The label of the Pricing Data Source Attribute.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataSourceAttribute: string()
  Title: Data Source Attribute.

  Read Only: true

  The mapped data source attribute.
• dataSourceLabel: string()
  Title: Data Source Label

  Read Only: true

  The mapped label of the data source.
• dataSourceProviderVariableName: string()
  Title: Data Source Provider Variable Name

  Read Only: true

  The variable name of the data source provider.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Pricing Rule.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Rule.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Pricing Data Source Attribute.
• 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.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
• readOnly: boolean()
  Title: Read Only

  Read Only: true

  Indicates if the attribute has any restrictions for edits.
• sourceEntity: string()
  Title: Source Entity

  Read Only: true

  The name of the Pricing Data Source Entity
• validMapping: boolean()
  Title: Has Valid Mapping

  Read Only: true

  Indicates whether the Pricing Data Source Attribute has a valid mapping
• variableName: string()
  Title: Variable Name

  Read Only: true

  The variable name of the Pricing Data Source Attribute.

{
    "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"
                }
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Data Source Attribute.",
            "title":"Id",
            "readOnly":true
        },
        "dataSourceAttribute":{
            "type":"string",
            "format":"",
            "description":"The mapped data source attribute.",
            "title":"Data Source Attribute.",
            "readOnly":true
        },
        "dataSourceLabel":{
            "type":"string",
            "format":"",
            "description":"The mapped label of the data source.",
            "title":"Data Source Label",
            "readOnly":true
        },
        "dataSourceProviderVariableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the data source provider.",
            "title":"Data Source Provider Variable Name",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Pricing Data Source Attribute.",
            "title":"Variable Name",
            "readOnly":true
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing Data Source Attribute.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "validMapping":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Pricing Data Source Attribute has a valid mapping",
            "title":"Has Valid Mapping",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the attribute has any restrictions for edits.",
            "title":"Read Only",
            "readOnly":true
        },
        "sourceEntity":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Data Source Entity",
            "title":"Source Entity",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

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

The details of the user who modified the record.

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 : PricingMappedDataSourceAttribute

Type: object

Show Source

• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  The label of the Pricing Data Source Attribute.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataSourceAttribute: string()
  Title: Data Source Attribute.

  Read Only: true

  The mapped data source attribute.
• dataSourceLabel: string()
  Title: Data Source Label

  Read Only: true

  The mapped label of the data source.
• dataSourceProviderVariableName: string()
  Title: Data Source Provider Variable Name

  Read Only: true

  The variable name of the data source provider.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Pricing Rule.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Rule.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Pricing Data Source Attribute.
• 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.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
• readOnly: boolean()
  Title: Read Only

  Read Only: true

  Indicates if the attribute has any restrictions for edits.
• sourceEntity: string()
  Title: Source Entity

  Read Only: true

  The name of the Pricing Data Source Entity
• validMapping: boolean()
  Title: Has Valid Mapping

  Read Only: true

  Indicates whether the Pricing Data Source Attribute has a valid mapping
• variableName: string()
  Title: Variable Name

  Read Only: true

  The variable name of the Pricing Data Source Attribute.

{
    "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"
                }
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Data Source Attribute.",
            "title":"Id",
            "readOnly":true
        },
        "dataSourceAttribute":{
            "type":"string",
            "format":"",
            "description":"The mapped data source attribute.",
            "title":"Data Source Attribute.",
            "readOnly":true
        },
        "dataSourceLabel":{
            "type":"string",
            "format":"",
            "description":"The mapped label of the data source.",
            "title":"Data Source Label",
            "readOnly":true
        },
        "dataSourceProviderVariableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the data source provider.",
            "title":"Data Source Provider Variable Name",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Pricing Data Source Attribute.",
            "title":"Variable Name",
            "readOnly":true
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing Data Source Attribute.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "validMapping":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Pricing Data Source Attribute has a valid mapping",
            "title":"Has Valid Mapping",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the attribute has any restrictions for edits.",
            "title":"Read Only",
            "readOnly":true
        },
        "sourceEntity":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Data Source Entity",
            "title":"Source Entity",
            "readOnly":true
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

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

The details of the user who modified the record.

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 add mapping information to the specified pricing attribute in Pricing Engine 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/attributes/shippingCost/mappings

Request Body Sample

{
  "dataSourceProviderVariableName": "oraclecpqo",
  "variableName": "cH_float_convert"
}

Response Body Sample

{
  "orderNumber": 1,
  "id": 38821929,
  "dataSourceAttribute": "/process/oraclecpqo/_main_doc/transaction/cH_float_convert",
  "dataSourceProviderVariableName": "oraclecpqo",
  "variableName": "cH_float_convert",
  "attributeLabel": "Shipping Cost",
  "dateModified": "2022-11-28T21:42:39Z",
  "dateAdded": "2022-11-28T21:42:39Z",
  "readOnly": false
}

Back to Top