Portal Asset

Portal Assets are used to describe the files associated with a Portal Item or Collection.

See STAC Assets for more details.

Asset.ts

interface Asset {
  href: string;
  title?: string;
  description?: string;
  type?: string;
  roles?: string[];
}

asset.json

{
  "href": "https://www.your-site.com/019decb5-bacd-7032-a444-d27d03e458b6",
  "title": "Portal Item 019decb5-bacd-7032-a444-d27d03e458b6",
  "description": "This is a description of the Portal Item 019decb5-bacd-7032-a444-d27d03e458b6",
  "type": "application/json",
  "roles": ["data", "metadata"]
}

General Properties

href required

type: string

URI to the asset object. Relative and absolute URI are both allowed. Trailing slashes are significant.

title optional

type: string

The displayed title for clients and users.

description optional

type: string

A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.

type optional

// TODO: add link to media types

type: string

Media type of the asset.

roles optional

type: string[]

The semantic roles of the asset, similar to the use of rel in links. See Asset Roles below.

Asset Roles

These are the roles that can be used for an asset.

See STAC Asset Roles for more details.

Role Name	Description
data	The data itself, excluding the metadata.
metadata	Metadata sidecar files describing the data, for example a Landsat-8 MTL file.
thumbnail	An asset that represents a thumbnail of the Item or Collection, typically a RGB or grayscale image primarily for human consumption, low resolution, restricted spatial extent, and displayable in a web browser without scripts or extensions.
overview	An asset that represents a more detailed overview of the Item or Collection, typically a RGB or grayscale image primarily for human consumption, medium resolution, full spatial extent, in a file format that’s can be visualized easily (e.g., Cloud-Optimized GeoTiff).
visual	An asset that represents a detailed overview of the Item or Collection, typically a RGB or grayscale image primarily for human consumption, high or native resolution (often sharpened), full spatial extent, in a file format that’s can be visualized easily (e.g., Cloud-Optimized GeoTiff).
date	An asset that provides per-pixel acquisition timestamps, typically serving as metadata to another asset.
graphic	Supporting plot, illustration, or graph associated with the Item.
data-mask	File indicating if corresponding pixels have Valid data and various types of invalid data.
snow-ice	Points to a file that indicates whether a pixel is assessed as being snow/ice or not.
land-water	Points to a file that indicates whether a pixel is assessed as being land or water.
water-mask	Points to a file that indicates whether a pixel is assessed as being water (e.g. flooding map).
iso-19115	Points to an ISO 19115 metadata file.