Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Complex Types - relatedEntityQueryDatasetType

Description

The name of the relationship this data set relates to.

Properties

Name Type Occurrence Description
entity simpleIdType Required The name of the entity this data set relates to.
entityType entityRelationshipType Optional The type of entity this data set relates to.
foreignKey simpleIdType Optional The name of the column in the primary entity that references this entity.
meta databaseMetaDataType Optional The meta data that describes this entity table.
record propListType Required
Array (1/∞)
The data returned from the entity record. For each column in the table there will be an element by the same name that contains the value of that column. The following example shows the expected structure.
 <record>   <column_1>Value for column 1</column_1>   <column_2>Value for column 1</column_2>   … </record> 
recordDataSource recordDataSourceType Required The record source type
referenceKey simpleIdType Optional The name of the column in this related entity that is referenced by the primary entity.
relationshipName nameType Required The name of the relationship this data set relates to.
In This Document