Metadata
List Entity Fields
Retrieves information (data type, maximum length, possible values, whether the field is required, etc.) about fields of the specified entity.
post/metadata.describe/{TypeCode}
Request
- Base URLhttps://companynode.pricefx.com/pricefx/companypartition
- Auth
- HTTP basic
- or API key in header X-PriceFx-jwt
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
namestring
The name of the PX or CX category.
lookupTableIdstring
The ID of the Company Parameters table when retrieving MLTV (MatrixLookupTableValue).
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.