Skip to main content


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

getDefaultColumns(payload)

Updated on July 20, 2021

Retrieves the default columns for a table displaying case data.

Returns

A Promise that resolves to a response containing information for the default columns.

Parameters

NameTypeDescriptionRequired
payloadobjectAn object that specifies the report to retrieve the columns to be used as the default fields of a data entity.

The following table contains the properties of the payload object:

NameTypeDescriptionRequired
reportNamestringThe name of the report in which the default columns are configured.
classNamestringThe class of the report in which the default columns are configured.

Usage example

In this example, the API returns a Promise that resolves to a response containing information for the default columns.

const payload = { className: "OZ1CUU-MyApp-Work-MyCase", reportName: "DataTableEditorReport" };
PCore.getAnalyticsUtils().getDefaultColumns(payload).then(response => { console.log(response.data); }).catch(() => { ... });
// console output: [{ pyFieldName: "pzInsKey" }, { pyFieldName: "pyID" }, { pyFieldName: "columnName" } ]
  • Previous topic getDataViewMetadata(dataViewName, skipStoreCheck)
  • Next topic getFieldsForDataSource(dataViewName, skipStoreCheck)

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