Endepunkter
Ressursene og endepunktene i THMIs offentlige API — prosjekter, tagger, verdier, historikk og sider.
Alle endepunkter ligger under /api/v1 og autentiseres med et
tilgangstoken som bearer-token. Baner som
vises med {projectId}, gjelder ett prosjekt; {format} er json eller csv.
For den autoritative, maskinlesbare definisjonen bruker du
OpenAPI-spesifikasjonen.
Prosjekter
| Metode | Bane | Returnerer |
|---|---|---|
| GET | /v1/projects/list | Prosjektene tokenet har tilgang til. |
| GET | /v1/{projectId}/project | Opplysningene om ett enkelt prosjekt. |
Tagger
En taggs definisjon og metadata (ikke verdien).
| Metode | Bane | Returnerer |
|---|---|---|
| GET | /v1/{projectId}/tag/list | Alle tagger i prosjektet. |
| GET | /v1/{projectId}/tag/by-id/{tagId} | Én tagg, etter ID. |
| GET | /v1/{projectId}/tag/by-path?tagPath=… | Én tagg, etter banen. |
Taggverdier
Den gjeldende verdien til tagger.
| Metode | Bane | Returnerer |
|---|---|---|
| GET | /v1/{projectId}/tag/values/list | Den gjeldende verdien til alle tagger. |
| GET | /v1/{projectId}/tag/values/by-id/{tagId} | Én taggs gjeldende verdi, etter ID. |
| GET | /v1/{projectId}/tag/values/by-path?tagPath=… | Én taggs gjeldende verdi, etter bane. |
| POST | /v1/{projectId}/tag/values/export/csv | De gjeldende verdiene som en CSV-eksport. |
Historikk
Aggregerte historiske verdier over et tidsrom. Forespørselens kropp inneholder
spørringen — tidsrommet (timeFrom, timeTo, i epoch-millisekunder), timeZone,
hvilke tagger (tagList), groupingType
(MINUTES · HOURS · DAYS · MONTHS · YEARS) og valueType
(ACTUAL eller DELTA). Se Bruke API-et for
hele kroppen og et eksempel.
| Metode | Bane | Returnerer |
|---|---|---|
| POST | /v1/{projectId}/history/aggregate/{format} | Aggregert historikk, som JSON eller CSV. |
| POST | /v1/{projectId}/history/aggregate/by-id/{format} | Det samme, med tagger valgt etter ID. |
| POST | /v1/{projectId}/history/aggregate/by-path/{format} | Det samme, med tagger valgt etter bane. |
| GET | /v1/{projectId}/history/snapshot | Et øyeblikksbilde av verdier på et tidspunkt. |
Sider
Et prosjekts sider, gjengitt som SVG.
| Metode | Bane | Returnerer |
|---|---|---|
| GET | /v1/{projectId}/page/tree | Mappehierarkiet for sider. |
| GET | /v1/{projectId}/page/{fileId} | En side som et SVG-dokument. |
| GET | /v1/{projectId}/page/{fileId}/stream | Den samme siden, strømmet. |
Tidssoner
| Metode | Bane | Returnerer |
|---|---|---|
| GET | /v1/timezone/available | Tidssoneidentifikatorene som API-et godtar. |