Overview
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.
Administration
The endpoint for each REST API appends onto https://{siteurl}, where {siteurl} is the base URL of the Oracle CPQ site.
Get Performance LogGet Performance Log  |
|
|---|---|
| Description |
API used for getting performance logs data. |
| URI Endpoint |
/rest/v17/performanceLogs |
|
Endpoint Parameters |
Query specifications that follow Oracle CPQ query and pagination parameters syntax, and query specifications that follow a subset of MongoDB syntax can organize or narrow return data. For more information, see Manage Collections. |
| HTTP Method(s) |
GET |
|
Request Body Parameters |
None |
|
Response Body Parameters |
JSON data of the Performance Log Items |
{ "items": [{ "eventDate": "2016-02-23 19:09:44.0", "transactionId": null, "browserVersion": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36", "requestId": "c0733238-7904-4170-aa17-e66ed4cf606a", "referenceObject": "Login", "modifiedDate": "2016-02-23 00:00:00.0", "url": "https://sitename.oracle.com:80/commerce/display_company_profile.jsp", "id": "707", "applicationVersion": "15.2.0", "node": "node1", "component": "jdoe", "sessionId": "PGKxWMnSbFnR9VXGF2CSWBJ0JGpfyyp2xCSmzR3phDNBhxs7fRyz!-2116935037!1456254578753", "event": "Login", "serverTime": "22", "login": "<none>", "browserTime": null, "createdDate": "2016-02-23 00:00:00.0", "ipAddress": "0:0:0:0:0:0:0:1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/performanceLogs/707" } ] }, { "eventDate": "2016-02-23 19:09:56.0", "transactionId": null, "browserVersion": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36", "requestId": "7c94952e-df28-433a-9113-ea7b1852b8e5", "referenceObject": "Login", "modifiedDate": "2016-02-23 00:00:00.0", "url": "https://sitename.oracle.com:80/commerce/display_company_profile.jsp", "id": "710", "applicationVersion": "15.2.0", "node": "node1", "component": "jdoe", "sessionId": "ttcZWMnpcSb04BXYn1f7hsqQLRxdkNLLnVxdnCbSLmhQLK4sBnyV!-2116935037!1456254590423", "event": "Login", "serverTime": "8", "login": "<none>", "browserTime": "940", "createdDate": "2016-02-23 00:00:00.0", "ipAddress": "0:0:0:0:0:0:0:1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/performanceLogs/710" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/performanceLogs" } ] }
{ "eventDate": "2016-02-23 19:09:44.0", "transactionId": null, "browserVersion": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36", "requestId": "c0733238-7904-4170-aa17-e66ed4cf606a", "referenceObject": "Login", "modifiedDate": "2016-02-23 00:00:00.0", "url": "https://sitename.oracle.com:80/commerce/display_company_profile.jsp", "id": "707", "applicationVersion": "15.2.0", "node": "node1", "component": "jdoe", "sessionId": "PGKxWMnSbFnR9VXGF2CSWBJ0JGpfyyp2xCSmzR3phDNBhxs7fRyz!-2116935037!1456254578753", "event": "Login", "serverTime": "22", "login": "<none>", "browserTime": null, "createdDate": "2016-02-23 00:00:00.0", "ipAddress": "0:0:0:0:0:0:0:1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/performanceLogs/707" } ] }
Additional Information
Oracle CPQ uses HTTP Basic authentication to authenticate REST calls from third-party systems. When making a call to an Oracle CPQ REST API, the third-party system’s REST client must have encrypted Oracle CPQ login credentials in the Header and an Accept Header that both adhere to HTTP Basic authentication standards. The Accept Header must be set to application/schema+json to see the detailed schema of the resource. For more information see the topic Supported REST Headers.
