Create a table link relationship

Prev Next
Post
/tableLinks

Create a linking relationship by declaring the relationship type and creating a column in both the left and the right table. Note: these could be the same table.

Security
HTTP
Type basic

Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.

API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.

Body parameters
object
leftTableId
string Required

Id of left table in link relationship

leftColumnLabel
string

Label to be used for the left column in linking relationship

rightTableId
string Required

Id of right table in link relationship

rightColumnLabel
string

Label to be used for the right column in linking relationship

relationshipType
string Required

The type of linking relationship

Valid values[ "one-to-one", "one-to-many", "many-to-one", "many-to-many" ]
Responses
201

link created successfully

object
Example{ "id": "gthSX9t3tY2cJfBWe", "createdAt": "2019-01-15T17:30:01.244Z", "createdBy": "N24uug8iXSTWR39rB", "updatedAt": "2019-01-15T17:31:20.002Z", "updatedBy": "N24uug8iXSTWR39rB", "leftTableId": "d3fbb2cf-f12a-4ebc-b054-c35085bea753", "leftTableColumnId": "the_left_column", "rightTableId": "227daca2-aea8-4482-9b8d-7d340b1ff34b", "rightTableColumnId": "the_right_column" }
id
Exampleg56RCoZCtzv7borvp
createdAt
createdBy
Exampleg56RCoZCtzv7borvp
updatedAt
updatedBy
Exampleg56RCoZCtzv7borvp
deletedAt
string (date-time)
deletedBy
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
leftTableId
string

The ID of the left table in the link.

leftTableColumnId
string

The ID of the column in the left table that contains the links.

rightTableId
string

The ID of the right table in the link.

rightTableColumnId
string

The ID of the column in the right table that contains the links.

400

The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
401

The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
403

The provided authentication info was rejected. The response will provide additional details.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
422

The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
500

The server encountered an unexpected error.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string