Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

updateInsight(insightID, insightObject)

Updated on July 20, 2021

Updates an existing insight.

Returns

A Promise that resolves to a response containing the top-level information for the updated insight.

Parameters

NameTypeDescriptionRequired
insightIDstringThe unique ID of the insight to be updated.
insightObjectobjectThe metadata to be stored in the insight.

Usage example

In this example, the API updates an existing insight and returns a Promise that resolves to a response containing the top-level information for the updated insight.

const insightID = "124e9385-a623-4c55-ba8e-5af8cbd0ae64";
const insightObject = {
  pyContent: "[stringified insight metadata json]",
  pyName: "Insight Name",
  pyPermissions: [{
    pyAccessCategory: "Rule-Access-Role-Name",
    pyAccessType: "view", // or "edit"
    pyAccessValue: "TestApp:Users"
  }]
};
PCore.getAnalyticsUtils().updateInsight(insightID, insightObject).then(response => { console.log(response.data); }).catch(() => { ... });
// console output: {
//   pyID: "124e9385-a623-4c55-ba8e-5af8cbd0ae64",
//   pyName: "Insight Name",
//   pyCreateDateTime: "20200630T183653.784 GMT",
//   pyCreateOperator: "[email protected]",
//   pyUpdateDateTime: "20200630T183656.330 GMT",
//   pxObjClass: "PegaBI-API-Insight"
// }

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us