Contents

Relationship

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

Declaration

object Relationship

Properties

NameTypeDescription
hrefstring

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

nextstring

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.

data Required[Resource]

One or more destination objects.

metaRelationship.Meta

Contextual information about the relationship for the request or response.

Discussion

A to-one relationship contains a single object in the data array.

The rules that apply to the members of this object are:

  • Must contain one of these members: href, data, or meta.

  • If a to-many relationship, may contain the next member.

Topics

Related Objects

See Also

Getting Resource and Relationship Information