OGC API — Processes · process
index-dataset
Index a dataset into the DGGS — a web view of GET /api/processes/index-dataset.
Fan out one indexing task per spatial partition (chord), persisting content-addressed zoneSets; exactly-once finalisation via an atomic claim.
Inputs
| Name | Type | Default | Description |
|---|---|---|---|
| dataset_uri | — | ||
| dggrs | — | Identifier of the discrete global grid reference system to index into or query against. | |
| partitions | — | One indexing task is fanned out per partition. | |
| collectionId | — | Stable, meaningful id for the resulting dataset collection (e.g. 'nsw-dem-2026'), addressable at /collections/{collectionId} and its /dggs sub-resource. Re-indexing under the same id updates that collection rather than creating a new one. Must match [A-Za-z0-9._~-]{1,128} and must not be a DGGRS-instance id. Defaults to the job id when omitted. | |
| prune | — | If true, re-indexing an existing collectionId REPLACES the collection: zoneSets present before but absent from this submission are removed, so a shrunk or changed dataset leaves no orphans. Applied on the chord's clean fan-in (every partition indexed). Default false keeps additive behaviour. |
Outputs
| Name | Type |
|---|---|
| chunks |
API
GET /api/processes/index-dataset
POST …/execution
Open in Swagger UI
Execution is asynchronous (returns a job to poll) and requires a token — see the documentation. Track runs under OGC API — Jobs.