Get a Pricing Attribute
get
                    /rest/v19/pricingSetup/attributes/{attributeVariableName}
Use this endpoint to retrieve the specified pricing attribute.
                
                Request
Path Parameters
                
                
                
                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=mappings. 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 : PricingAttribute
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            active: 
            boolean()
            Title:ActiveIndicates whether Pricing Attribute is active.
- 
            arrayType: 
            boolean()
            Title:Array TypeIndicates whether Pricing Attribute is an array type.
- 
            attributeLevel: 
            string()
            Title:Attribute LevelAllowed Values:[ "Header", "Line", "Charge" ]Pricing Attribute Level.
- 
            createdBy: 
             Created By
            
            Title:Created ByRead Only:trueThe details of the user who created the record.
- 
            dataType: 
            string()
            Title:Data TypeAllowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]Data Type of the Pricing Attribute.
- 
            dateAdded: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date AddedRead Only:trueCreation date of the Pricing Attribute.
- 
            dateModified: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date ModifiedRead Only:trueLast modified date of the Pricing Attribute.
- 
            defaultValue: 
            string()
            Title:Default ValueThe default value of the Charge Attribute.
- 
            defaultValueLabel: 
            string()
            Title:Default Value Display LabelRead Only:trueThe default value display label of the Charge Attribute.
- 
            description: 
            string()
            Title:DescriptionDescription of the Pricing Attribute.
- 
            groupAccessEnabled: 
            boolean()
            Title:Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment
- 
            ioType: 
            string()
            Title:IO TypeAllowed Values:[ "Input", "Output", "Internal", "External" ]Pricing Attribute IO Type.
- 
            key: 
            boolean()
            Title:KeyRead Only:trueIndicates whether the Charge Attribute is part of the user 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 TypeThe lookup type variable name for the Pricing Attribute.
- 
            lookupTypeLabel: 
            string()
            Title:Lookup Type Display LabelRead Only:trueThe lookup type display label for the Pricing Attribute.
- 
            mappings: 
             Attribute Mappings
            
            Title:Attribute MappingsRead Only:trueList of mappings for the Pricing Attribute.
- 
            name: 
            string()
            Title:NameName of the Pricing Attribute.
- 
            negotiable: 
            boolean()
            Title:NegotiableIndicates whether the Charge Attribute is editable in runtime.
- 
            orderNumber: 
            integer()
            Title:Order NumberThe order of the Charge Attribute.
- 
            required: 
            boolean()
            Title:RequiredIndicates whether Charge Attribute is required.
- 
            segmentLevelAccessType: 
            string()
            Title:Segment-level Access TypeRead Only:trueSegment-level Access Type
- 
            templateVariableKey: 
            string()
            Title:Template Variable KeyRead Only:trueAllowed Values:[ "Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" ]Pricing Attribute template variable key.
- 
            valid: 
            boolean()
            Title:ValidRead Only:trueIndicates whether Pricing Attribute is valid.
- 
            variableName: 
            string()
            Title:Variable NameVariable Name of the Pricing Attribute.
- 
            visibility: 
            string()
            Title:VisibilityIndicates whether the Charge Attribute is visible in Administration or Runtime.
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 : Attribute Mappings
    
      
      
    
    
    
    Title: 
    
    
    
    
    Attribute MappingsRead Only: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    trueList of mappings for the Pricing Attribute.
    
    
    
    
    
    
    Match All
    
        
            List of mappings for the Pricing Attribute.
        
    
    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
Nested Schema : PricingResourceCollection_PricingMappedDataSourceAttribute
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            count: 
            integer()
            Title:CountRead Only:trueThe number of resource instances returned in the current range.
- 
            createdBy: 
             Created By
            
            Title:Created ByRead Only:trueThe details of the user who created the record.
- 
            groupAccessEnabled: 
            boolean()
            Title:Group Access EnabledRead Only:trueIndicates whether the user has access to the groups segment
- 
            hasMore: 
            boolean()
            Title:HasMoreRead Only:trueIndicates 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 ByRead Only:trueThe details of the user who modified the record.
- 
            limit: 
            integer()
            Title:LimitRead Only:trueThe actual paging size used by the server.
