# Managing relations through the REST API

Defining relations between content-types (that are designated as entities in the database layers) is connecting entities with each other.

Relations between content-types can be managed through the admin panel or through REST requests sent to the Content API.

Relations can be connected, disconnected or set through the Content API by passing parameters in the body of the request:

Parameter name Description Type of update
connect Connects new entities.

Can be used in combination with disconnect.

Can be used with positional arguments to define an order for relations.
Partial
disconnect Disconnects entities.

Can be used in combination with connect.
Partial
set Set entities to a specific set. Using set will overwrite all existing connections to other entities.

Cannot be used in combination with connect or disconnect.
Full

# connect

Using connect in the body of a request performs a partial update, connecting the specified relations.

connect accepts either a shorthand or a longhand syntax. In the following examples, numbers refers to entity ids:

Syntax type Syntax example
shorthand connect: [2, 4]
longhand connect: [{ id: 2 }, { id: 4 }]

You can also use the longhand syntax to reorder relations.

connect can be used in combination with disconnect.


# Relations reordering

Positional arguments can be passed to the longhand syntax of connect to define the order of relations.

The longhand syntax accepts an array of objects, each object containing the id of the entry to be connected and an optional position object to define where to connect the relation.

✏️ Different syntaxes for different relations

The syntaxes described in this documentation are useful for one-to-many, many-to-many and many-ways relations.
For one-to-one, many-to-one and one-way relations, the syntaxes are also supported but only the last relation will be used, so it's preferable to use a shorter format (e.g.: { data: { category: 2 } }, see REST API documentation).

To define the position for a relation, pass one of the following 4 different positional attributes:

Parameter name and syntax Description Type
before: id Positions the relation before the given id. Entry id
after: id Positions the relation after the given id. Entry id
start: true Positions the relation at the start of the existing list of relations. Boolean
end: true Positions the relation at the end of the existing list of relations. Boolean

The position argument is optional and defaults to position: { end: true }.

✏️ Sequential order

Since connect is an array, the order of operations is important as they will be treated sequentially (see combined example below).

✋ CAUTION

The same relation should not be connected more than once, otherwise it would return a Validation error by the API.

# disconnect

Using disconnect in the body of a request performs a partial update, disconnecting the specified relations.

disconnect accepts either a shorthand or a longhand syntax. In the following examples, numbers refers to entity ids:

Syntax type Syntax example
shorthand disconnect: [2, 4]
longhand disconnect: [{ id: 2 }, { id: 4 }]

disconnect can be used in combination with connect.


# set

Using set performs a full update, replacing all existing relations with the ones specified, in the order specified.

set accepts a shorthand or a longhand syntax. In the following examples, numbers refers to entity ids:

Syntax type Syntax example
shorthand set: [2, 4]
longhand set: [{ id: 2 }, { id: 4 }]

As set replaces all existing relations, it should not be used in combination with other parameters. To perform a partial update, use connect and disconnect.

✏️ Omitting set

Omitting any parameter is equivalent to using set.
For instance, the following 3 syntaxes are all equivalent:

  • data: { categories: set: [{ id: 2 }, { id: 4 }] }}
  • data: { categories: set: [2, 4] }}
  • data: { categories: [2, 4] } (as used in the REST API documentation)