Relationship

Field NULL Description Note
joinConnectionId
string (GUID)
Y The id of the connection containing the relationship  
foreignConnectionId
string (GUID)
Y The id of the connection of the query source referenced by the relationship  
joinQuerySourceAlias
string
  The alias of the query source containing the relationship  
foreignQuerySourceAlias
string
  The alias of the query source referenced by the relationship  
joinFieldAlias
string
  The alias of the join field  
specifictJoinFieldAlias
string
  The alias to be used in query without generating a new one  
foreignFieldAlias
string
  The alias of the foreign field  
specifictForeignFieldAlias
string
  The alias to be used in query without generating a new one  
alias
string
  The alias of the join query soure in relationship  
systemRelationship
boolean
  Is this relationship from physical database (cannot be deleted)  
joinType
string
  Either ‘Inner’, ‘Left’, ‘Right’, ‘Full’ or ‘Cross’  
parentRelationshipId
string (GUID)
Y The id of the parent relationship - in case this is cloned from a physical relationship  
position
string
  Place-holder  
relationshipPosition
integer
  The ordinal position of this relationship inside a list of relationships  
relationshipKeyJoins
array of objects
  An array of RelationshipKeyJoin objects  
reportId
string (GUID)
Y The id of the parent report, in case this is a relationship in a report  
foreignAlias
string
  The foreign alias  
joinQuerySourceUniqueName
string
  Unique name for join query source  
joinFieldUniqueName
string
  Unique name for join field  
foreignQuerySourceUniqueName
string
  Unique name for foreign query source  
foreignFieldUniqueName
string
  Unique name for foreign field  
tempId
string
  The temporary id  
aliasTempId
string
  Place-holder  
originalId
string (GUID)
  The original id of the relationship - in case this is cloned from a physical relationship  
isForeignDataObjectAlias
boolean
  Whether this instance is foreign data object alias  
selectedForeignAlias
string
  <foreignQuerySourceId>_[<foreignAlias>|<foreignQuerySourceName>]  

hasBeenModified
boolean

New in version 2.11.0.

  Whether the relationship has been modified or not  

positionId
int

New in version 2.16.0.

  The order of relationships when executing the query  

invalid
boolean

New in version 2.16.0.

Y Whether the relationship is valid or not Use when validating invalid relationship(s) in Data Model > Relationships

errors
array of models/ModelError

New in version 2.16.0.

Y The list of all the relationship errors Use when validating invalid relationship(s) in Data Model > Relationships

Inherited fields:

RelationshipBase

Field NULL Description Note
joinQuerySourceName
string
  The alias/name of the query source containing the relationship  
joinQuerySourceId
string (GUID)
  The id of the query source containing the relationship  
joinFieldId
string (GUID)
Y The id of the referencing field  
joinFieldType
string
  Place-holder  
foreignQuerySourceName
string
  The alias/name of the query source referenced by the relationship  
foreignQuerySourceId
string (GUID)
  The id of the query source referenced by the relationship  
foreignFieldId
string (GUID)
Y The id of the field referenced by the relationship  
foreignFieldType
string
  Place-holder  
joinFieldName
string
  The alias/name of the referencing field  
foreignFieldName
string
  The alias/name of the field referenced by the relationship  
joinDataSourceCategoryId
string (GUID)
  The id of the category of the query source containing the relationship  
joinDataSourceCategoryName
string
  The name of the category of the query source containing the relationship  
foreignDataSourceCategoryId
string (GUID)
  The id of the category of the query source referenced by the relationship  
foreignDataSourceCategoryName
string
  The name of the category of the query source referenced by the relationship  
comparisonOperator
string
  The comparison operator  

Inherited fields:

Entity

Field NULL Description Note
id
string (GUID)
  The id of this object
Example: 572bd576-8c92-4901-ab2a-b16e38144813
Allow null incase insert a new entity
state
integer
 

The entity state of this object

  • 0 = None
  • 1 = Insert
  • 2 = Delete
  • 3 = Update
 
deleted
boolean
  Is this object deleted  
inserted
boolean
  Is this object inserted  
version
string
Y The version  
created
datetime in ISO 8601 format
Y The created datetime  
createdBy
string
  The creator  
modified
datetime in ISO 8601 format
Y The modification datetime  
modifiedBy
string
  The user who last modified this object  
Sample:
{
   "joinConnectionId" : "ca24a47e-ffdd-4391-a82a-254f48b451e5",
   "foreignConnectionId" : "ca24a47e-ffdd-4391-a82a-254f48b451e5",
   "joinQuerySourceId" : "e03b8805-60ae-41df-b69a-f3bece9721c5",
   "joinQuerySourceName" : "EmployeeDepartmentHistory",
   "joinDataSourceCategoryName" : null,
   "joinDataSourceCategoryId" : "00000000-0000-0000-0000-000000000000",
   "foreignDataSourceCategoryName" : null,
   "foreignDataSourceCategoryId" : "00000000-0000-0000-0000-000000000000",
   "foreignQuerySourceId" : "9fb719f8-8a70-4f4e-91d5-4e8372413d92",
   "foreignQuerySourceName" : "Employee",
   "joinFieldId" : "322d9f3d-1f65-4d60-9cac-933a2c40db9d",
   "joinFieldName" : "BusinessEntityID",
   "foreignFieldId" : "484817ea-f130-417b-a096-32c13249b7d0",
   "foreignFieldName" : "BusinessEntityID",
   "alias" : "abc",
   "systemRelationship" : true,
   "joinType" : "Inner",
   "parentRelationshipId" : "00000000-0000-0000-0000-000000000000",
   "deleted" : false,
   "position" : null,
   "relationshipKeyJoins" : null,
   "reportId" : "00000000-0000-0000-0000-000000000000",
   "foreignAlias" : null,
   "selectedForeignAlias" : "9fb719f8-8a70-4f4e-91d5-4e8372413d92_Employee",
   "id" : "48ab1f19-db84-4d8b-9c18-02312d16c282",
   "state" : 0,
   "modified" : "2016-04-15T06:27:16.023"
}