REST – Data Joins

Joins are the relationship data objects have to each other. Join information is accessible and editable via REST.

Important

All requests require a Session ID URL parameter and basic request headers. In the following document, headers are omitted for clarity.

Join JSON

Joins are represented as JSON objects with the following properties:

Name	Type	Writable	Description
Id	string	no	The unique Id of this join
EntityFrom	string	required-create	The “from” (or “left”) data object of this join
EntityTo	string	required-create	The “to” (or “right”) data object of this join
JoinType	const	yes (“Inner”)	Join Type
RelationshipType	const	yes (“OneToOne”)	Join Relation Type
Weight	integer	yes (0)	The weight of this join
JoinColumns	array of JoinColumn	required	The data fields which are joined

Example

{
  "Id":               "Shippers.Orders",
  "EntityFrom":       "Shippers",
  "EntityTo":         "Orders",
  "JoinType":         "Inner",
  "RelationshipType": "OneToMany",
  "Weight":           0,
  "JoinColumns": [
    {
      "ColumnFrom": "ShipperID",
      "ColumnTo":   "ShipVia"
    }
  ]
}

JoinColumn JSON

The JoinColumn objects of a join indicate which columns are used to join the data objects. Objects can be joined on multiple join columns (which are AND-ed). Each join requires one or more sets of join columns.

JoinColumn objects have the following properties:

Name	Type	Writable	Description
ColumnFrom	string	required	The join data field for the “from” (or “left”) data object
ColumnTo	string	required	The join data field for the “to” (or “right”) data object

Example

"JoinColumns": [ 
  {
    "ColumnFrom": "ShipperID",
    "ColumnTo":   "ShipVia"  }
]

List All Joins in the Configuration

GET /rest/Joins

List all the joins in the current configuration. Output is an array of objects, each representing an individual join.

Name	Type	Description
Id	string	The unique Id of this join

Available parameters

Name	Type	Description
entity	string	Show only joins that join this data object

Using curl

curl http://{webservice}/rest/Joins?sid={sid} -X GET

Example Response

Status: 200 OK

[
  {
    "Id": "Employees.Orders"
  },
  {
    "Id": "Employees.EmployeeTerritories"
  },
  ...
]

Show Properties of a Specific Join

Show the properties of the join specified by its Id.

GET /rest/Joins/{Id}

Using curl

curl http://{webservice}/rest/Joins/{Id}?sid={sid} -X GET

Example response

Status: 200 OK

{
  "Id":               "Orders.OrderDetails",
  "EntityFrom":       "Orders",
  "EntityTo":         "OrderDetails",
  "JoinType":         "Inner",
  "RelationshipType": "OneToOne",
  "Weight":           0,
  "JoinColumns": [
    {
      "ColumnFrom": "OrderID",
      "ColumnTo":   "OrderID"
    }
  ]
}

Create a New Join

POST /rest/Joins

Using curl

curl http://{webservice}/rest/Joins?sid={sid} -X POST ^
	-d @newJoin.txt

newJoin.txt

{
   "EntityFrom":"Shippers",
   "EntityTo":"Orders",
   "RelationshipType":"OneToMany",
   "JoinColumns":[
      {
         "ColumnFrom":"ShipperID",
         "ColumnTo":"ShipVia"
      }
   ]
}

Example response

Status: 201 Created

{
  "Id":               "Shippers.Orders",
  "EntityFrom":       "Shippers",
  "EntityTo":         "Orders",
  "JoinType":         "Inner",
  "RelationshipType": "OneToMany",
  "Weight":           0,
  "JoinColumns": [
    {
      "ColumnFrom": "ShipperID",
      "ColumnTo":   "ShipVia"
    }
  ]
}

Edit Properties of a Join

PATCH /rest/Joins/{Id}

Only supply the properties to be edited.

Using curl

curl http://{webservice}/rest/Joins/{Id}?sid={sid} -X PATCH ^
	-d "{'JoinType':'LeftOuter'}"

Example response

Status: 204 No Content

Delete a Join

DELETE /rest/Joins/{Id}

Using curl

curl http://{webservice}/rest/Joins/{Id}?sid={sid} -X DELETE

Example response

Status: 204 No Content