Performance Debugger REST API

Overview

The Performance Debugger REST API enables customers to collect granular performance logs for Configuration actions, including the timing for associated rules and conditions.

Administration

ClosedCreate a Performance Debugger Log

Create a Performance Debugger Log POST method
Description

Use this endpoint to create a performance debugger log for the Configuration action identified in the request payload.

URI Endpoint

/rest/v18/performanceDebugger/actions/createLog
Endpoint Parameters

None
HTTP Method POST
Request Body Parameters

actionName

The variable name of the action to performance profile.

Note: Oracle CPQ 25B supports the following actions:

  • CONFIG_ADD_TO_TXN Add to an Existing Transaction

  • CONFIG_ADD_TO_CART Add to Cart

  • CONFIG_CONFIGURE Configure

  • CONFIG_INVOKE Create a New Transaction from Configuration (i.e. Invocation)

  • CONFIG_RECONFIGURE Reconfigure (Inbound)

  • CONFIG_CONFIG_SAVE_AFTER_RECONFIGURE Reconfigure and Save

  • CONFIG_UPDATE Update Configuration

bsId

ID of a transaction used as a configuration source (for reconfigure) or an invocation target (for add to transaction)

description

The description for the performance debugger log.

documentNumber

Document Number for a model line on the specified transaction to be used as a data source (for reconfigure)

favoriteId

The favorite Id to be used as input data.

Note: You can create a Favorite, and go to that Favorite to extract the favorite id. For example, http://sitename.oracle.com/commerce/favorites/detail/3023244929

In this URL the favoriteId is: 3023244929

headlessMode

This property determines the API execution behavior. When false, API execution mimics the legacy UI behavior. When true, executes in UI agnostic mode. The default value is false.

invocationId

ID of a process invocation to be used for invocation

model

The variable name of the model.

productFamily

 The variable name of the product family.

productLine

The variable name of the product line.
 

Note: You can retrieve the Product Family, Product Line, and Model variable names from the product configurator URL. For example, http://sitename.oracle.com/config/visionVehicles/consumerVehicles/sUV?product_line=consumerVehicles&segment=visionVehicles&_from_punchin=true&model=sUV&_has_jet_access=true

In this URL the configuration variable names are:

  • Product Family: visionVehicles
  • Product Line: consumerVehicles
  • Model: sUV
Error Responses

id

The unique identifier for the debugger logging task.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/performanceDebugger/actions/createLog

ClosedRequest Body Sample - Add to an Existing Transaction

{ "actionName": "CONFIG_ADD_TO_TXN" , "favoriteId": 3023525714, "bsid" : 3023337829 }

ClosedRequest Body Sample - Add to Cart

{ "actionName": "CONFIG_ADD_TO_CART", "favoriteId": 3023525714, "invocationId": 6993047 }

ClosedRequest Body Sample - Configure

{ "actionName": "CONFIG_CONFIGURE", "description": "CONFIGURE: Vision Vehicles SUV", "productFamily": "visionVehicles", "productLine": "consumerVehicles", "model": "sUV" }

ClosedRequest Body Sample - Create a New Transaction from Configuration (i.e. Invocation)

{ "favoriteId": 3023525714, "invocationId": 12068225, "actionName": "CONFIG_INVOKE" }

ClosedRequest Body Sample - Reconfigure (Inbound)

{ "bsId": 12068225, "documentNumber": 2, "actionName": "CONFIG_RECONFIGURE" }

ClosedRequest Body Sample - Reconfigure and Save

{ "actionName": "CONFIG_SAVE_AFTER_RECONFIGURE", "bsid" : 3023337829, "documentNumber": 2 }

ClosedRequest Body Sample - Update

{ "description": "This is a test payload", "favoriteId": 18350193, "actionName": "CONFIG_UPDATE" }

ClosedResponse Body Sample

{ "id": "3023221367"
}

ClosedGet All Performance Debugger Records

Get a Performance Debugger Record GET Method
Description

Use this endpoint to retrieve a list of performance debugger log records
URI Endpoint

/rest/v18/performanceDebugger
Endpoint Query Parameters

This endpoint supports the following optional parameters: fields, limit, offset, orderby, q, and totalResults.
Refer to Manage Collections for additional information.
HTTP Method(s)

GET

Request Body Parameters

None

Response Body Parameters

action

Which action this log tests

description

 Description for this performance log

error

 Error message if the log execution failed

id

 Primary Key of the resource

referenceLabel

 Describes the subject of this performance log

status

 Whether the log is in progress, finished successfully or has failed.

time

 Total time that the action took to finished executed

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/performanceDebugger

ClosedResponse Body Sample

{ "hasMore": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com.com/rest/v18/performanceDebugger" } ], "items": [{ "referenceLabel": "test1:productLine1:model1", "description": "configure output test", "error": null, "action": { "lookupCode": "CONFIG_CONFIGURE", "displayValue": "Configuration Configure", "id": 3023215310, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215310" } ] }, "id": 3023234038, "time": 141, "status": { "lookupCode": "COMPLETED_SUCCESS", "displayValue": "Completed Successfully", "id": 3023215314, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215314" } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com.com/rest/v18/performanceDebugger/3023234038" } ] }, { "referenceLabel": "testbed:systemConfiguration:rootSystem", "description": "configure output test", "error": null, "action": { "lookupCode": "CONFIG_UPDATE", "displayValue": "Configuration Update", "id": 3023215311, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215311" } ] }, "id": 3023233987, "time": 783, "status": { "lookupCode": "COMPLETED_SUCCESS", "displayValue": "Completed Successfully", "id": 3023215314, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215314" } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com.com/rest/v18/performanceDebugger/3023233987" } ] }, { "referenceLabel": "test1:productLine1:model1", "description": "configure output test", "error": null, "action": { "lookupCode": "CONFIG_UPDATE", "displayValue": "Configuration Update", "id": 3023215311, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com//rest/v18/lookupValues/3023215311" } ] }, "id": 3023234032, "time": 121, "status": { "lookupCode": "COMPLETED_SUCCESS", "displayValue": "Completed Successfully", "id": 3023215314, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215314" } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com.com/rest/v18/performanceDebugger/3023234032" } ] } ] }

ClosedGet a Performance Debugger Record

Get a Performance Debugger Record GET Method
Description

Use this endpoint to retrieve the specified performance debugger log record.
URI Endpoint

/rest/v18/performanceDebugger/{id}

Endpoint Parameters

id

Primary Key of the resource
HTTP Method(s)

GET

Request Body Parameters

None

Response Body Parameters

action

Which action this log tests

description

 Description for this performance log

error

 Error message if the log execution failed

id

 Primary Key of the resource

referenceLabel

 Describes the subject of this performance log

status

 Whether the log is in progress, finished successfully or has failed.

time

 Total time that the action took to finished executed

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/performanceDebugger/3023221513

ClosedResponse Body Sample

{ "referenceLabel": "testbed:systemConfiguration:rootSystem", "description": null, "error": null, "action": { "lookupCode": "CONFIG_UPDATE", "displayValue": "Configuration Update", "id": 3023215311, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PERFORMANCE_DEBUGGER_ACTION%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215311" } ] }, "id": 3023221513, "time": 1683, "status": { "lookupCode": "COMPLETED_SUCCESS", "displayValue": "Completed Successfully", "id": 3023215314, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PEFORMANCE_DEBUGGER_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com.com/rest/v18/lookupValues/3023215314" } ] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com.com/rest/v18/performanceDebugger/3023221513" } ] }

 

Related Topics

Related Topics Link IconSee Also