Layout & Metadata REST Endpoints

Sort by

Task Path Method

Commerce/Layout & Metadata

Transaction Administration services return CPQ transaction desktop layout definitions and Commerce document metadata. 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 Action Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}

Get Action Translation

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations/{languageCode}

Get Action Translations

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs/{actionVarName}/translations

Get Actions Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/actionDefs

Get Array Set Attribute Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes/{attributeVarName}

Get Array Set Attributes Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}/attributes

Get Array Set Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets/{arraySetVarName}

Get Array Sets Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets

Get Attribute Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}

Get Attribute Translation

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations/{languageCode}

Get Attribute Translations

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/translations

Get Attributes Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes

Get Document Layout

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/layouts/{mainDocVarName}

Get Document Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}

Get Documents Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents

Get Menu Item Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}

Get Menu Item Translation

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations/{languageCode}

Get Menu Item Translations

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems/{menuItemId}/translations

Get Menu Items Metadata

Method: get

Path: /rest/v19/commerceProcesses/{processVarName}/documents/{docVarName}/attributes/{attributeVarName}/menuItems