The get_master_data_fields tool lists the columns of one Master Data table (Customers, Products, Sellers, or Product Competition) and the data type of each column. Use the column names in the Master Data Query Data tool. The get_master_data_fields tool does not read any rows.
Tool Name – get_master_data_fields
Title – Get Master Data Fields
Type – Private
Access Profile – Operator
Permissions
The tool is available to the Operator access profile when tool access control is on. The get_master_data_fields tool uses your Pricefx permissions and lists only the columns that you have permission to query.
Parameters
|
Parameter |
Required |
Description |
|---|---|---|
|
|
Yes |
The Master Data table to describe: customers (Customers), products (Products), sellers (Sellers), or productCompetitions (Product Competition). |
|
|
No |
Text to narrow the list of columns, for example id. The tool returns the columns whose name contains this text. The comparison ignores case. Default: Empty, which lists every column of the table. |
Output
The get_master_data_fields tool returns an object with the following fields.
|
Field |
Description |
|---|---|
|
|
The Master Data table that was described, for example customers. |
|
|
The business name of the table: Customer Master, Product Master, Seller Master, or Product Competition. |
|
|
The number of columns returned. When |
|
|
The returned columns. Each column is an object: |
Behavior and Limitations
-
The
get_master_data_fieldstool describes one Master Data table per call and reads no rows. -
A configured attribute appears under its label, for example Customer Id. An attribute without a label appears under its system name, for example attribute3.
-
Column names can contain spaces. Use each name in the
master_data_query_datatool exactly as theget_master_data_fieldstool returns it. -
The
filterparameter matches the column name only. -
The tool describes Customers, Products, Sellers, and Product Competition only. To list the columns of a Datamart, use the
get_data_source_fieldstool.
Errors
|
Situation |
Error Message |
|---|---|
|
|
|
|
Pricefx rejects the request |
The error message from Pricefx. |