Examples

This section walks through the Rest API by example. The publishing flows build a Knowledge Resource and a Knowledge Package end-to-end, the search page collects the most useful query patterns, all using the available endpoints.

Publishing a Knowledge Resource

Create a draft, upload files, edit metadata, publish, and (optionally) open a new version.

Publishing a Knowledge Package

Same lifecycle as a Resource, plus associating Resources to the Package and importing them into a future version.

Search examples

Full-text, spatial bounding box, engagement-priority and combined filters against the unified search endpoint.

Prerequisites

The workflows presented in the following pages require the following:

(1) A Knowledge Provider account on the platform (Search step does not require authentication - Publication requires authentication).

(2) A personal access token, generated in the user profile page.

(3) Familiarity with the entity lifecycle.

cURL convention

Every example available in the next pages has an HTTP and a cURL tab. The cURL snippets assume two shell variables for brevity:

export HOST="https://gkhub.earthobservations.org"
export TOKEN="your-personal-access-token"

Where to go from here

Pick one of the sub-pages above. The publishing flows are independent, you can read just the one you need, and the search examples stand alone.