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 - entityRelatedEntityInfoType

Description

This type defines properties of a related entity

Properties

Name Type Occurrence Description
dynamicRelatedEntities Array<entityDynamicRelatedEntityType> Optional Fields for DynamicOneToOne reference type
dynamicValueColumn xs:string Optional Fields for DynamicOneToOne reference type
entityName xs:string Required The name of the entity
foreignKey xs:string Required The name of the column in the primary (referencing) table that identifies record(s) in the related entity. To clarify this see here http://en.wikipedia.org/wiki/Foreign_key for more detail
leftColumnName xs:string Optional Fields for SelfManyToMany reference type
linkingTableName xs:string Optional Fields for SelfManyToMany reference type
managed xs:boolean Optional
Default=false
Indicates that the related record is managed by this entity. If set to ‘true’ then the related record will be deleted when the primary record is deleted
mandatory xs:boolean Optional
Default=false
Indicates that the related record is mandatory when creating a primary record. In other words, when a primary record is being added/edited any relationships ManyToOne must exist
mappedValue Array<entityMappedValueType> Optional Mapped/copy values from the related table back to the primary entity table
referenceKey xs:string Required The name of the column on the related (referenced) entity that is used to identify it’s relationship with the primary entity
relatedEntity xs:string Required The entity that is related to the primary entity
relationshipName xs:string Required The unique name within the primary entity of this specific relationship
relationshipType entityRelationshipType Required The type of relationship this entity has with the primary entity
rightColumnName xs:string Optional Fields for SelfManyToMany reference type
In This Document