Päätepisteet
THMI:n julkisen API:n resurssit ja päätepisteet, kuten projektit, tagit, arvot, historia ja sivut.
Kaikki päätepisteet ovat polun /api/v1 alla, ja ne todennetaan
bearer-tyyppisellä käyttötunnisteella.
Polut, joissa on {projectId}, koskevat yhtä projektia, ja {format} on json
tai csv. Käytä virallisena, koneluettavana määrittelynä
OpenAPI-määritystä.
Projektit
| Metodi | Polku | Palauttaa |
|---|---|---|
| GET | /v1/projects/list | Projektit, joihin tunnisteella on pääsy. |
| GET | /v1/{projectId}/project | Yksittäisen projektin tiedot. |
Tagit
Tagin määritys ja metatiedot (ei sen arvoa).
| Metodi | Polku | Palauttaa |
|---|---|---|
| GET | /v1/{projectId}/tag/list | Kaikki projektin tagit. |
| GET | /v1/{projectId}/tag/by-id/{tagId} | Yhden tagin tunnuksen mukaan. |
| GET | /v1/{projectId}/tag/by-path?tagPath=… | Yhden tagin polun mukaan. |
Tagien arvot
Tagien nykyinen arvo.
| Metodi | Polku | Palauttaa |
|---|---|---|
| GET | /v1/{projectId}/tag/values/list | Jokaisen tagin nykyisen arvon. |
| GET | /v1/{projectId}/tag/values/by-id/{tagId} | Yhden tagin nykyisen arvon tunnuksen mukaan. |
| GET | /v1/{projectId}/tag/values/by-path?tagPath=… | Yhden tagin nykyisen arvon polun mukaan. |
| POST | /v1/{projectId}/tag/values/export/csv | Nykyiset arvot CSV-vientinä. |
Historia
Kootut historialliset arvot aikaväliltä. Pyynnön runko sisältää kyselyn:
aikavälin (timeFrom, timeTo, epoch-millisekunteina), aikavyöhykkeen
timeZone, tagit (tagList), ryhmittelyn groupingType
(MINUTES · HOURS · DAYS · MONTHS · YEARS) ja arvotyypin valueType
(ACTUAL tai DELTA). Koko runko ja esimerkki löytyvät sivulta
API:n käyttö.
| Metodi | Polku | Palauttaa |
|---|---|---|
| POST | /v1/{projectId}/history/aggregate/{format} | Kootun historian JSON- tai CSV-muodossa. |
| POST | /v1/{projectId}/history/aggregate/by-id/{format} | Saman, tagit tunnuksen mukaan valittuina. |
| POST | /v1/{projectId}/history/aggregate/by-path/{format} | Saman, tagit polun mukaan valittuina. |
| GET | /v1/{projectId}/history/snapshot | Tilannekuvan arvoista tietyllä ajanhetkellä. |
Sivut
Projektin sivut SVG-muodossa.
| Metodi | Polku | Palauttaa |
|---|---|---|
| GET | /v1/{projectId}/page/tree | Sivujen kansiohierarkian. |
| GET | /v1/{projectId}/page/{fileId} | Sivun SVG-dokumenttina. |
| GET | /v1/{projectId}/page/{fileId}/stream | Saman sivun suoratoistettuna. |
Aikavyöhykkeet
| Metodi | Polku | Palauttaa |
|---|---|---|
| GET | /v1/timezone/available | Aikavyöhyketunnisteet, jotka API hyväksyy. |