Get All Agreement Attributes
get
/rest/v19/pricingSetup/agreementAttributes
Use this endpoint to retrieve all price agreement attributes.
Request
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.
-
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 agreement attributes using name, variableName and attributeLevel.
Finder Variable:- keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findByKeyword: Find pricing agreement attributes using name, variableName and attributeLevel.
-
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.
-
q: string
Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
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_PricingAgreementAttribute
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
The details of the user who created the record.
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
The details of the user who modified the record.
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 : PricingAgreementAttribute
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates whether Agreement Attribute is active. -
arrayType:
boolean()
Title:
Array Type
Indicates whether Pricing Agreement Attribute is an array type. -
attributeLevel:
string()
Title:
Attribute Level
Allowed Values:[ "Header", "Line", "Charge" ]
Pricing Agreement Attribute Level. -
attributeLevelCode:
integer()
Title:
Attribute Level Code
Read Only:true
Attribute level code. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataType:
string()
Title:
Data Type
Allowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]
Data Type of the Pricing Agreement Attribute. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Pricing Agreement Attribute. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Agreement Attribute. -
description:
string()
Title:
Description
Description of the Pricing Agreement 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. -
lookupType:
string()
Title:
Lookup Type
The lookup type variable name for the Pricing Agreement Attribute. -
lookupTypeLabel:
string()
Title:
Lookup Type Display Label
Read Only:true
The lookup type display label for the Pricing Agreement Attribute. -
mappings:
Attribute Mappings
Title:
Attribute Mappings
Read Only:true
List of mappings for the Pricing Agreement Attribute. -
name:
string()
Title:
Name
Name of the Pricing Agreement Attribute. -
templateVariableKey:
string()
Title:
Template Variable Key
Read Only:true
Allowed Values:[ "Custom", "AgreementName", "AgreementDescription", "AgreementStartDate", "AgreementEndDate", "AccountID", "Account", "PartNumber", "ServiceDuration", "ServiceDurationPeriod", "ItemContractStartDate", "ItemContractEndDate", "RatePlanNumber", "ProductListPrice", "ProductPriceType", "ProductPricePeriod", "ProductNetPrice", "SourceTransactionId", "ChargeType", "ChargePriceType", "ChargePricePeriod", "ChargeUsageUOM", "ChargeDynamicPricingType", "ChargeDefinitionCode", "ChargeNetPrice", "RateCardStructure", "AgreementStatus", "AgreementNumber" ]
Pricing Agreement Attribute template variable key. -
valid:
boolean()
Title:
Valid
Read Only:true
Indicates whether Pricing Agreement Attribute is valid. -
variableName:
string()
Title:
Variable Name
Variable Name of the Pricing Agreement Attribute.
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
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : Attribute Mappings
Title:
Attribute Mappings
Read Only:
true
List of mappings for the Pricing Agreement Attribute.
Match All
List of mappings for the Pricing Agreement Attribute.
Show Source
Nested Schema : PricingResourceCollection_PricingAgreementMappedDataSourceAttribute
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
The details of the user who created the record.
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
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingAgreementMappedDataSourceAttribute
Type:
Show Source
object
-
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 Data Source Entity. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Data Source Entity. -
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.
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
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all pricing agreement attributes 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 "Accept: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes
Response Body Sample
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "name": "Agreement Name", "variableName": "_agreementName", "description": "Default to the Contract Name of the current transaction.", "dateModified": "2024-08-01T17:22:56Z", "dateAdded": "2024-08-01T17:22:56Z", "dataType": "String", "attributeLevel": "Header", "templateVariableKey": "AgreementName", "arrayType": false, "attributeLevelCode": 0, "active": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementName/mappings" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "name": "Agreement Description", "variableName": "_agreementDescription", "description": "Default to the Transaction Description of the current transaction.", "dateModified": "2024-08-01T17:22:57Z", "dateAdded": "2024-08-01T17:22:57Z", "dataType": "String", "attributeLevel": "Header", "templateVariableKey": "AgreementDescription", "arrayType": false, "attributeLevelCode": 0, "active": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementDescription" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementDescription/mappings" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "name": "Agreement Start Date", "variableName": "_agreementStartDate", "description": "Default to the Contract Start Date of the current transaction.", "dateModified": "2024-08-01T17:22:57Z", "dateAdded": "2024-08-01T17:22:57Z", "dataType": "Date", "attributeLevel": "Header", "templateVariableKey": "AgreementStartDate", "arrayType": false, "attributeLevelCode": 0, "active": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementStartDate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes/_agreementStartDate/mappings" } ] } ], "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes?offset=0&limit=3" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreementAttributes?offset=3&limit=3" } ] }