Skip to content
Geoportal Documentation

Portal Item

Portal Items are used to describe a single entity in the portal.

See STAC Items for more details.

PortalItem.ts
interface PortalItem {
  id: string;
  type: string;
  geometry: GeoJSON.Geometry;
  bbox: number[] | null;
  properties: Record<string, any>;
  links: Link[];
  assets: Asset[];
  item_assets?: Record<string, Asset>;
}
portal-item.json
{
  "id": "019decb5-bacd-7032-a444-d27d03e458b6",
  "type": "item",
  "geometry": {
    "type": "Polygon",
    "coordinates": [[[-122.4194, 37.7749], [-122.4009, 37.7892], [-122.4194, 37.7749]]]
  },
  "bbox": [-122.4194, 37.7749, -122.4009, 37.7892],
  "properties": {
    "name": "Portal Item 019decb5-bacd-7032-a444-d27d03e458b6"
  },
  "links": [],
  "assets": [],
  "item_assets": {}
}

General Properties

Section titled “General Properties”

id required

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

type required

Section titled “type ”
type: string
Must be set to item to be a valid Portal Item.

geometry required

Section titled “geometry ”
type: GeoJSON.Geometry

The full footprint of the assets represented by this item.

bbox required

Section titled “bbox ”
type: number[] | null

The bounding box of the item. Required if geometry is not null, prohibited if geometry is null.

properties required

Section titled “properties ”
type: Record<string, any>
A dictionary of additional metadata for the item.

links required

Section titled “links ”

// TODO: Fix inline link styling

type:

Link[]
A list of link objects to resources and related URLs.

assets required

Section titled “assets ”
type:

Asset[]

A dictionary of asset objects associated with this item that can be downloaded, each with a unique key.