---
title: "Relations"
canonical_url: "https://docs.getdx.com/webapi/types/relations/"
md_url: "https://docs.getdx.com/webapi/types/relations.md"
last_updated: "2026-05-29"
---

# Relations
Relations are directional associations with other entities. To clear a relation, simply update or upsert a catalog entity with the relation identifier and `null` as the value instead of the entity identifiers. Omitted relations will not be affected.

The key in the object is the distinct relation identifier.

## Example

```json
{
  "service-consumes-api": ["payment-api", "user-api"],
  "service-depends-on": ["database-service"],
  "service-provides-api": ["order-processing-api"]
}
```

## Properties

Relations are stored as key-value pairs where:

| Key                     | Type          | Description                                                                                                                                        |
| ----------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `<relation_identifier>` | array<string> | An array of entity identifiers that this entity has the specified relation with. The relation identifier is defined in your catalog configuration. |
---

## Sitemap

[Overview of all docs pages](/llms.txt)