Create a relationship

Create a relation field on the source type pointing at a target type of the same space, optionally with a reverse field on the target type. Cardinality is source to target: one_to_one, one_to_many, many_to_one or many_to_many.

Authorization

bearerApiKey

AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

record_type_id*string

Resource identifier: record_type_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expected_draft_revision?integer

Range1 <= value

field*

target_type_id*string

Formatuuid

cardinality*string

Value in

"one_to_one"
"one_to_many"
"many_to_one"
"many_to_many"

source_role?string

Lengthlength <= 120

target_role?string

Lengthlength <= 120

reverse_field?|null

target_expected_draft_revision?integer

Range1 <= value

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/records/types/123e4567-e89b-42d3-a456-426614174000/relationships" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{    "field": {      "key": "summary",      "label": "Customer documents"    },    "target_type_id": "123e4567-e89b-42d3-a456-426614174000",    "cardinality": "one_to_one"  }'

{}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

402application/problem+json

403application/problem+json

404application/problem+json

405application/problem+json

409application/problem+json

410application/problem+json

413application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

504application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`