Links

Links are used to describe relationships between entities.

Link Model

• id: string
• href: string
• rel: string
• type?: string
• title?: string
• method?: string
• headers?: Record<string, string | string[]>
• body?: any

See STAC Links for more details.

Relation Types

• self: The link is to the current entity.
• root: The link is to the root entity.
• parent: The link is to the parent entity.
• child: The link is to the child entity.
• collection: The link is to a collection.
• item: The link is to an item.

Examples

Self Link

Portal Object 019decb5-bacd-7032-a444-d27d03e458b6

{
  "href": "https://www.lateral-robotics.com/portal/items/019decb5-bacd-7032-a444-d27d03e458b6",
  "rel": "self",
  "type": "application/json"
}

Parent Child Link

Portal Object 019decb5-bacd-7032-a444-d27d03e458b6

{
  "href": "https://www.lateral-robotics.com/portal/items/98c50e89-3fea-4f50-b05a-9c4b2b1ed649",
  "rel": "parent",
  "type": "application/json"
}

”Replaced By” Link

Portal Object 019decb5-bacd-7032-a444-d27d03e458b6

{
  "href": "https://www.lateral-robotics.com/portal/items/7d671840-7ce3-401e-ab0f-cc134a254ea7",
  "rel": "replaced-by",
  "type": "application/json"
}