Jump to

• Request
• Response
• Examples

Get All Pricing Attribute Mappings

get

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

Use this endpoint to retrieve mapping information for the specified pricing attribute.

Request

Path Parameters

• attributeVariableName(required): string

Query Parameters

• 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.
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>
  The following are the available finder names and corresponding finder variables:

  • findByKeyword: Find pricing data source attributes using variableName.
    Finder Variable:
    • keyword;string:The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingMappedDataSourceAttribute

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingMappedDataSourceAttribute"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

Type: array

Show Source

• Array of: object PricingMappedDataSourceAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingMappedDataSourceAttribute"
    }
}

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 : 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "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 : 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 examples show how to retrieve attribute mapping information for the specified pricing attribute in Pricing Engine 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 "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/attributes/bomLineItemText/mappings

Response Body Sample

{{
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/bomLineItemText"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/bomLineItemText/mappings"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/bomLineItemText/mappings?offset=0&limit=1000"
    }
  ],
  "hasMore": false,
  "items": [{
      "orderNumber": 1,
      "id": 3022764825,
      "dataSourceAttribute": "/config/test3/textField1",
      "dataSourceLabel": "Configuration : Test 3",
      "dataSourceProviderVariableName": "CONFIG_ATTRS_test3",
      "variableName": "textField1",
      "attributeLabel": "Text Field 1",
      "validMapping": true
    }, {
      "orderNumber": 2,
      "id": 3022764831,
      "dataSourceAttribute": "/process/formula/_main_doc/main/_transaction_total",
      "dataSourceLabel": "Formula",
      "dataSourceProviderVariableName": "formula",
      "variableName": "_transaction_total",
      "attributeLabel": "Transaction Total",
      "validMapping": true
    }
  ],
  "count": 2,
  "limit": 1000,
  "offset": 0
}

Back to Top