Portal Link

Portal Links are used to describe relationships between entities.

See STAC Links for more details.

Link.ts

interface Link {
  href: string;
  rel: string;
  type?: string;
  title?: string;
  method?: string;
  headers?: Record<string, string | string[]>;
  body?: any;
}

link.json

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

General Properties

href required

type: string

The actual link in the format of an URL. Relative and absolute links are both allowed. Trailing slashes are significant.

rel required

type: string

Relationship between the current document and the linked document. See Relation Types below for more information.

type optional

type: string

Media type of the referenced entity.

title optional

type: string

A human readable title to be used in rendered displays of the link.

method optional

type: string

The HTTP method that shall be used for the request to the target resource, in uppercase. GET by default

headers optional

type: Map<string, string | [string]>

The HTTP headers to be sent for the request to the target resource.

body optional

type: any

The HTTP body to be sent to the target resource.

Relation Types

This is the rel field of a Portal Link.

Core Relation Types

Relation Type	Description
self	Absolute URL to the location that the portal entity can be found online.
root	URL to the root portal entity (Catalog or Collection).
parent	URL to the parent portal entity (Catalog or Collection).
child	URL to a child portal entity (Catalog or Collection).
collection	URL to the parent portal collection.
item	URL to a portal item.

Versioning Relation Types

See STAC Versioning Indicators Extension for more details.

// TODO: add which Portal Elements are compatible with this relation type

Relation Type	Description
latest-version	This link points to a portal resource containing the latest (e.g., current) version. A maximum of one link can use this relation type per portal resource.
predecessor-version	One or multiple links can point to portal resources that are predecessor versions in the version history.
successor-version	One or multiple links can point to portal resources that are successor versions in the version history.
version-history	This link points to a version history or changelog. This can be for example a Markdown file with the corresponding media type or a portal Catalog or Collection.

Processing Relation Types

See STAC Processing Extension for more details.

Relation Type	Description
derived_from	URL to a portal item that was used as input data in the creation of this item.
processing-expression	A processing chain (or script) that describes how the data has been processed.
processing-execution	URL to any resource representing the processing execution (e.g. OGC Process API).
processing-software	URL to any resource that identifies the software and versions used for processing the data, e.g. a Pipfile.lock (Python) or package-lock.json (NodeJS).
processing-validation	URL to any kind of validation that has been applied after processing, e.g. a validation report or a script used for validation.