Skip to content
Geoportal Documentation

Portal Catalog

Portal Catalogs are used to group collections, items, and/or other catalogs together.

Portal Catalogs are based on STAC Catalogs but with additional metadata and behavior.

See STAC Catalogs for more details.

PortalCatalog.ts
interface PortalCatalog {
  id: string;
  type: string;
  title: string;
  description: string;
  links: Link[];
}
portal-catalog.json
{
  "id": "019decb5-bacd-7032-a444-d27d03e458b6",
  "type": "catalog",
  "title": "Portal Catalog",
  "description": "# Portal Catalog\nThis is a multiline description.",
  "links": [
    {
      "href": "https://www.lateral-robotics.com/portal/objects/019decb5-bacd-7032-a444-d27d03e458b6",
      "rel": "self",
      "type": "application/json"
    }
  ]
}

Properties

Section titled “Properties”

id required

Section titled “id ”
type: string
Identifier for the Portal Catalog that is unique across all objects in the portal.

type required

Section titled “type ”
type: string
Must be set to catalog to be a valid Portal Catalog.

title required

Section titled “title ”
type: string
A short descriptive one-line title for the Portal Catalog.

description required

Section titled “description ”
type: string
Detailed multi-line description to fully explain the Portal Catalog. CommonMark 0.29 syntax is supported.

links required

Section titled “links ”
type:

Link[]
A list of references to other documents.