Docs / Utvecklare / Läsa objekt

Läsa objekt

Objektlager är samlingar enligt OGC API – Features. Du kan läsa GeoJSON, välja koordinatsystem, filtrera resultatet och följa länken till nästa sida.

Hitta en samling#

  • GET /v1/ länkar till samlingar, standardstöd och API-referensen.
  • GET /v1/collections?limit=50 listar tillgängliga lager med senast ändrade först. Använd limit och offset för sidindelning av samlingar, högst 200 per sida.
  • GET /v1/collections/{id} ger ett lagers metadata. Samlingens id är lagrets UUID, som visas på datasetets sida.
FältBetydelse
title, description, itemTypeBeskrivning av dataset och lager. Typen är point, line, polygon eller table.
extent.spatial.bboxUtbredning i WGS 84 longitud/latitud.
crs, storageCrsTillgängliga koordinatsystem för svaret och det system som datan lagras i.
featureCount, updatedAntal rader och tidpunkten för den senaste dataändringen.
orbgisDatasetets itemId, layerIndex, detailMinZoom, editable och eventuellt temporalField.
linksAdresser till objekt, tiles, filtrerbara fält och portalen.

Läsa objekten#

GET /v1/collections/{id}/items ger en GeoJSON FeatureCollection. Objektens id är heltal från objectid. Svaret innehåller numberReturned, timeStamp och links. Ett enskilt objekt läser du på /v1/collections/{id}/items/{objectid}.

ParameterAnvändning
limitObjekt per sida: 100 som standard, högst 1 000.
bboxwest,south,east,north; ger objekt vars geometri skär rutan. WGS 84 används om du inte anger bbox-crs.
bbox-crsRutans koordinatsystem.
crsSvaret får detta koordinatsystem, som bekräftas i svarshuvudet Content-Crs.
propertiesKommaseparerade kolumner att hämta. objectid ingår alltid.
afterFortsätt efter detta objectid; använd helst svarets next-länk.
counttrue lägger till numberMatched. Utelämna i sidloopar för att undvika upprepade räkningar.
datetimeTidpunkt eller intervall för orbgis.temporalField. Ger 400 om lagret saknar tidsfält.
filterCQL2-textuttryck som kombineras med bbox och datetime genom AND.
filter-lang, filter-crsEndast cql2-text stöds. filter-crs anger koordinatsystemet för filtrets BBOX.

Koordinatsystem#

Välj ett system ur samlingens crs-lista: CRS84 (longitud/latitud), lagringssystemet eller EPSG 3857, 3006 (SWEREF 99 TM), 3035, 3067, 25832 eller 25833. Ange OGC-adressen, till exempel http://www.opengis.net/def/crs/EPSG/0/3006. System som inte stöds ger 400 unsupported_crs. Läs mer under Koordinatsystem.

Sidindelning och stora uttag#

Följ next-länken i svaret eller Link-headern tills den saknas. Objektsidor använder ett objectid som fortsättningsmarkör. Resultatet är ingen ögonblicksbild: objekt kan ändras medan du läser. Hämta sidorna i följd för att hålla dig inom gränsen för samtidiga anrop.

Viktigt

En fråga får använda databasen i 8 sekunder (504 query_timeout) och svaret får vara högst 20 MB (413 response_too_large). Begränsa bbox, minska limit eller välj färre properties. Använd export för att hämta ett helt stort lager.

Filtrera med CQL2#

GET /v1/collections/{id}/queryables visar vilka fält och datatyper du kan filtrera på. Följande uttryck stöds:

  • Jämförelser med =, <>, <, >, <=, >=; IS NULL, IS NOT NULL; IN och NOT IN med högst 500 värden.
  • LIKE med % i början eller slutet av mönstret. ILIKE eller CASEI() gör matchningen skiftlägesokänslig. _ och % inuti mönstret stöds inte.
  • AND, OR, NOT och parenteser samt datumuttryck som DATE('2026-01-01') och TIMESTAMP('2026-01-01T00:00:00Z').
  • S_INTERSECTS(geometry, BBOX(west, south, east, north)).

Har samlingen kolumnerna species och height_m kan du URL-koda filtret med curl:

curl --fail-with-body --get \
  -H "Authorization: Bearer $ORBGIS_API_KEY" \
  --data-urlencode "filter=species = 'Tilia' AND height_m >= 10" \
  "https://api.orbgis.se/v1/collections/COLLECTION_ID/items"

Byt ut COLLECTION_ID mot lagrets UUID och välj fält ur dess queryables. Ett filter får vara högst 8 192 tecken, ha djup 12 och innehålla 50 villkor per AND/OR-grupp. Uttryck som inte stöds ger 400 unsupported_filter; felaktig syntax, okända fält och fel värdetyper ger 400 invalid_filter.

Innehåll och kartor#

  • GET /v1/items?q=roads&type=feature_service&pageSize=20 söker innehåll och kräver autentisering. GET /v1/items/{id} läser ett innehållsobjekt, inklusive lagrens collections-id. Publicerade innehållsobjekt kan även läsas anonymt.
  • GET /v1/maps/{id} ger kartans koordinatsystem, startvy, bakgrundskarta och lagerinställningar. Kartor kan bara läsas genom API:et.

Metadata, objekt, queryables och tiles som exponeras av en publicerad app kan läsas utan nyckel. Anonyma API-svar cachas i 60 sekunder.