Get Attributes for a Data Source Lookup
get
/rest/v16/pricingSetup/lookups/dataSources/{dataSourceVarName}/attributes
Use this endpoint to retrieve all attributes for the specified supported data source lookup.
Request
Path Parameters
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>;<VarName>=<variableValue>
The following are the available finder names and corresponding finder variables:- findByPricingAttribute: Find attributes from datasources using pricing attribute variable name.
Finder Variable:- attributeVarName;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findByPricingAttribute: Find attributes from datasources using pricing attribute variable name.
-
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".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_PricingDataSourceAttribute
Type:
Show Source
object
-
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. -
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. -
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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
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
Nested Schema : PricingDataSourceAttribute
Type:
Show Source
object
-
attributeDataType:
string()
Title:
Attribute Data Type
Read Only:true
The Data type of the Pricing Data Source Attribute. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
description:
string
-
id:
string
-
isArray:
boolean()
Title:
Is Array
Read Only:true
Indicates if the Pricing Data Source Attribute is an array -
label:
string()
Title:
Label
Read Only:true
The label 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. -
lookupCode:
string
-
meaning:
string
- menu: string()
-
path:
string()
Title:
Path
Read Only:true
The complete path of the Pricing Data Source Attribute.Use this to uniquely locate attributes with same label. -
variableName:
string()
Title:
Id
Read Only:true
The Variable Name of the Pricing Data Source Attribute.This should be unique.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following examples show how to retrieve all attributes for a supported data source by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
The 'limit' query specification is used in the following example to limit the results to five attributes per page.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/pricingSetup/lookups/dataSourcesCONFIG_ATTRS_visionVehicles/attributes?limit=5
Response Body Sample
{ "items": [{ "label": "Variable Name", "variableName": "_bm_pline_variable_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_pline_variable_name", "lookupCode": "_bm_pline_variable_name", "meaning": "/config/visionVehicles/_bm_pline_variable_name", "description": "Variable Name", "id": "_bm_pline_variable_name" }, { "label": "Partner Organization Id", "variableName": "_bm_model_partner_organization_id", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_partner_organization_id", "lookupCode": "_bm_model_partner_organization_id", "meaning": "/config/visionVehicles/_bm_model_partner_organization_id", "description": "Partner Organization Id", "id": "_bm_model_partner_organization_id" }, { "label": "Variable Name", "variableName": "_bm_model_variable_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_variable_name", "lookupCode": "_bm_model_variable_name", "meaning": "/config/visionVehicles/_bm_model_variable_name", "description": "Variable Name", "id": "_bm_model_variable_name" }, { "label": "Name", "variableName": "_bm_pline_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_pline_name", "lookupCode": "_bm_pline_name", "meaning": "/config/visionVehicles/_bm_pline_name", "description": "Name", "id": "_bm_pline_name" }, { "label": "Name", "variableName": "_bm_model_name", "attributeDataType": "Text", "isArray": false, "path": "/config/visionVehicles/_bm_model_name", "lookupCode": "_bm_model_name", "meaning": "/config/visionVehicles/_bm_model_name", "description": "Name", "id": "_bm_model_name" } ], "offset": 0, "limit": 5, "count": 5, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/lookups/dataSources/CONFIG_ATTRS_visionVehicles/attributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/pricingSetup/lookups/dataSources/CONFIG_ATTRS_visionVehicles/attributes?offset=0&limit=5" } ] }