REST Expanders FAQ

What are the requirements for my functional key?

A functional key (defined with the functionalKey option) must consist out of exactly one fieldFieldA property of a DataElement expanded to a database column and user interface input element. of type String, which has at least the options isUnique and exposeRestField.

Is nameNotWanted supported?

Yes, the option nameNotWanted is supported by rest-expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact.. When this option is enabled on a DataElement for which REST endpoints are expanded, the name fieldFieldA property of a DataElement expanded to a database column and user interface input element. will be omitted from all models used in the API, as well as references to that element.

Why does the SortFieldMapper class just map fields to the same name?

It doesn't always do that. We want the name of the fieldsFieldA property of a DataElement expanded to a database column and user interface input element. listed for sorting in the API to be the same as the name in the resource objects that are handled by the API, not the same as they are in the model of the DataElement. When the option exposeRestField is used, the name of the fieldFieldA property of a DataElement expanded to a database column and user interface input element. will almost always be the same in the DataElement as it is when exposed through the API, as it is a one-to-one mapping. The only exceptions are fieldsFieldA property of a DataElement expanded to a database column and user interface input element. marked with the options audit.create.timestamp and audit.modify.timestamp, which are translated by the expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact. to created and lastModified respectively, which will therefore be mapped differently by the SortFieldMapper class.