Overview
These endpoints enable administration of CPQ Pricing Portal agreement attributes using REST API services.
Administration
|
Description |
Use this endpoint to delete the specified pricing agreement attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes/{attributeVariableName} |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the pricing agreement attribute. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified pricing agreement attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes/{attributeVariableName} |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the pricing agreement attribute. |
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates whether the pricing agreement attribute is active. |
|
arrayType |
Indicates whether pricing agreement attribute is an array type. |
|
|
attributeLevel |
Identifies the pricing agreement attribute level: Allowed values: "Header", "Line", "Charge" |
|
|
attributeLevelCode |
The pricing agreement attribute level code. |
|
|
createdBy |
The details of the user who created the record. | |
|
dataType |
Data Type of the pricing agreement attribute. |
|
|
dateAdded |
The date the pricing agreement attribute was created. | |
|
dateModified |
The date the pricing agreement attribute was last modified. | |
|
defaultValue |
The default value of the pricing agreement attribute. | |
|
defaultValueLabel |
The default value display label of the pricing agreement attribute. | |
|
description |
Description of the pricing agreement attribute. | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
lookupType |
The lookup type variable name for the pricing agreement attribute. | |
|
lookupTypeLabel |
The lookup type display label for the pricing agreement attribute. | |
|
mappings |
List of mappings for the pricing agreement attribute. | |
|
name |
Name of the pricing agreement attribute. | |
|
required |
Indicates whether Agreement Attribute is required. |
|
|
templateVariableKey |
The template variable key. 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" |
|
|
valid |
Indicates whether the pricing agreement attribute is valid. | |
|
variableName |
Variable Name of the pricing agreement attribute. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_agreementStatus
{ "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "name": "Agreement Status", "variableName": "_agreementStatus", "description": "Current status of the Agreement.", "dateModified": "2024-08-01T17:22:57Z", "dateAdded": "2024-08-01T17:22:57Z", "dataType": "String", "attributeLevel": "Header", "templateVariableKey": "AgreementStatus", "arrayType": false, "attributeLevelCode": 0, "active": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_agreementStatus" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_agreementStatus/mappings" } ] }
|
Description |
Use this endpoint to retrieve all pricing agreement attributes. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing agreement attributes. |
|
|
active |
Indicates whether the pricing agreement attribute is active. | |
|
arrayType |
Indicates whether pricing agreement attribute is an array type. |
|
|
attributeLevel |
Identifies the pricing agreement attribute level: Allowed values: "Header", "Line", "Charge" |
|
|
attributeLevelCode |
The pricing agreement attribute level code. |
|
|
createdBy |
The details of the user who created the record. | |
|
dataType |
Data Type of the pricing agreement attribute. |
|
|
dateAdded |
The date the pricing agreement attribute was created. | |
|
dateModified |
The date the pricing agreement attribute was last modified. | |
|
defaultValue |
The default value of the pricing agreement attribute. | |
|
defaultValueLabel |
The default value display label of the pricing agreement attribute. | |
|
description |
Description of the pricing agreement attribute. | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
lookupType |
The lookup type variable name for the pricing agreement attribute. | |
|
lookupTypeLabel |
The lookup type display label for the pricing agreement attribute. | |
|
mappings |
List of mappings for the pricing agreement attribute. | |
|
name |
Name of the pricing agreement attribute. | |
|
required |
Indicates whether Agreement Attribute is required. |
|
|
templateVariableKey |
The template variable key. 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" |
|
|
valid |
Indicates whether the pricing agreement attribute is valid. | |
|
variableName |
Variable Name of the pricing agreement attribute. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes?limit=3
{ "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/v17/pricingSetup/agreementAttributes/_agreementName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/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/v17/pricingSetup/agreementAttributes/_agreementDescription" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/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/v17/pricingSetup/agreementAttributes/_agreementStartDate" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_agreementStartDate/mappings" } ] } ], "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes?offset=0&limit=3" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes?offset=3&limit=3" } ] }
Get Agreement Attribute Mappings
|
Description |
Use this endpoint to retrieve all pricing agreement attribute mappings. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes/{attributeVariableName}/mappings |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the pricing agreement attribute. |
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of pricing agreement attribute mappings. |
|
|
attributeLabel |
The label of the pricing data source attribute. |
|
|
createdBy |
The details of the user who created the record. |
|
|
dataSourceAttribute |
The mapped data source attribute. |
|
|
dataSourceLabel |
The mapped label of the data source. |
|
|
dataSourceProviderVariableName |
The variable name of the data source provider. |
|
|
dateAdded |
The date the pricing data source entity was created. |
|
|
dateModified |
The date the pricing data source entity was last modified. |
|
|
id |
The unique identifier of the pricing data source attribute. |
|
|
lastModifiedBy |
The details of the user who modified the record. |
|
|
orderNumber |
The position of the pricing data source attribute in the ordered list. |
|
|
readOnly |
Indicates if the attribute has any restrictions for edits. |
|
|
sourceEntity |
The name of the pricing data source entity. |
|
|
validMapping |
Indicates whether the pricing data source attribute has a valid mapping. |
|
|
variableName |
Variable name of the pricing data source attribute. |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_sourceTransactionId/mappings
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", "emailId": "john.smith@companyname.com" }, "orderNumber": 1, "id": 3023216482, "dataSourceAttribute": "/process/_all_commerce_process/_main_doc/_header/transactionID_t", "dataSourceLabel": "Quoting : All Processes", "dataSourceProviderVariableName": "_cm__all_commerce_process_main", "variableName": "transactionID_t", "attributeLabel": "Transaction Number", "validMapping": true, "dateModified": "2024-08-01T17:22:57Z", "dateAdded": "2024-08-01T17:22:57Z", "readOnly": true, "sourceEntity": "Header" } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_sourceTransactionId/mappings" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/_sourceTransactionId/mappings?offset=0&limit=1000" } ] }
Migrate Agreement Charge Attributes
|
Description |
Use this endpoint to create pricing agreement charge attributes from an existing price charge attribute.. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes/actions/createFromChargeAttributes |
|
|
Endpoint Parameters |
None | |
|
HTTP Method |
POST |
|
| Request Body Parameters |
An array of charge attribute items. |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/actions/createFromChargeAttributes
{ "items": ["_requestedAgreementNumber"] }
Update Agreement Attribute Mappings
|
Description |
Use this endpoint to update attribute mappings for the specified price agreement attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/agreementAttributes/{attributeVariableName}/mappings |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the pricing agreement attribute. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", "replace". |
|
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value. Refer to Get Agreement Attribute Mappings for parameters. |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/agreementAttributes/someAgreementAttribute/mappings
[{ "op": "replace", "path": "/3024593198", "value": { "orderNumber": 1 } }, { "op": "replace", "path": "/3024593232", "value": { "orderNumber": 2 } }, { "op": "add", "value": { "dataSourceProviderVariableName": "CONFIG_ATTRS_test1", "orderNumber": 3, "variableName": "arrayTextSSPL1" }, "path": "/" } ]