- 
            links: 
            array  Links
            
            Title:LinksRead Only:trueThe link relations associated with the resource instance.
- 
            offset: 
            integer()
            Title:OffSetRead Only:trueThe offset value used in the current page.
- 
            segmentLevelAccessType: 
            string()
            Title:Segment-level Access TypeRead Only:trueSegment-level Access Type
- 
            totalResults: 
            integer()
            Title:Total ResultsRead Only:trueCaptures 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.
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 : PricingMappedDataSourceAttribute
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    Show Source
        object- 
            attributeLabel: 
            string()
            Title:Attribute LabelRead Only:trueThe label of the Pricing Data Source Attribute.
- 
            createdBy: 
             Created By
            
            Title:Created ByRead Only:trueThe details of the user who created the record.
- 
            dataSourceAttribute: 
            string()
            Title:Data Source Attribute.Read Only:trueThe mapped data source attribute.
- 
            dataSourceLabel: 
            string()
            Title:Data Source LabelRead Only:trueThe mapped label of the data source.
- 
            dataSourceProviderVariableName: 
            string()
            Title:Data Source Provider Variable NameRead Only:trueThe variable name of the data source provider.
- 
            dateAdded: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date AddedRead Only:trueCreation date of the Pricing Rule.
- 
            dateModified: 
            string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
            Title:Date ModifiedRead Only:trueLast modified date of the Pricing Rule.
- 
            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 Pricing Data Source Attribute.
- 
            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.
- 
            orderNumber: 
            integer()
            Title:Order NumberThe position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
- 
            readOnly: 
            boolean()
            Title:Read OnlyRead Only:trueIndicates if the attribute has any restrictions for edits.
- 
            segmentLevelAccessType: 
            string()
            Title:Segment-level Access TypeRead Only:trueSegment-level Access Type
- 
            sourceEntity: 
            string()
            Title:Source EntityRead Only:trueThe name of the Pricing Data Source Entity
- 
            validMapping: 
            boolean()
            Title:Has Valid MappingRead Only:trueIndicates whether the Pricing Data Source Attribute has a valid mapping
- 
            variableName: 
            string()
            Title:Variable NameRead Only:trueThe variable name of the Pricing Data Source Attribute.
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
        
        
    
    
    
    
    
    
Examples
The following examples show how to retrieve 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.
The 'expand' query specification is used in the following example to include attribute mappings in the response.
curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/attributes/Newy14?expand=mappings
Response Body Sample
{
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/Newy14?expand=mappings"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/Newy14/mappings"
    }, {
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/attributes/Newy14"
    }
  ],
  "valid": true,
  "arrayType": false,
  "templateVariableKey": "Custom",
  "mappings": {
    "items": [{
        "orderNumber": -1,
        "id": 3022761830,
        "dataSourceAttribute": "/process/test_bmClone_1/_main_doc/main/arrayCurrency1",
        "dataSourceLabel": "Pricing In BOM",
        "dataSourceProviderVariableName": "test_bmClone_1",
        "variableName": "arrayCurrency1",
        "attributeLabel": "Array Currency 1",
        "validMapping": true
      }, {
        "orderNumber": 0,
        "id": 3022764062,
        "dataSourceAttribute": "/process/test/_main_doc/main/arrayCurrency1",
        "dataSourceLabel": "Test",
        "dataSourceProviderVariableName": "test",
        "variableName": "arrayCurrency1",
        "attributeLabel": "Array Currency 1",
        "validMapping": true
      }, {
        "orderNumber": 1,
        "id": 3022764225,
        "dataSourceAttribute": "/config/test3/currencyField1",
        "dataSourceLabel": "Configuration : Test 3",
        "dataSourceProviderVariableName": "CONFIG_ATTRS_test3",
        "variableName": "currencyField1",
        "attributeLabel": "Currency Field 1",
        "validMapping": true
      }
    ]
  },
  "variableName": "Newy14",
  "dataType": "Currency",
  "name": "netfgy4",
  "description": null,
  "dateModified": "2022-05-19T04:42:09.000Z",
  "id": 3022761824,
  "attributeLevel": "Line",
  "dateAdded": "2022-05-19T04:42:09.000Z"
}