Punkty końcowe
Zasoby i punkty końcowe publicznego API THMI — projekty, tagi, wartości, historia i strony.
Wszystkie punkty końcowe znajdują się pod /api/v1 i są uwierzytelniane
tokenem dostępu typu bearer. Ścieżki zawierające
{projectId} dotyczą jednego projektu; {format} to json lub csv. Wiarygodną,
czytelną maszynowo definicję znajdziesz w
specyfikacji OpenAPI.
Projekty
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| GET | /v1/projects/list | Projekty, do których token ma dostęp. |
| GET | /v1/{projectId}/project | Szczegóły pojedynczego projektu. |
Tagi
Definicja i metadane tagu (bez jego wartości).
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| GET | /v1/{projectId}/tag/list | Wszystkie tagi w projekcie. |
| GET | /v1/{projectId}/tag/by-id/{tagId} | Jeden tag, według id. |
| GET | /v1/{projectId}/tag/by-path?tagPath=… | Jeden tag, według ścieżki. |
Wartości tagów
Bieżąca wartość tagów.
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| GET | /v1/{projectId}/tag/values/list | Bieżąca wartość każdego tagu. |
| GET | /v1/{projectId}/tag/values/by-id/{tagId} | Bieżąca wartość jednego tagu, według id. |
| GET | /v1/{projectId}/tag/values/by-path?tagPath=… | Bieżąca wartość jednego tagu, według ścieżki. |
| POST | /v1/{projectId}/tag/values/export/csv | Bieżące wartości jako eksport CSV. |
Historia
Zagregowane wartości historyczne z zakresu czasu. Treść żądania zawiera
zapytanie — zakres czasu (timeFrom, timeTo, w milisekundach epoki), strefę
timeZone, tagi (tagList), groupingType
(MINUTES · HOURS · DAYS · MONTHS · YEARS) oraz valueType
(ACTUAL lub DELTA). Pełną treść i przykład znajdziesz w sekcji
Korzystanie z API.
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| POST | /v1/{projectId}/history/aggregate/{format} | Zagregowana historia jako JSON lub CSV. |
| POST | /v1/{projectId}/history/aggregate/by-id/{format} | To samo, z wyborem tagów według id. |
| POST | /v1/{projectId}/history/aggregate/by-path/{format} | To samo, z wyborem tagów według ścieżki. |
| GET | /v1/{projectId}/history/snapshot | Migawka wartości z określonego momentu. |
Strony
Strony projektu renderowane jako SVG.
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| GET | /v1/{projectId}/page/tree | Hierarchia folderów stron. |
| GET | /v1/{projectId}/page/{fileId} | Strona jako dokument SVG. |
| GET | /v1/{projectId}/page/{fileId}/stream | Ta sama strona, przesyłana strumieniowo. |
Strefy czasowe
| Metoda | Ścieżka | Zwraca |
|---|---|---|
| GET | /v1/timezone/available | Identyfikatory stref czasowych akceptowane przez API. |