relatedRecordsInfo | Web Map Specification

Applicable only when popupInfo contains a relationship content element. This is needed for backward compatibility for some web maps.

Referenced by: popupInfo

Properties

Property	Details
orderByFields[]	Array of orderByField objects indicating the field display order for the related records, and whether they should be sorted in ascending `‘asc’` or descending `‘desc’` order.
showRelatedRecords	Required boolean value indicating whether to display related records. If `true`, client should let the user navigate to the related records. Defaults to `true` if the layer participates in a relationship AND the related layer/table has already been added to the map (either as an operationalLayer or as a table).

relatedRecordsInfo Example

{
  "relatedRecordsInfo": {
    "showRelatedRecords": true,
    "orderByFields": [
      {
        "field": "relationships/0/FieldName",
        "order": "asc"
      }
    ]
  }
}