Get Data Source Fields

The get_data_source_fields tool returns field-level metadata for a Data Source or Datamart on a Pricefx partition.

  • Tool Name – get_data_source_fields

  • Title – Get Data Source Fields

  • Type – Private

Parameters

Parameter

Description

name

The technical name of the Data Source or Datamart for which to retrieve field metadata.

type

The object type. Data Source (DS) or Datamart (DM). This parameter is mandatory.

The type parameter must match the requested object. The tool does not automatically detect or correct an incorrect type.

Output

The tool returns a table with one row per field.

Example

Name

Label

Type

Dimension

ProductId

Product Id

TEXT

Yes

ProductName

Product Name

TEXT

No

unitOfMeasure

UnitOfMeasure

TEXT

No

currency

Currency

TEXT

No

formulaName

FormulaName

TEXT

No

image

Image

BOOLEAN

No

isDeleted

IsDeleted

BOOLEAN

No

lastUpdateDate

LastUpdateDate

DATETIME

No

BaseQty

Base Qty

NUMBER

No

BaseUoM

Base UoM

TEXT

No

BusinessUnit

Business Unit

TEXT

No

Competitiveness

Competitiveness

TEXT

No

EAN

EAN

TEXT

No

Industry

Industry

TEXT

No

ProductGroup

Product Group

TEXT

No

ProductImage

Product Image

TEXT

No

ProductLine

Product Line

TEXT

No

SubProductGroupSubCategory

Sub Product Group / Sub Category

TEXT

No

PackagingType

Packaging Type

TEXT

No

ProductType

Product Type

TEXT

No

ManufacturingType

Manufacturing Type

NUMBER

No

DemoVertical

Demo Vertical

TEXT

No

SpecificationConfigProduct

Specification Config Product

TEXT

No

SFDCProduct

SFDC Product

TEXT

No

23 fields total, with ProductId marked as the Dimension (key) column.

See Also