Share via


3.1.5.2.2.1.32 relationship

The JSON schema for the relationship object is as follows.

   {
     "description": "SingleColumnRelationship object of Tabular Object Model (TOM)",
     "type": "object",
     "properties": {
       "name": {
         "type": "string"
       },
       "isActive": {
         "type": "boolean"
       },
       "type": {
         "enum": [
           "singleColumn"
         ]
       },
       "crossFilteringBehavior": {
         "enum": [
           "oneDirection",
           "bothDirections",
           "automatic"
         ]
       },
       "joinOnDateBehavior": {
         "enum": [
           "dateAndTime",
           "datePartOnly"
         ]
       },
       "relyOnReferentialIntegrity": {
         "type": "boolean"
       },
       "state": {
         "enum": [
           "ready",
           "noData",
           "calculationNeeded",
           "semanticError",
           "evaluationError",
           "dependencyError",
           "incomplete"
         ]
       },
       "modifiedTime": {
         "type": "string",
         "format": "date-time"
       },
       "refreshedTime": {
         "type": "string",
         "format": "date-time"
       },
       "securityFilteringBehavior": {
         "enum": [
           "oneDirection",
           "bothDirections"
         ]
       },
       "fromCardinality": {
         "enum": [
           "none",
           "one",
           "many"
         ]
       },
       "toCardinality": {
         "enum": [
           "none",
           "one",
           "many"
         ]
       },
       "fromColumn": {
         "type": "string"
       },
       "fromTable": {
         "type": "string"
       },
       "toColumn": {
         "type": "string"
       },
       "toTable": {
         "type": "string"
       },
       "annotations": {
         "type": "array",
         ...
       },
       "extendedProperties": {
         "type": "array",
         "items": {
           ...
         }
       }
     },
     "additionalProperties": false
   }

The properties correspond to the Relationship object that is defined in section 2.2.5.7.

In addition, the JSON-based relationship object can include collections of child annotation and extendedProperty objects.