The get_data_source_fields tool returns field-level metadata for a Data Source or Datamart on a Pricefx partition.
The get_data_source_fields tool has been deprecated in MCP Server CD6 Iteration 6.
Tool Name – get_data_source_fields
Title – Get Data Source Fields
Type – Private
Access Profile – Operator
Permissions
The get_data_source_fields tool uses your Pricefx permissions. The tool returns only the fields that you have permission to query. If you do not have access to the Datamart or Data Source, the tool returns the same error as for a Datamart or Data Source that does not exist.
Parameters
|
Parameter |
Required |
Description |
|---|---|---|
|
|
Yes |
Technical name of the Datamart or Data Source, for example Standard_Sales_Data. Get the exact name from the List Data Sources tool. Leading and trailing spaces are removed. |
|
|
Yes |
DATAMART or DATASOURCE, as the List Data Sources tool returns it. Not case-sensitive. |
|
|
No |
Text that the field name or field label contains, for example price. The search is not case-sensitive. The default is no filter, which lists every field. |
The type parameter is required because a Datamart and a Data Source can have the same name, with different fields. The tool does not detect or correct the type, and it does not try the other type.The type parameter must match the requested object. The tool does not automatically detect or correct an incorrect type.
Output
The get_data_source_fields tool returns:
|
Field |
Description |
|---|---|
|
|
Technical name of the Datamart or Data Source. |
|
|
DATAMART or DATASOURCE. |
|
|
Number of returned fields. The tool returns every matching field. |
|
|
List of fields. |
Each entry in fields has:
|
Attribute |
Description |
|---|---|
|
|
Technical field name. Use this name in queries. |
|
|
Display label. If no label is set, the tool shows the technical name. |
|
|
Field type, for example TEXT, NUMBER, MONEY, QUANTITY, DATE, or BOOLEAN. Other values are possible. |
|
|
Display format. Empty when no format is set. |
|
|
true if the field is a dimension. |
|
|
true if the field is numeric and not a dimension. |
|
|
true if the field type is DATE or DATETIME. |
|
|
Formula of a calculated field. Empty for other fields. |
|
|
Business description of the field. Empty when no description is set, which is common. |
Behavior and Limitations
-
The tool lists the fields in the order Pricefx returns them.
-
The tool returns all matching fields in one response, with no limit.
-
If nothing matches the filter, the tool returns an empty list, not an error.
-
The tool returns field metadata only, not data. To read the data, use the Datamart Query Data tool.
-
The tool requires Pricefx version 16.3.16 or later.
Errors
|
Situation |
Error Message |
|---|---|
|
|
|
|
The Datamart or Data Source does not exist, you do not have access to it, or |
|
|
The Datamart or Data Source exists but Pricefx reports no fields for it |
|