Endpoints

Ressourcerne og endpoints i THMI's offentlige API — projekter, tags, værdier, historik og sider.

Alle endpoints findes under /api/v1 og godkendes med en adgangsnøgle som bearer-token. Stier med {projectId} er afgrænset til ét projekt; {format} er json eller csv. Brug OpenAPI-specifikationen for den autoritative, maskinlæsbare definition.

Projekter

MetodeStiReturnerer
GET/v1/projects/listDe projekter, nøglen har adgang til.
GET/v1/{projectId}/projectOplysninger om et enkelt projekt.

Tags

Et tags definition og metadata (ikke dets værdi).

MetodeStiReturnerer
GET/v1/{projectId}/tag/listAlle tags i projektet.
GET/v1/{projectId}/tag/by-id/{tagId}Ét tag, efter id.
GET/v1/{projectId}/tag/by-path?tagPath=…Ét tag, efter dets sti.

Tagværdier

Tags’ aktuelle værdi.

MetodeStiReturnerer
GET/v1/{projectId}/tag/values/listDen aktuelle værdi for alle tags.
GET/v1/{projectId}/tag/values/by-id/{tagId}Ét tags aktuelle værdi, efter id.
GET/v1/{projectId}/tag/values/by-path?tagPath=…Ét tags aktuelle værdi, efter sti.
POST/v1/{projectId}/tag/values/export/csvDe aktuelle værdier som CSV-eksport.

Historik

Aggregerede historiske værdier over et tidsinterval. Anmodningens body bærer forespørgslen: tidsintervallet (timeFrom, timeTo, i epoch-millisekunder), timeZone, hvilke tags (tagList), groupingType (MINUTES · HOURS · DAYS · MONTHS · YEARS) og valueType (ACTUAL eller DELTA). Se Brug af API’et for den fulde body og et eksempel.

MetodeStiReturnerer
POST/v1/{projectId}/history/aggregate/{format}Aggregeret historik som JSON eller CSV.
POST/v1/{projectId}/history/aggregate/by-id/{format}Det samme, hvor tags vælges efter id.
POST/v1/{projectId}/history/aggregate/by-path/{format}Det samme, hvor tags vælges efter sti.
GET/v1/{projectId}/history/snapshotEt øjebliksbillede af værdier på et tidspunkt.

Sider

Et projekts sider, gengivet som SVG.

MetodeStiReturnerer
GET/v1/{projectId}/page/treeSidernes mappehierarki.
GET/v1/{projectId}/page/{fileId}En side som et SVG-dokument.
GET/v1/{projectId}/page/{fileId}/streamDen samme side, streamet.

Tidszoner

MetodeStiReturnerer
GET/v1/timezone/availableDe tidszone-id’er, API’et accepterer.