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:

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:

Example

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

List Joins

GET /rest/Joins

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

Available parameters

Using curl

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

Example response

Status: 200 OK

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

Show Join

GET /rest/Joins/{Id}

Show the properties of the join specified by its 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 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
Location: /{webservice}/rest/Joins/Shippers.Orders

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

Edit 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 Join

DELETE /rest/Joins/{Id}

Using curl

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

Example response

Status: 204 No Content