Reference / @open-music-sdk/types / tRelationship

Interface: tRelationship

Defined in: relationship.ts:6

A to-one or to-many relationship from one resource object to others.

Properties

data

data: tResource[];

Defined in: relationship.ts:12

One or more destination objects.

---

href?

optional href?: string;

Defined in: relationship.ts:8

A URL subpath that fetches the relationship resources as the primary object. This member is only present in responses.

---

meta?

optional meta?: tRelationshipMeta;

Defined in: relationship.ts:14

Contextual information about the relationship for the request or response.

---

next?

optional next?: string;

Defined in: relationship.ts:10

Link to the next page of resources in the relationship. Contains the offset query parameter that specifies the next page. See Fetch Resources by Page.