All REST Endpoints
Assets
CPQ Cloud exposes asset data through REST APIs. Asset REST APIs support create, read, update, delete, and synchronize. They also provide import and export operations, and operations for external orders.
- Get All Assets
- Method: getPath:
/rest/v7/assets - Get an Asset
- Method: getPath:
/rest/v7/assets/{id} - Get Child Assets
- Method: getPath:
/rest/v7/assets/{id}/childAssets - Get Descendant Assets
- Method: getPath:
/rest/v7/assets/{id}/descendantAssets
Assets/Actions
These operations provide the ability to maintain CPQ assets through RESTful services. These endpoints provide access to actions to open, create, update, delete, and synchronize assets.
- Create an Asset
- Method: postPath:
/rest/v7/assets - Delete an Asset
- Method: deletePath:
/rest/v7/assets/{id} - Synchronize an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/synchronize - Synchronize Assets
- Method: postPath:
/rest/v7/assets/actions/synchronize - Update an Asset
- Method: postPath:
/rest/v7/assets/{id}
Assets/External Order Actions
These operations allow external systems to modify, terminate, suspend, resume, renew, reconfigure, and create follow-on orders for assets.
- Follow-On Order
- Method: postPath:
/rest/v7/configBomInstance/{configId}/actions/followOnOrder - Get Configuration BOM Instance
- Method: postPath:
/rest/v7/configBomInstance/{configId}/actions/getConfigBom - Modify an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/modify - Reconfigure
- Method: postPath:
/rest/v7/configBomInstance/{configId}/actions/reconfig - Renew an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/renew - Resume an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/resume - Suspend an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/suspend - Terminate an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/terminate
Assets/Import-Export Actions
Theses opertations provide the ability to export, import, and retrieve assets and asset log files.
- Export an Asset
- Method: postPath:
/rest/v7/assets/{id}/actions/export - Export Assets
- Method: postPath:
/rest/v7/assets/actions/export - Import Assets
- Method: postPath:
/rest/v7/assets/actions/import
Calculate Price
The Calculate Price REST API allows an external application to query CPQ Cloud for pricing information. CPQ Cloud executes contract rules and relevant profiles to calculate and return the final list price.
- Calculate Price
- Method: postPath:
/rest/v7/pricing/actions/calculatePrice
Commerce
CPQ Cloud exposes transactional objects and transaction data through REST APIs and RESTful standards. The REST APIs provide a new, modern way to access transaction and line item information. With appropriate HTTP Basic authentication, any other third-party system can make use of these services. Additional resources allow credentialed third-party systems to create transactions, and to update transactions by invoking modify, version, submit and approval actions in a Commerce Process through REST APIs.
- Get a Transaction
- Method: getPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id} - Get a Transaction Line
- Method: getPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber} - Get All Transaction Lines
- Method: getPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName} - Get All Transactions
- Method: getPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}
Commerce Administration
Transaction Administration services return CPQ transaction desktop layout definitions for UI frameworks to consume. The desktop layout definitions contain: layout parameters and properties for panels, tabs, columns, action strips, and transaction line grids; properties for actions and attributes; and translations for layout items. Metadata Services expose information about the definitions of the Commerce main document, sub document, actions, attributes, and translations.
- Get Document Layout
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/layouts/{mainDocVarName} - Get Document Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName} - Get Documents Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents
Commerce Administration/Actions
These services return the action metadata for the specified Commerce main document or sub document. The action metadata is comprised of: defined action properties that are defined on the Admin Action page; possible action states (i.e. visible or enabled); dependencies and possible states (if an action can be altered by a step or rule); and links to the current REST call, parent items, and translations.
- Get Action Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName} - Get Actions Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs
Commerce Administration/Array Sets
These services return the array set metadata for the specified Commerce document. The array set metadata is comprised of: defined attribute properties that are defined on the Attribute Editor page; possible attribute states, (updatable, required, visible, domain, messages, hasError, hasWarning, or hasContraintViolation); dependencies and possible states, if an attribute can be altered by a formula, step, or rule; and links to the current REST call, parent items, menu items, and translations.
- Get Array Set Attribute Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName} - Get Array Set Attributes Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes - Get Array Set Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName} - Get Array Sets Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets
Commerce Administration/Attributes
These services return the attribute metadata for the specified Commerce document. The attribute metadata is comprised of: defined attribute properties that are defined on the Attribute Editor page; possible attribute states, (updatable, required, visible, domain, messages, hasError, hasWarning, or hasContraintViolation); dependencies and possible states, if an attribute can be altered by a formula, step, or rule; and links to the current REST call, parent items, menu items, and translations.
- Get Attribute Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName} - Get Attributes Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes
Commerce Administration/Menu Items
These services return the menu item metadata for the specified attribute. The menu are returned as composite values containing menu properties and domain items. Links to the current REST call, parent items, and translations are also returned.
- Get Menu Item Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId} - Get Menu Items Metadata
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems
Commerce Administration/Translations
The translation services retrieve translations for actions, attributes, and menu items. Translations for all site-supported languages can be retrieved. If a translation is not defined, an empty string is returned for the requested value. The following fields are translatable: Actions (labels and descriptions), Attributes (labels, descriptions, and user defaults), and Menu Items (display values). When translations are requested, translations that have an empty value for all the properties are not returned. Translation data is returned if any of the property values are populated.
- Get Action Translation
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations/{languageCode} - Get Action Translations
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations - Get Attribute Translation
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations/{languageCode} - Get Attribute Translations
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations - Get Menu Item Translation
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations/{languageCode} - Get Menu Item Translations
- Method: getPath:
/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations
Commerce/Actions
Commerce Actions provide the ability to maintain CPQ Transaction documents through RESTful services. These endpoints provide access to actions to open, create, copy, delete, reconfigure, save, email, and print Transactions. They also provide services for currency management and cache interaction.
- Add Transaction Signature
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/signature_add - Auto-fill Accounts Information
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_auto_fill_action - Back from Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/back - Change Currency
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_change_currency - Copy Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_copy_transaction - Create a Transaction with Parts
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName} - Create Transaction Version
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/versionTransaction_t - Delete Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/deleteTransaction_t - Drop Cache
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_dropCache - eSignature - Cancel Request
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_action_esig_cancel - eSignature - Request Details
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_action_esig_details - eSignature - Send Request
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_action_esig_send - Export Attachment
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/exportAttachment - Interact for Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_interact - Open Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_open_transaction - Print Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_print_document - Reconfigure
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_reconfigure_action - Refresh Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/refresh - Retrieve Alternate Address
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_retrieve_alternate_address - Save Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/cleanSave_t - Save Transaction Version
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/versionSave_t - Select Alternate Address
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_select_alternate_address_action - Send Email for Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_send_email - Transaction Pipeline Viewer
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_pipelineViewer
Commerce/Actions/Document Generation
Commerce Document Generation Actions provide services to generate proposals, and document compare and merge features for Contract Negotiation.
- DOCX Compare
- Method: postPath:
/rest/v7/docxCompare - DOCX Merge
- Method: postPath:
/rest/v7/docxMerge - Generate Proposal
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/generateProposal
Commerce/Actions/Order Actions
Commerce Order Actions provide REST services for order fulfillment actions.
- Cancel Order
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_cancel - Change Order
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_change - Create Order
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_start - Fulfill Order
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_fulfill - Order Reject
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_reject - Place Alternate Order
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/order_alternate
Commerce/Actions/Submit Actions
Commerce Submit Actions provide access to Submit actions to request approval, reject, revise, and approve submitted Transactions.
- Approve Submitted Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/approve_submit_t - Reject Submitted Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/reject_submit_t - Request Approval
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/request_approval_submit_t - Revise Submitted Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/revise_submit_t - Submit Transaction for Approval
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/submit_t
Commerce/Sub Document Actions
Commerce Sub Document Actions provide the ability to maintain CPQ Transaction Line items through RESTful services. These endpoints provide access to actions to open, create, copy, delete, reconfigure, update, save, email and print Transaction Line items. They also provide services for navigation and cache interaction.
- Add Transaction Lines to a Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName} - Back From Transaction Line
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/back_l - Calculate Transaction Line Price
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/_calculate_price_action - Copy Transaction Lines
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/copyLineItems_t - Create Transaction Line
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/addLineItem_t - Delete a Transaction Line
- Method: deletePath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber} - Delete Transaction Line(s) from Transaction
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_remove_transactionLine - Export Attachment
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/subDocExportAttachment - Open Transaction Line
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_open_transactionLine - Reconfigure
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/_reconfigure_action - Refresh Transaction Line
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/refreshSubDoc - Transaction Line Pipeline Viewer
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/{subDocVarName}/{subDocNumber}/actions/_pipelineViewer - Update Transaction Lines
- Method: postPath:
/rest/v7/commerceDocuments{ProcessVarName}{MainDocVarName}/{_id}/actions/_update_line_items
Configuration Run-Time Data Services
The Configuration Run-Time Data endpoints expose information and perform an action for a model. All Configuration Run-Time Data REST APIs follow a required product hierarchy starting with the product family then product line followed by the model. A variable name for the product entity is required. For example, /config{prodFamVarName}.(prodLineVarName}.{modelVarName}/ is the standard Configuration Run-Time Data product path for an endpoint URL.
- Add From Catalog
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_addFromCatalog - Add Row to Array Set
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_set_arraySetVarName/actions/_add - Add To Transaction
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_addToTxn - Cancel
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_cancel - Configuration Integration
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_integration_integratedCart - Configure a Model
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_configure - Delete Row from an Array
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_set_arraySetVarName/actions/_delete - Drop Cache
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_dropCache - Get All Pick Lists Options
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_pickLists/actions/getOptions - Get BOM Items
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_bom/actions/getBomItems - Get Mandatory Models
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_mandatoryModels/actions/getMandatoryModels - Get Mandatory Parts
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_mandatoryParts/actions/getMandatoryParts - Get PickList Options
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_pickLists/pickListVarName/actions/getOptions - Get Price Books
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_priceBooks/actions/getPriceBooks - Get Recommended Models
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_recmdModels/actions/getRecmdModels - Get Recommended Parts
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_recmdParts/actions/getRecmdParts - Interact
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_interact - Next
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_next - Previous
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_previous - Process Invocation Action
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_cm_invocationID - Reconfigure a Model
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_reconfigureTxn - Reconfigure a Model from Partner
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_reconfigureClient - Resume Configuration
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_resumeConfig - Save
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_save - Start Over
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_startOver - Update
- Method: postPath:
/rest/v7/prodFamVarName.prodLineVarName.modelVarName/actions/_update
Data Table
The custom{DataTable} REST API allows an external system to access deployed data in CPQ Cloud Data Tables. When executed correctly, the external system will receive the CPQ Cloud Data Table's deployed data in the REST response body. NOTE: Currently only Read operations are supported when interacting with the custom{DataTable} API.
- Get Data Table
- Method: getPath:
/rest/v7/custom{DataTable} - Get Data Table Record
- Method: getPath:
/rest/v7/custom{DataTable}/{id}
Eligibility Rules
CPQ Cloud exposes eligibility data through REST APIs. As described in this section, Eligibility APIs allow external applications to create, read, update, delete, and deploy eligibility data.
- Create Eligibility Rule
- Method: postPath:
/rest/v7/eligibilityRule - Delete Eligibility Rule
- Method: deletePath:
/rest/v7/eligibilityRule/{id} - Delete Eligibility Rule
- Method: postPath:
/rest/v7/eligibilityRule/{id}/actions/delete - Deploy Eligibility Rule
- Method: postPath:
/rest/v7/eligibilityRule/{id}/actions/deploy - Deploy Multiple Eligibility Rules
- Method: postPath:
/rest/v7/eligibilityRule/actions/deploy - Get All Eligibility Rules
- Method: getPath:
/rest/v7/eligibilityRule - Get Eligibility Rule
- Method: getPath:
/rest/v7/eligibilityRule/{id} - Update Eligibility Rule
- Method: postPath:
/rest/v7/eligibilityRule/{id}
Eligibility Rules/Conditions and Selections
These operations retrive conditions and selections for Eligibility Rules.
- Get All Eligibility Rule Conditions
- Method: getPath:
/rest/v7/eligibilityRule/{id}/condition - Get All Eligibility Rule Selections
- Method: getPath:
/rest/v7/eligibilityRule/{id}/selection - Get Eligibility Rule Condition
- Method: getPath:
/rest/v7/eligibilityRule/{id}/condition/{ruleConditionIndex} - Get Eligibility Rule Selection
- Method: getPath:
/rest/v7/eligibilityRule/{id}/selection/{ruleSelectionIndex}
External Configurator
This REST API provides support for the External Configurator Integration. The REST service invokes the External Configurator Advanced Save function to create a transaction, Add from Catalog, or Reconfigure.
- External Configurator
- Method: postPath:
/rest/v7/productFamilies/{pfVar}/productLines/{plVar}/models/{modelVar}/actions/_externalConfigurationSave
Generate Document
The Document Generator REST APIs allow an external system to send a REST call to generate a document using a Document Designer template and retrieve generated documents.
- Generate Document
- Method: postPath:
/rest/v7/documentGenerator - Get Generated Document
- Method: getPath:
/rest/v7/documentGenerator/{id} - Get Generated Documents List
- Method: getPath:
/rest/v7/documentGenerator
Generate Email
The REST APIs enable an external entity to use an existing Email Designer template and generate an html email for a given transaction. The API allows POST with the Transaction ID and appropriate Email Designer template details, to create the output email.
- Generate Email Document
- Method: postPath:
/rest/v7/emailGenerator - Get Generated Email Document
- Method: getPath:
/rest/v7/emailGenerator/{id} - Get Generated Email Documents List
- Method: getPath:
/rest/v7/emailGenerator
Performance Logs
The REST API enables retrieving data about a sales user's activities and observed performance or other metrics during their interaction with the application. The information also provides application time as well as category information which can be used by customers to build their benchmark monitoring systems and proactively tackle any performance issues.
- Get All Performance Log Events
- Method: getPath:
/rest/v7/performanceLogs - Get Performance Log Event
- Method: getPath:
/rest/v7/performanceLogs/{id}
Performance Logs/Export
Theses opertations provide the ability to export Performance Log events.
- Export Performance Log Event
- Method: postPath:
/rest/v7/performanceLogs/{id}/actions/export - Export Performance Log Events
- Method: postPath:
/rest/v7/performanceLogs/actions/export
PriceBooks
These actions retrieve the list of price books or the specified price book.
- Get All Price Books
- Method: getPath:
/rest/v7/priceBooks - Get Price Book
- Method: getPath:
/rest/v7/priceBooks/{variableName} - Get Price Book Translation
- Method: getPath:
/rest/v7/priceBooks/{variableName}/translations
Search Parts
The Search Parts REST API supports customizing the REST response by specifying an advanced query object (i.e. 'q' criteria) as a request body parameter. This allows administrators to customize the query by specifying various combinations of criteria.
- Search Parts
- Method: postPath:
/rest/v7/parts/actions/search
User Management
CPQ Cloud customers can leverage identity management solutions such as Oracle Identity Cloud Service (IDCS) to simplify the administration of users and passwords. CPQ Cloud's integration features simplify the implementation of identity services for Enterprise customers by allowing customers to delegate user management activities such as user creation, activation, revocation, and password management for host company users to IDCS or other Identity Service providers.
- Create User
- Method: postPath:
/rest/v7/companies/{companyName}/users - Get User Details
- Method: getPath:
/rest/v7/companies/{companyName}/users/{userName} - Replace User Details
- Method: putPath:
/rest/v7/companies/{companyName}/users/{userName} - Reset User Password
- Method: postPath:
/rest/v7/companies/{companyName}/users/{userName}/actions/resetPassword - Update User
- Method: patchPath:
/rest/v7/companies/{companyName}/users/{userName}