API Reference › core-common› Annotation › FieldPropertyPath

FieldPropertyPath Interface

A chain of property accesses that resolves to a primitive value that forms the basis of the displayed content of a FieldRun.

  • The simplest property paths consist of a propertyName and nothing else, where propertyName identifies
  • a primitive property.
  • If propertyName identifies a struct or array property, then additional accessors are required to identify the specific value.
  • If propertyName (including any accessors) resolves to a JSON property, then additional jsonAccessors are required to identify a specific value within the JSON.
  • Some examples:
  • | Access String | propertyName | accessors | jsonAccessors |
  • | ------------- | ------------ | --------- | ------------- |
  • | name | "name" | undefined | undefined |
  • | spouse.name | "spouse" | [name] | undefined |
  • | colors[2] | "colors" | [2] | undefined |
  • | spouse.favoriteRestaurants[1].address | "spouse" | ["favoriteRestaurants", 1, "address"] | undefined |
  • | jsonProperties.contactInfo.email | "jsonProperties" | undefined | ["contactInfo", "email"] |
  • | spouse.jsonProperties.contactInfo.phoneNumbers[0].areaCode | "spouse" | ["jsonProperties"] | ["contactInfo", "phoneNumbers", 0, "areaCode"] |

Properties

Name Type Description
accessors string | number[] | undefined Property names and/or array indices describing the path from propertyName to the ultimate BIS property.  
jsonAccessors string | number[] | undefined If propertyName and accessors (if defined) resolve to a BIS property of extended type Json, property names and/or  
propertyName string The name of the BIS property of the FieldPropertyHost that serves as the root of the path.  

Defined in

Last Updated: 29 July, 2025