Skip to content
Geoportal Documentation

Portal Collection

Portal Collections are used to group items or collections together.

See STAC Collections for more details.

PortalCollection.ts
interface PortalCollection {
  id: string;
  type: string;
  title: string;
  description: string;
  keywords?: string[];
  license: string;
  providers?: Provider[];
  extent: Extent;
  summaries?: Record<string, any>;
  links: Link[];
  assets?: Asset[];
  item_assets?: Record<string, Asset>;
}
portal-collection.json
{
  "id": "019decb5-bacd-7032-a444-d27d03e458b6",
  "type": "collection",
  "title": "Portal Collection",
  "description": "# Portal Collection\nThis is a multiline description.",
  "keywords": ["data", "metadata"],
  "license": "MIT",
  "providers": [
    {
      "name": "Lateral Robotics",
      "description": "Lateral Robotics is a company.",
    }
  ],
  "extent": {
    "spatial": {
      "bbox": [[-122.4194, 37.7749, -122.4009, 37.7892]]
    },
    "temporal": {
      "interval": [["2026-01-01T08:00:00Z", null]]
    }
  },
  "links": [
    {
      "href": "https://www.lateral-robotics.com/portal/collections/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 Collection that is unique across all objects in the portal.

type required

Section titled “type ”
type: string
Must be set to collection to be a valid Portal Collection.

title required

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

description required

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

keywords optional

Section titled “keywords ”
type: string[]
List of keywords describing the Portal Collection.

license required

Section titled “license ”
type: string
License(s) of the data collection as SPDX License identifier, SPDX License expression, or other (see below).

providers optional

Section titled “providers ”
type: Provider[]
A list of providers, which may include all organizations capturing or processing the data or the hosting provider.

extent required

Section titled “extent ”
type: Extent
Spatial and temporal extents.

summaries optional

Section titled “summaries ”
type: Record<string, [*] | Range | JSON Schema>
A map of property summaries, either a set of values, a range of values or a JSON Schema.

links required

Section titled “links ”
type:

Link[]
A list of references to other documents.

assets optional

Section titled “assets ”
type:

Asset[]
Dictionary of asset objects that can be downloaded, each with a unique key.

item_assets optional

Section titled “item_assets ”
type: Record<string, Asset>
A dictionary of assets that can be found in member Items.