Skip to content
Geoportal Documentation

Portal Object

Portal Objects are used to wrap and describe a single entity in the portal.

Portal Objects may wrap or reference:

PortalObject.ts
interface PortalObject {
  id: string;
  title: string;
  description: string;
  kind: string;
  tags: string[];
  createdAt: string;
  updatedAt: string;
}
portal-object.json
{
  "id": "019decb5-bacd-7032-a444-d27d03e458b6",
  "title": "Portal Object 019decb5-bacd-7032-a444-d27d03e458b6",
  "description": "This is a description of the Portal Object 019decb5-bacd-7032-a444-d27d03e458b6",
  "kind": "item",
  "tags": ["tag1", "tag2"],
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
}

General Properties

Section titled “General Properties”

id required

Section titled “id ”
type: string
The unique identifier for the portal object.

title required

Section titled “title ”
type: string
The title of the portal object.

description required

Section titled “description ”
type: string
The description of the portal object.

kind required

Section titled “kind ”
type: string
The kind of the portal object.