Slutpunkter
Resurserna och slutpunkterna i THMI:s publika API — projekt, taggar, värden, historik och sidor.
Alla slutpunkter ligger under /api/v1 och autentiseras med en bearer-baserad
åtkomstnyckel. Sökvägar som visas med
{projectId} är avgränsade till ett projekt; {format} är json eller csv. För den
auktoritativa, maskinläsbara definitionen, använd
OpenAPI-specifikationen.
Projekt
| Metod | Sökväg | Returnerar |
|---|---|---|
| GET | /v1/projects/list | De projekt som nyckeln kan komma åt. |
| GET | /v1/{projectId}/project | Ett enskilt projekts detaljer. |
Taggar
En taggs definition och metadata (inte dess värde).
| Metod | Sökväg | Returnerar |
|---|---|---|
| GET | /v1/{projectId}/tag/list | Alla taggar i projektet. |
| GET | /v1/{projectId}/tag/by-id/{tagId} | En tagg, via id. |
| GET | /v1/{projectId}/tag/by-path?tagPath=… | En tagg, via dess sökväg. |
Taggvärden
Det aktuella värdet för taggar.
| Metod | Sökväg | Returnerar |
|---|---|---|
| GET | /v1/{projectId}/tag/values/list | Det aktuella värdet för varje tagg. |
| GET | /v1/{projectId}/tag/values/by-id/{tagId} | En taggs aktuella värde, via id. |
| GET | /v1/{projectId}/tag/values/by-path?tagPath=… | En taggs aktuella värde, via sökväg. |
| POST | /v1/{projectId}/tag/values/export/csv | De aktuella värdena som en CSV-export. |
Historik
Aggregerade historiska värden över ett tidsintervall. Begärans kropp bär
frågan — tidsintervallet (timeFrom, timeTo, i epok-millisekunder),
timeZone, vilka taggar (tagList), groupingType
(MINUTES · HOURS · DAYS · MONTHS · YEARS) och valueType
(ACTUAL eller DELTA). Se Använda API:et för
den fullständiga kroppen och ett exempel.
| Metod | Sökväg | Returnerar |
|---|---|---|
| POST | /v1/{projectId}/history/aggregate/{format} | Aggregerad historik, som JSON eller CSV. |
| POST | /v1/{projectId}/history/aggregate/by-id/{format} | Samma sak, men väljer taggar via id. |
| POST | /v1/{projectId}/history/aggregate/by-path/{format} | Samma sak, men väljer taggar via sökväg. |
| GET | /v1/{projectId}/history/snapshot | En ögonblicksbild av värden vid en tidpunkt. |
Sidor
Ett projekts sidor, renderade som SVG.
| Metod | Sökväg | Returnerar |
|---|---|---|
| GET | /v1/{projectId}/page/tree | Sidmapparnas hierarki. |
| GET | /v1/{projectId}/page/{fileId} | En sida som ett SVG-dokument. |
| GET | /v1/{projectId}/page/{fileId}/stream | Samma sida, strömmad. |
Tidszoner
| Metod | Sökväg | Returnerar |
|---|---|---|
| GET | /v1/timezone/available | Tidszonsidentifierarna som API:et accepterar. |