openAPISpec.yaml 92 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006
  1. openapi: "3.0.0"
  2. info:
  3. version: 1.0.0
  4. title: SensLog Telemetry
  5. servers:
  6. - url: http://127.0.0.1:8080
  7. - url: https://theros.wirelessinfo.cz
  8. paths:
  9. /info:
  10. get:
  11. operationId: infoGET
  12. summary: Information about running instance
  13. responses:
  14. 200:
  15. description: Instance information
  16. content:
  17. application/json:
  18. schema:
  19. $ref: "#/components/schemas/Info"
  20. default:
  21. description: unexpected error
  22. content:
  23. application/json:
  24. schema:
  25. $ref: "#/components/schemas/Error"
  26. /campaigns:
  27. get:
  28. operationId: campaignsGET
  29. summary: Publish info about all campaigns
  30. security:
  31. - hubJwtAuth: [telemetry:read]
  32. parameters:
  33. - $ref: '#/components/parameters/zoneParam'
  34. - $ref: '#/components/parameters/navigationLinksParam'
  35. responses:
  36. 200:
  37. description: JSON array of basic info of each campaign
  38. content:
  39. application/json:
  40. schema:
  41. type: array
  42. items:
  43. $ref: '#/components/schemas/CampaignBasicInfo'
  44. default:
  45. description: unexpected error
  46. content:
  47. application/json:
  48. schema:
  49. $ref: '#/components/schemas/Error'
  50. /campaigns/{campaignId}:
  51. get:
  52. operationId: campaignIdGET
  53. summary: Publish info about a campaign
  54. security:
  55. - hubJwtAuth: [ telemetry:read ]
  56. parameters:
  57. - $ref: '#/components/parameters/campaignIdParam'
  58. - $ref: '#/components/parameters/zoneParam'
  59. - $ref: '#/components/parameters/navigationLinksParam'
  60. responses:
  61. 200:
  62. description: JSON object containing info about a campaign
  63. content:
  64. application/json:
  65. schema:
  66. $ref: '#/components/schemas/CampaignDetailInfo'
  67. default:
  68. description: unexpected error
  69. content:
  70. application/json:
  71. schema:
  72. $ref: '#/components/schemas/Error'
  73. /campaigns/{campaignId}/units:
  74. get:
  75. operationId: campaignIdUnitsGET
  76. summary: Publish info about the campaign's units
  77. security:
  78. - hubJwtAuth: [ telemetry:read ]
  79. parameters:
  80. - $ref: '#/components/parameters/campaignIdParam'
  81. - $ref: '#/components/parameters/zoneParam'
  82. - $ref: '#/components/parameters/navigationLinksParam'
  83. responses:
  84. 200:
  85. description: JSON Array containing info about campaign's units
  86. content:
  87. application/json:
  88. schema:
  89. type: array
  90. items:
  91. $ref: '#/components/schemas/CampaignUnitBasicInfo'
  92. default:
  93. description: unexpected error
  94. content:
  95. application/json:
  96. schema:
  97. $ref: '#/components/schemas/Error'
  98. /campaigns/{campaignId}/units/observations:
  99. get:
  100. operationId: campaignIdUnitsObservationsGET
  101. summary: Publish info about all data of units merged together within the campaign
  102. security:
  103. - hubJwtAuth: [ telemetry:read ]
  104. parameters:
  105. - $ref: '#/components/parameters/campaignIdParam'
  106. - $ref: '#/components/parameters/fromParam'
  107. - $ref: '#/components/parameters/toParam'
  108. - $ref: '#/components/parameters/zoneParam'
  109. - $ref: '#/components/parameters/offsetParam'
  110. - $ref: '#/components/parameters/limitParam'
  111. - $ref: '#/components/parameters/formatParam'
  112. - $ref: '#/components/parameters/filterParam'
  113. - $ref: '#/components/parameters/navigationLinksParam'
  114. responses:
  115. 200:
  116. description: JSON containing stream of telemetry data
  117. content:
  118. application/json:
  119. schema:
  120. $ref: '#/components/schemas/CampaignObservation'
  121. application/geo+json:
  122. schema:
  123. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  124. default:
  125. description: unexpected error
  126. content:
  127. application/json:
  128. schema:
  129. $ref: '#/components/schemas/Error'
  130. post:
  131. operationId: campaignIdUnitsObservationsPOST
  132. security:
  133. - hubJwtAuth: [ telemetry:write ]
  134. parameters:
  135. - $ref: '#/components/parameters/campaignIdParam'
  136. requestBody:
  137. required: true
  138. content:
  139. application/json:
  140. schema:
  141. type: array
  142. items:
  143. $ref: '#/components/schemas/CampaignDataObservation'
  144. application/geo+json:
  145. schema:
  146. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  147. responses:
  148. 200:
  149. description: JSON
  150. content:
  151. application/json:
  152. schema:
  153. $ref: '#/components/schemas/PostResponse'
  154. default:
  155. description: unexpected error
  156. content:
  157. application/json:
  158. schema:
  159. $ref: '#/components/schemas/Error'
  160. /campaigns/{campaignId}/units/observations/locations:
  161. get:
  162. operationId: campaignIdUnitsObservationsLocationsGET
  163. summary: Publish info about all data of units merged together within the campaign
  164. security:
  165. - hubJwtAuth: [ telemetry:read ]
  166. parameters:
  167. - $ref: '#/components/parameters/campaignIdParam'
  168. - $ref: '#/components/parameters/limitPerUnitParam'
  169. - $ref: '#/components/parameters/fromParam'
  170. - $ref: '#/components/parameters/toParam'
  171. - $ref: '#/components/parameters/zoneParam'
  172. - $ref: '#/components/parameters/sortParam'
  173. - $ref: '#/components/parameters/formatParam'
  174. - $ref: '#/components/parameters/filterParam'
  175. - $ref: '#/components/parameters/navigationLinksParam'
  176. responses:
  177. 200:
  178. description: JSON containing stream of telemetry data
  179. content:
  180. application/json:
  181. schema:
  182. $ref: '#/components/schemas/CampaignUnitsLocations'
  183. application/geo+json:
  184. schema:
  185. $ref: '#/components/schemas/GeoCampaignUnitsLocations'
  186. default:
  187. description: unexpected error
  188. content:
  189. application/json:
  190. schema:
  191. $ref: '#/components/schemas/Error'
  192. /campaigns/{campaignId}/units/{unitId}:
  193. get:
  194. operationId: campaignIdUnitIdGET
  195. summary: Publish info about the unit within its campaign's scope
  196. security:
  197. - hubJwtAuth: [ telemetry:read ]
  198. parameters:
  199. - $ref: '#/components/parameters/campaignIdParam'
  200. - $ref: '#/components/parameters/unitIdParam'
  201. - $ref: '#/components/parameters/zoneParam'
  202. - $ref: '#/components/parameters/navigationLinksParam'
  203. responses:
  204. 200:
  205. description: JSON Object containing info about the unit within its campaign' scope
  206. content:
  207. application/json:
  208. schema:
  209. $ref: '#/components/schemas/CampaignUnitDetailInfo'
  210. default:
  211. description: unexpected error
  212. content:
  213. application/json:
  214. schema:
  215. $ref: '#/components/schemas/Error'
  216. /campaigns/{campaignId}/units/{unitId}/observations:
  217. get:
  218. operationId: campaignIdUnitIdObservationsGET
  219. summary: Publish info about all data of the unit within the campaign
  220. security:
  221. - hubJwtAuth: [ telemetry:read ]
  222. parameters:
  223. - $ref: '#/components/parameters/campaignIdParam'
  224. - $ref: '#/components/parameters/unitIdParam'
  225. - $ref: '#/components/parameters/fromParam'
  226. - $ref: '#/components/parameters/toParam'
  227. - $ref: '#/components/parameters/zoneParam'
  228. - $ref: '#/components/parameters/offsetParam'
  229. - $ref: '#/components/parameters/limitParam'
  230. - $ref: '#/components/parameters/formatParam'
  231. - $ref: '#/components/parameters/filterParam'
  232. - $ref: '#/components/parameters/navigationLinksParam'
  233. responses:
  234. 200:
  235. description: JSON containing stream of telemetry data
  236. content:
  237. application/json:
  238. schema:
  239. $ref: '#/components/schemas/CampaignUnitObservation'
  240. application/geo+json:
  241. schema:
  242. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  243. default:
  244. description: unexpected error
  245. content:
  246. application/json:
  247. schema:
  248. $ref: '#/components/schemas/Error'
  249. /campaigns/{campaignId}/units/{unitId}/observations/locations:
  250. get:
  251. operationId: campaignIdUnitIdLocationsGET
  252. summary: Publish locations of the unit within the campaign
  253. security:
  254. - hubJwtAuth: [ telemetry:read ]
  255. parameters:
  256. - $ref: '#/components/parameters/campaignIdParam'
  257. - $ref: '#/components/parameters/unitIdParam'
  258. - $ref: '#/components/parameters/fromParam'
  259. - $ref: '#/components/parameters/toParam'
  260. - $ref: '#/components/parameters/zoneParam'
  261. - $ref: '#/components/parameters/offsetParam'
  262. - $ref: '#/components/parameters/limitParam'
  263. - $ref: '#/components/parameters/filterParam'
  264. - $ref: '#/components/parameters/formatParam'
  265. - $ref: '#/components/parameters/navigationLinksParam'
  266. responses:
  267. 200:
  268. description: JSON containing stream of locations
  269. content:
  270. application/json:
  271. schema:
  272. $ref: '#/components/schemas/CampaignUnitLocation'
  273. application/geo+json:
  274. schema:
  275. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  276. default:
  277. description: unexpected error
  278. content:
  279. application/json:
  280. schema:
  281. $ref: '#/components/schemas/Error'
  282. /campaigns/{campaignId}/units/{unitId}/sensors:
  283. get:
  284. operationId: campaignIdUnitIdSensorsGET
  285. summary: Publish info about all sensors of the unit within the campaign
  286. security:
  287. - hubJwtAuth: [ telemetry:read ]
  288. parameters:
  289. - $ref: '#/components/parameters/campaignIdParam'
  290. - $ref: '#/components/parameters/unitIdParam'
  291. - $ref: '#/components/parameters/navigationLinksParam'
  292. responses:
  293. 200:
  294. description: JSON containing information of sensors assigned to the unit within its campaign
  295. content:
  296. application/json:
  297. schema:
  298. type: array
  299. items:
  300. $ref: '#/components/schemas/CampaignUnitBasicSensor'
  301. default:
  302. description: unexpected error
  303. content:
  304. application/json:
  305. schema:
  306. $ref: '#/components/schemas/Error'
  307. /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}:
  308. get:
  309. operationId: campaignIdUnitIdSensorIdGET
  310. summary: Publish info about all sensors associated with the unit and the campaign
  311. security:
  312. - hubJwtAuth: [ telemetry:read ]
  313. parameters:
  314. - $ref: '#/components/parameters/campaignIdParam'
  315. - $ref: '#/components/parameters/unitIdParam'
  316. - $ref: '#/components/parameters/sensorIdParam'
  317. - $ref: '#/components/parameters/navigationLinksParam'
  318. responses:
  319. 200:
  320. description: JSON Object containing info about the sensor
  321. content:
  322. application/json:
  323. schema:
  324. $ref: '#/components/schemas/CampaignUnitDetailedSensor'
  325. default:
  326. description: unexpected error
  327. content:
  328. application/json:
  329. schema:
  330. $ref: '#/components/schemas/Error'
  331. /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}/observations:
  332. get:
  333. operationId: campaignIdUnitIdSensorIdObservationsGET
  334. summary: Publish info about all data of the unit within the campaign
  335. security:
  336. - hubJwtAuth: [ telemetry:read ]
  337. parameters:
  338. - $ref: '#/components/parameters/campaignIdParam'
  339. - $ref: '#/components/parameters/unitIdParam'
  340. - $ref: '#/components/parameters/sensorIdParam'
  341. - $ref: '#/components/parameters/fromParam'
  342. - $ref: '#/components/parameters/toParam'
  343. - $ref: '#/components/parameters/zoneParam'
  344. - $ref: '#/components/parameters/offsetParam'
  345. - $ref: '#/components/parameters/limitParam'
  346. - $ref: '#/components/parameters/formatParam'
  347. - $ref: '#/components/parameters/filterParam'
  348. - $ref: '#/components/parameters/navigationLinksParam'
  349. responses:
  350. 200:
  351. description: JSON containing stream of telemetry data
  352. content:
  353. application/json:
  354. schema:
  355. $ref: '#/components/schemas/CampaignUnitSensorObservation'
  356. application/geo+json:
  357. schema:
  358. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  359. default:
  360. description: unexpected error
  361. content:
  362. application/json:
  363. schema:
  364. $ref: '#/components/schemas/Error'
  365. /units:
  366. get:
  367. operationId: unitsGET
  368. summary: Publish info about all units
  369. security:
  370. - hubJwtAuth: [ telemetry:read ]
  371. parameters:
  372. - $ref: '#/components/parameters/navigationLinksParam'
  373. responses:
  374. 200:
  375. description: JSON array of basic info of each unit
  376. content:
  377. application/json:
  378. schema:
  379. type: array
  380. items:
  381. $ref: '#/components/schemas/UnitBasicInfo'
  382. default:
  383. description: unexpected error
  384. content:
  385. application/json:
  386. schema:
  387. $ref: '#/components/schemas/Error'
  388. /units/{unitId}:
  389. get:
  390. operationId: unitIdGET
  391. summary: Publish info about the unit
  392. security:
  393. - hubJwtAuth: [ telemetry:read ]
  394. parameters:
  395. - $ref: '#/components/parameters/unitIdParam'
  396. - $ref: '#/components/parameters/navigationLinksParam'
  397. responses:
  398. 200:
  399. description: JSON Object of info of the unit
  400. content:
  401. application/json:
  402. schema:
  403. $ref: '#/components/schemas/UnitDetailInfo'
  404. default:
  405. description: unexpected error
  406. content:
  407. application/json:
  408. schema:
  409. $ref: '#/components/schemas/Error'
  410. /units/{unitId}/sensors:
  411. get:
  412. operationId: unitIdSensorsGET
  413. summary: Publish info about sensors assigned to the unit
  414. security:
  415. - hubJwtAuth: [ telemetry:read ]
  416. parameters:
  417. - $ref: '#/components/parameters/unitIdParam'
  418. - $ref: '#/components/parameters/navigationLinksParam'
  419. responses:
  420. 200:
  421. description: JSON Array of info of the sensors
  422. content:
  423. application/json:
  424. schema:
  425. type: array
  426. items:
  427. $ref: '#/components/schemas/UnitSensorBasicInfo'
  428. default:
  429. description: unexpected error
  430. content:
  431. application/json:
  432. schema:
  433. $ref: '#/components/schemas/Error'
  434. /units/{unitId}/campaigns:
  435. get:
  436. operationId: unitIdCampaignsGET
  437. summary: Publish info about campaigns where the unit was/is assigned
  438. security:
  439. - hubJwtAuth: [ telemetry:read ]
  440. parameters:
  441. - $ref: '#/components/parameters/unitIdParam'
  442. - $ref: '#/components/parameters/zoneParam'
  443. - $ref: '#/components/parameters/navigationLinksParam'
  444. responses:
  445. 200:
  446. description: JSON Array of info about campaigns
  447. content:
  448. application/json:
  449. schema:
  450. type: array
  451. items:
  452. $ref: '#/components/schemas/UnitCampaignBasicInfo'
  453. default:
  454. description: unexpected error
  455. content:
  456. application/json:
  457. schema:
  458. $ref: '#/components/schemas/Error'
  459. /units/{unitId}/drivers:
  460. get:
  461. operationId: unitIdDriversGET
  462. summary: Publish basic info about drivers who performed actions upon the unit
  463. security:
  464. - hubJwtAuth: [ telemetry:read ]
  465. parameters:
  466. - $ref: '#/components/parameters/unitIdParam'
  467. - $ref: '#/components/parameters/navigationLinksParam'
  468. responses:
  469. 200:
  470. description: JSON Array of drivers
  471. content:
  472. application/json:
  473. schema:
  474. type: array
  475. items:
  476. $ref: '#/components/schemas/UnitDriverBasicInfo'
  477. default:
  478. description: unexpected error
  479. content:
  480. application/json:
  481. schema:
  482. $ref: '#/components/schemas/Error'
  483. /sensors:
  484. get:
  485. operationId: sensorsGET
  486. summary: Publish info about all sensors
  487. security:
  488. - hubJwtAuth: [ telemetry:read ]
  489. parameters:
  490. - $ref: '#/components/parameters/navigationLinksParam'
  491. responses:
  492. 200:
  493. description: JSON Array of info about sensors
  494. content:
  495. application/json:
  496. schema:
  497. type: array
  498. items:
  499. $ref: '#/components/schemas/SensorBasicInfo'
  500. default:
  501. description: unexpected error
  502. content:
  503. application/json:
  504. schema:
  505. $ref: '#/components/schemas/Error'
  506. /sensors/{sensorId}:
  507. get:
  508. operationId: sensorIdGET
  509. summary: Publish info about the sensor
  510. security:
  511. - hubJwtAuth: [ telemetry:read ]
  512. parameters:
  513. - $ref: '#/components/parameters/sensorIdParam'
  514. - $ref: '#/components/parameters/navigationLinksParam'
  515. responses:
  516. 200:
  517. description: JSON Object of info about the sensor
  518. content:
  519. application/json:
  520. schema:
  521. $ref: '#/components/schemas/SensorDetailInfo'
  522. default:
  523. description: unexpected error
  524. content:
  525. application/json:
  526. schema:
  527. $ref: '#/components/schemas/Error'
  528. /sensors/{sensorId}/units:
  529. get:
  530. operationId: sensorIdUnitsGET
  531. summary: Publish info about units to whom the sensor is assigned
  532. security:
  533. - hubJwtAuth: [ telemetry:read ]
  534. parameters:
  535. - $ref: '#/components/parameters/sensorIdParam'
  536. - $ref: '#/components/parameters/navigationLinksParam'
  537. responses:
  538. 200:
  539. description: JSON Array of info about the units
  540. content:
  541. application/json:
  542. schema:
  543. type: array
  544. items:
  545. $ref: '#/components/schemas/SensorUnitBasicInfo'
  546. default:
  547. description: unexpected error
  548. content:
  549. application/json:
  550. schema:
  551. $ref: '#/components/schemas/Error'
  552. /phenomenons:
  553. get:
  554. operationId: phenomenonsGET
  555. summary: Publish info about all phenomenons
  556. security:
  557. - hubJwtAuth: [ telemetry:read ]
  558. parameters:
  559. - $ref: '#/components/parameters/navigationLinksParam'
  560. responses:
  561. 200:
  562. description: JSON Array of info about phenomenons
  563. content:
  564. application/json:
  565. schema:
  566. type: array
  567. items:
  568. $ref: '#/components/schemas/PhenomenonBasicInfo'
  569. default:
  570. description: unexpected error
  571. content:
  572. application/json:
  573. schema:
  574. $ref: '#/components/schemas/Error'
  575. /phenomenons/{phenomenonId}:
  576. get:
  577. operationId: phenomenonIdGET
  578. summary: Publish info about the phenomenon
  579. security:
  580. - hubJwtAuth: [ telemetry:read ]
  581. parameters:
  582. - $ref: '#/components/parameters/phenomenonIdParam'
  583. - $ref: '#/components/parameters/navigationLinksParam'
  584. responses:
  585. 200:
  586. description: JSON Object of info about the phenomenon
  587. content:
  588. application/json:
  589. schema:
  590. $ref: '#/components/schemas/PhenomenonDetailInfo'
  591. default:
  592. description: unexpected error
  593. content:
  594. application/json:
  595. schema:
  596. $ref: '#/components/schemas/Error'
  597. /phenomenons/{phenomenonId}/sensors:
  598. get:
  599. operationId: phenomenonIdSensorsGET
  600. summary: Publish info about sensors of the phenomenon
  601. security:
  602. - hubJwtAuth: [ telemetry:read ]
  603. parameters:
  604. - $ref: '#/components/parameters/phenomenonIdParam'
  605. - $ref: '#/components/parameters/navigationLinksParam'
  606. responses:
  607. 200:
  608. description: JSON Array of info about sensors
  609. content:
  610. application/json:
  611. schema:
  612. type: array
  613. items:
  614. $ref: '#/components/schemas/PhenomenonSensorBasicInfo'
  615. default:
  616. description: unexpected error
  617. content:
  618. application/json:
  619. schema:
  620. $ref: '#/components/schemas/Error'
  621. /drivers:
  622. get:
  623. operationId: driversGET
  624. summary: Publish basic info about all drivers
  625. security:
  626. - hubJwtAuth: [ telemetry:read ]
  627. parameters:
  628. - $ref: '#/components/parameters/navigationLinksParam'
  629. responses:
  630. 200:
  631. description: JSON Array of basic info about drivers
  632. content:
  633. application/json:
  634. schema:
  635. type: array
  636. items:
  637. $ref: '#/components/schemas/DriverBasicInfo'
  638. default:
  639. description: unexpected error
  640. content:
  641. application/json:
  642. schema:
  643. $ref: '#/components/schemas/Error'
  644. /drivers/{driverId}:
  645. get:
  646. operationId: driverIdGET
  647. summary: Publish detailed info about the driver
  648. security:
  649. - hubJwtAuth: [ telemetry:read ]
  650. parameters:
  651. - $ref: '#/components/parameters/driverIdParam'
  652. - $ref: '#/components/parameters/navigationLinksParam'
  653. responses:
  654. 200:
  655. description: JSON Object of detailed info about the driver
  656. content:
  657. application/json:
  658. schema:
  659. $ref: '#/components/schemas/DriverDetailInfo'
  660. default:
  661. description: unexpected error
  662. content:
  663. application/json:
  664. schema:
  665. $ref: '#/components/schemas/Error'
  666. /drivers/{driverId}/units:
  667. get:
  668. operationId: driverIdUnitsGET
  669. summary: Publish basic info about driver's units
  670. security:
  671. - hubJwtAuth: [ telemetry:read ]
  672. parameters:
  673. - $ref: '#/components/parameters/driverIdParam'
  674. - $ref: '#/components/parameters/fromParam'
  675. - $ref: '#/components/parameters/toParam'
  676. - $ref: '#/components/parameters/navigationLinksParam'
  677. responses:
  678. 200:
  679. description: JSON Array of basic info about units
  680. content:
  681. application/json:
  682. schema:
  683. type: array
  684. items:
  685. $ref: '#/components/schemas/DriverUnitBasicInfo'
  686. default:
  687. description: unexpected error
  688. content:
  689. application/json:
  690. schema:
  691. $ref: '#/components/schemas/Error'
  692. /drivers/{driverId}/units/{unitId}:
  693. get:
  694. operationId: driverIdUnitIdGET
  695. summary: Publish detailed info about driver's unit
  696. security:
  697. - hubJwtAuth: [ telemetry:read ]
  698. parameters:
  699. - $ref: '#/components/parameters/driverIdParam'
  700. - $ref: '#/components/parameters/unitIdParam'
  701. - $ref: '#/components/parameters/navigationLinksParam'
  702. responses:
  703. 200:
  704. description: JSON Object of detailed info about driver's unit
  705. content:
  706. application/json:
  707. schema:
  708. $ref: '#/components/schemas/DriverUnitDetailInfo'
  709. default:
  710. description: unexpected error
  711. content:
  712. application/json:
  713. schema:
  714. $ref: '#/components/schemas/Error'
  715. /drivers/{driverId}/units/{unitId}/actions:
  716. get:
  717. operationId: driverIdUnitIdActionsGET
  718. summary: Publish basic info actions performed on the unit by the driver
  719. security:
  720. - hubJwtAuth: [ telemetry:read ]
  721. parameters:
  722. - $ref: '#/components/parameters/driverIdParam'
  723. - $ref: '#/components/parameters/unitIdParam'
  724. - $ref: '#/components/parameters/navigationLinksParam'
  725. responses:
  726. 200:
  727. description: JSON Object of actions
  728. content:
  729. application/json:
  730. schema:
  731. type: array
  732. items:
  733. $ref: '#/components/schemas/DriverUnitActionBasicInfo'
  734. default:
  735. description: unexpected error
  736. content:
  737. application/json:
  738. schema:
  739. $ref: '#/components/schemas/Error'
  740. /drivers/{driverId}/actions:
  741. get:
  742. operationId: driverIdActionsGET
  743. summary: Publish basic info about driver's actions
  744. security:
  745. - hubJwtAuth: [ telemetry:read ]
  746. parameters:
  747. - $ref: '#/components/parameters/driverIdParam'
  748. - $ref: '#/components/parameters/fromParam'
  749. - $ref: '#/components/parameters/toParam'
  750. - $ref: '#/components/parameters/navigationLinksParam'
  751. responses:
  752. 200:
  753. description: JSON Array of basic info about driver's actions'
  754. content:
  755. application/json:
  756. schema:
  757. type: array
  758. items:
  759. $ref: '#/components/schemas/DriverActionBasicInfo'
  760. default:
  761. description: unexpected error
  762. content:
  763. application/json:
  764. schema:
  765. $ref: '#/components/schemas/Error'
  766. /drivers/{driverId}/actions/{actionId}:
  767. get:
  768. operationId: driverIdActionIdGET
  769. summary: Publish detailed info about the driver's action
  770. security:
  771. - hubJwtAuth: [ telemetry:read ]
  772. parameters:
  773. - $ref: '#/components/parameters/driverIdParam'
  774. - $ref: '#/components/parameters/actionIdParam'
  775. - $ref: '#/components/parameters/navigationLinksParam'
  776. responses:
  777. 200:
  778. description: JSON Object of detailed info about the driver's action
  779. content:
  780. application/json:
  781. schema:
  782. $ref: '#/components/schemas/DriverActionDetailInfo'
  783. default:
  784. description: unexpected error
  785. content:
  786. application/json:
  787. schema:
  788. $ref: '#/components/schemas/Error'
  789. /drivers/{driverId}/actions/{actionId}/units:
  790. get:
  791. operationId: driverIdActionIdUnitsGET
  792. summary: Publish basic info about units on which the driver performed its action
  793. security:
  794. - hubJwtAuth: [ telemetry:read ]
  795. parameters:
  796. - $ref: '#/components/parameters/driverIdParam'
  797. - $ref: '#/components/parameters/actionIdParam'
  798. - $ref: '#/components/parameters/navigationLinksParam'
  799. responses:
  800. 200:
  801. description: JSON Array of units
  802. content:
  803. application/json:
  804. schema:
  805. type: array
  806. items:
  807. $ref: '#/components/schemas/DriverActionUnitBasicInfo'
  808. default:
  809. description: unexpected error
  810. content:
  811. application/json:
  812. schema:
  813. $ref: '#/components/schemas/Error'
  814. /drivers/{driverId}/actions/{actionId}/units/{unitId}:
  815. get:
  816. operationId: driverIdActionIdUnitIdGET
  817. summary: Publish detail info about the unit on which the driver performed the action
  818. security:
  819. - hubJwtAuth: [ telemetry:read ]
  820. parameters:
  821. - $ref: '#/components/parameters/driverIdParam'
  822. - $ref: '#/components/parameters/actionIdParam'
  823. - $ref: '#/components/parameters/unitIdParam'
  824. - $ref: '#/components/parameters/navigationLinksParam'
  825. responses:
  826. 200:
  827. description: JSON Object of the unit
  828. content:
  829. application/json:
  830. schema:
  831. $ref: '#/components/schemas/DriverActionUnitDetailInfo'
  832. default:
  833. description: unexpected error
  834. content:
  835. application/json:
  836. schema:
  837. $ref: '#/components/schemas/Error'
  838. /drivers/{driverId}/units/{unitId}/actions/{actionId}:
  839. get:
  840. operationId: driverIdUnitIdActionIdGET
  841. summary: Publish detailed info about the action performed on the unit by the driver
  842. security:
  843. - hubJwtAuth: [ telemetry:read ]
  844. parameters:
  845. - $ref: '#/components/parameters/driverIdParam'
  846. - $ref: '#/components/parameters/unitIdParam'
  847. - $ref: '#/components/parameters/actionIdParam'
  848. - $ref: '#/components/parameters/navigationLinksParam'
  849. responses:
  850. 200:
  851. description: JSON Object of the action
  852. content:
  853. application/json:
  854. schema:
  855. $ref: '#/components/schemas/DriverUnitActionDetailInfo'
  856. default:
  857. description: unexpected error
  858. content:
  859. application/json:
  860. schema:
  861. $ref: '#/components/schemas/Error'
  862. /drivers/{driverId}/units/{unitId}/actions/{actionId}/events:
  863. get:
  864. operationId: driverIdUnitIdActionIdEventsGET
  865. summary: Publish basic info about events that where performed on the unit byt the driver with the specific action
  866. security:
  867. - hubJwtAuth: [ telemetry:read ]
  868. parameters:
  869. - $ref: '#/components/parameters/driverIdParam'
  870. - $ref: '#/components/parameters/unitIdParam'
  871. - $ref: '#/components/parameters/actionIdParam'
  872. - $ref: '#/components/parameters/zoneParam'
  873. - $ref: '#/components/parameters/navigationLinksParam'
  874. responses:
  875. 200:
  876. description: JSON Array of events
  877. content:
  878. application/json:
  879. schema:
  880. type: array
  881. items:
  882. $ref: '#/components/schemas/EventBasicInfo'
  883. default:
  884. description: unexpected error
  885. content:
  886. application/json:
  887. schema:
  888. $ref: '#/components/schemas/Error'
  889. /events/{eventId}:
  890. get:
  891. operationId: eventIdGET
  892. summary: Publish basic info about events that where performed on the unit byt the driver with the specific action
  893. security:
  894. - hubJwtAuth: [ telemetry:read ]
  895. parameters:
  896. - $ref: '#/components/parameters/eventIdParam'
  897. - $ref: '#/components/parameters/zoneParam'
  898. - $ref: '#/components/parameters/navigationLinksParam'
  899. responses:
  900. 200:
  901. description: JSON Array of events
  902. content:
  903. application/json:
  904. schema:
  905. $ref: '#/components/schemas/EventDetailInfo'
  906. default:
  907. description: unexpected error
  908. content:
  909. application/json:
  910. schema:
  911. $ref: '#/components/schemas/Error'
  912. /events/{eventId}/observations:
  913. get:
  914. operationId: eventIdObservationsGET
  915. summary: Publish telemetry observations created by the driver while performing specific action on the unit at the time/event
  916. security:
  917. - hubJwtAuth: [ telemetry:read ]
  918. parameters:
  919. - $ref: '#/components/parameters/eventIdParam'
  920. - $ref: '#/components/parameters/zoneParam'
  921. - $ref: '#/components/parameters/offsetParam'
  922. - $ref: '#/components/parameters/limitParam'
  923. - $ref: '#/components/parameters/formatParam'
  924. - $ref: '#/components/parameters/filterParam'
  925. - $ref: '#/components/parameters/navigationLinksParam'
  926. responses:
  927. 200:
  928. description: JSON Object of telemetry observations
  929. content:
  930. application/json:
  931. schema:
  932. $ref: '#/components/schemas/ActionEventObservation'
  933. application/geo+json:
  934. schema:
  935. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  936. default:
  937. description: unexpected error
  938. content:
  939. application/json:
  940. schema:
  941. $ref: '#/components/schemas/Error'
  942. /events/{eventId}/observations/locations:
  943. get:
  944. operationId: eventIdLocationsGET
  945. summary: Publish locations created by the driver while performing specific action on the unit at the time/event
  946. security:
  947. - hubJwtAuth: [ telemetry:read ]
  948. parameters:
  949. - $ref: '#/components/parameters/eventIdParam'
  950. - $ref: '#/components/parameters/fromParam'
  951. - $ref: '#/components/parameters/toParam'
  952. - $ref: '#/components/parameters/zoneParam'
  953. - $ref: '#/components/parameters/offsetParam'
  954. - $ref: '#/components/parameters/limitParam'
  955. - $ref: '#/components/parameters/formatParam'
  956. - $ref: '#/components/parameters/filterParam'
  957. - $ref: '#/components/parameters/navigationLinksParam'
  958. responses:
  959. 200:
  960. description: JSON containing stream of locations
  961. content:
  962. application/json:
  963. schema:
  964. $ref: '#/components/schemas/ActionEventLocation'
  965. application/geo+json:
  966. schema:
  967. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  968. default:
  969. description: unexpected error
  970. content:
  971. application/json:
  972. schema:
  973. $ref: '#/components/schemas/Error'
  974. components:
  975. securitySchemes:
  976. hubJwtAuth:
  977. type: http
  978. scheme: bearer
  979. bearerFormat: JWT
  980. parameters:
  981. campaignIdParam:
  982. in: path
  983. name: campaignId
  984. schema:
  985. type: integer
  986. format: int64
  987. required: true
  988. description: Numeric ID of the campaign to get
  989. unitIdParam:
  990. in: path
  991. name: unitId
  992. schema:
  993. type: integer
  994. required: true
  995. description: Numeric ID of the unit to get
  996. sensorIdParam:
  997. in: path
  998. name: sensorId
  999. schema:
  1000. type: integer
  1001. required: true
  1002. description: Numeric ID of the sensor to get
  1003. phenomenonIdParam:
  1004. in: path
  1005. name: phenomenonId
  1006. schema:
  1007. type: integer
  1008. format: int64
  1009. required: true
  1010. description: Numeric ID of the phenomenon to get
  1011. driverIdParam:
  1012. in: path
  1013. name: driverId
  1014. schema:
  1015. type: integer
  1016. format: int64
  1017. required: true
  1018. description: Numeric ID of the driver to get
  1019. actionIdParam:
  1020. in: path
  1021. name: actionId
  1022. schema:
  1023. type: integer
  1024. format: int64
  1025. required: true
  1026. description: Numeric ID of the action to get
  1027. eventIdParam:
  1028. in: path
  1029. name: eventId
  1030. schema:
  1031. type: integer
  1032. format: int64
  1033. required: true
  1034. description: Numeric ID of the event to get
  1035. zoneParam:
  1036. in: query
  1037. name: zone
  1038. schema:
  1039. type: string
  1040. default: UTC
  1041. required: false
  1042. examples:
  1043. UTC:
  1044. value: UTC
  1045. GMT:
  1046. value: GMT
  1047. navigationLinksParam:
  1048. in: query
  1049. name: navigationLinks
  1050. schema:
  1051. type: boolean
  1052. default: true
  1053. description: Option to disable @NavigationLinks in a response
  1054. limitParam:
  1055. in: query
  1056. name: limit
  1057. schema:
  1058. type: integer
  1059. format: int64
  1060. required: false
  1061. example: 100
  1062. offsetParam:
  1063. in: query
  1064. name: offset
  1065. schema:
  1066. type: integer
  1067. format: int64
  1068. example: 100
  1069. fromParam:
  1070. in: query
  1071. name: from
  1072. schema:
  1073. type: string
  1074. format: date-time
  1075. required: false
  1076. example: 2017-07-21T17:32:28Z
  1077. toParam:
  1078. in: query
  1079. name: to
  1080. schema:
  1081. type: string
  1082. format: date-time
  1083. required: false
  1084. example: 2017-07-21T17:32:28Z
  1085. limitPerUnitParam:
  1086. in: query
  1087. name: limitPerUnit
  1088. required: true
  1089. schema:
  1090. type: integer
  1091. default: 1
  1092. examples:
  1093. One locations:
  1094. value: 1
  1095. summary: One location of each unit
  1096. sortParam:
  1097. in: query
  1098. name: sort
  1099. schema:
  1100. type: string
  1101. enum: [ asc, desc ]
  1102. default: asc
  1103. examples:
  1104. Descending Order:
  1105. value: desc
  1106. summary: Last location of the units. Last location is combination of sort=desc & limitPerUnit=1
  1107. Ascending Order:
  1108. value: asc
  1109. filterParam:
  1110. in: query
  1111. name: filter
  1112. description: Filter for results following the pattern
  1113. <unit | sensor>(<numeric_float_id | speed | longitude | latitude | altitude>)<lt | le | eq | ne | ge | lt><float_value>, e.g,
  1114. schema:
  1115. type: string
  1116. required: false
  1117. examples:
  1118. Units latitude:
  1119. value: unit(latitude)lt50.1
  1120. summary: Returns all units with its latitude coordination lower than (LT) 50.1
  1121. Units speed:
  1122. value: unit(speed)gt90.0
  1123. summary: Returns all units with its speed greater than 90.0 Km/h
  1124. Sensor ID value:
  1125. value: sensor(105)gt10
  1126. summary: Returns sensors having its value greater than 10
  1127. formatParam:
  1128. in: query
  1129. name: format
  1130. schema:
  1131. type: string
  1132. enum: [json, geojson]
  1133. default: json
  1134. required: false
  1135. schemas:
  1136. CampaignBasicInfo:
  1137. type: object
  1138. required:
  1139. - id
  1140. - fromTime
  1141. - toTime
  1142. x-NavigationLinks:
  1143. Campaign@NavigationLink:
  1144. type: string
  1145. format: uri
  1146. x-graph-properties:
  1147. linkTo: campaignIdGET
  1148. color: blue
  1149. properties:
  1150. Campaign@NavigationLink:
  1151. $ref: '#/components/schemas/CampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
  1152. id:
  1153. type: integer
  1154. format: int64
  1155. description:
  1156. type: string
  1157. fromTime:
  1158. type: string
  1159. format: date-time
  1160. toTime:
  1161. type: string
  1162. format: date-time
  1163. example:
  1164. Campaign@NavigationLink: "<domain>/campaigns/1"
  1165. id: 1
  1166. description: "Campaign 1"
  1167. fromTime: "2023-01-25 15:35:32Z"
  1168. toTime: "2023-03-20 10:35:32Z"
  1169. CampaignDetailInfo:
  1170. type: object
  1171. required:
  1172. - id
  1173. - fromTime
  1174. - toTime
  1175. x-NavigationLinks:
  1176. self@NavigationLink:
  1177. type: string
  1178. format: uri
  1179. x-graph-properties:
  1180. linkTo: campaignIdGET
  1181. Observations@NavigationLink:
  1182. type: string
  1183. format: uri
  1184. x-graph-properties:
  1185. linkTo: campaignIdUnitsObservationsGET
  1186. Locations@NavigationLink:
  1187. type: string
  1188. format: uri
  1189. x-graph-properties:
  1190. linkTo: campaignIdUnitsObservationsLocationsGET
  1191. Units@NavigationLink:
  1192. type: string
  1193. format: uri
  1194. x-graph-properties:
  1195. linkTo: campaignIdUnitsGET
  1196. properties:
  1197. self@NavigationLink:
  1198. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/self@NavigationLink'
  1199. Observations@NavigationLink:
  1200. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  1201. Locations@NavigationLink:
  1202. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  1203. Units@NavigationLink:
  1204. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Units@NavigationLink'
  1205. id:
  1206. description: Identifier of the campaign
  1207. type: integer
  1208. format: int64
  1209. description:
  1210. description: Text description of the campaign
  1211. type: string
  1212. fromTime:
  1213. description: Time when the campaign starts
  1214. type: string
  1215. format: date-time
  1216. toTime:
  1217. description: Time when the campaign ends
  1218. type: string
  1219. format: date-time
  1220. example:
  1221. self@NavigationLink: "<domain>/campaigns/1"
  1222. Observations@NavigationLink: "<domain>/campaigns/1/units/observations"
  1223. Locations@NavigationLink: "<domain>/campaigns/1/units/observations/locations"
  1224. Units@NavigationLink: "<domain>/campaigns/1/units"
  1225. id: 1
  1226. description: "Campaign example"
  1227. fromTime: "2023-01-25 15:35:32Z"
  1228. toTime: "2023-03-20 10:35:32Z"
  1229. CampaignUnitBasicInfo:
  1230. type: object
  1231. required:
  1232. - unitId
  1233. - name
  1234. - fromTime
  1235. - toTime
  1236. x-NavigationLinks:
  1237. Unit@NavigationLink:
  1238. type: string
  1239. format: uri
  1240. x-graph-properties:
  1241. linkTo: unitIdGET
  1242. CampaignUnit@NavigationLink:
  1243. type: string
  1244. format: uri
  1245. x-graph-properties:
  1246. linkTo: campaignIdUnitIdGET
  1247. properties:
  1248. Unit@NavigationLink:
  1249. $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
  1250. CampaignUnit@NavigationLink:
  1251. $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/CampaignUnit@NavigationLink'
  1252. unitId:
  1253. description: Identifier of the unit
  1254. type: integer
  1255. format: int64
  1256. name:
  1257. type: string
  1258. description:
  1259. type: string
  1260. fromTime:
  1261. description: Time when the validity of the unit starts within the campaign
  1262. type: string
  1263. format: date-time
  1264. toTime:
  1265. description: Time when the validity of the unit ends within the campaign
  1266. type: string
  1267. format: date-time
  1268. example:
  1269. Unit@NavigationLink: "<domain>/units/25"
  1270. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  1271. unitId: 25
  1272. name: "Unit name"
  1273. description: "Purpose of the Unit 25"
  1274. fromTime: "2023-01-25 15:35:32Z"
  1275. toTime: "2023-03-20 10:35:32Z"
  1276. CampaignUnitDetailInfo:
  1277. type: object
  1278. required:
  1279. - unitId
  1280. - imei
  1281. - fromTime
  1282. - toTime
  1283. x-NavigationLinks:
  1284. self@NavigationLink:
  1285. type: string
  1286. format: uri
  1287. x-graph-properties:
  1288. linkTo: campaignIdUnitIdGET
  1289. Unit@NavigationLink:
  1290. type: string
  1291. format: uri
  1292. x-graph-properties:
  1293. linkTo: unitIdGET
  1294. Campaign@NavigationLink:
  1295. type: string
  1296. format: uri
  1297. x-graph-properties:
  1298. linkTo: campaignIdGET
  1299. Sensors@NavigationLink:
  1300. type: string
  1301. format: uri
  1302. x-graph-properties:
  1303. linkTo: campaignIdUnitIdSensorsGET
  1304. Observations@NavigationLink:
  1305. type: string
  1306. format: uri
  1307. x-graph-properties:
  1308. linkTo: campaignIdUnitIdObservationsGET
  1309. Locations@NavigationLink:
  1310. type: string
  1311. format: uri
  1312. x-graph-properties:
  1313. linkTo: campaignIdUnitIdLocationsGET
  1314. properties:
  1315. self@NavigationLink:
  1316. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  1317. Unit@NavigationLink:
  1318. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  1319. Campaign@NavigationLink:
  1320. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Campaign@NavigationLink'
  1321. Sensors@NavigationLink:
  1322. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  1323. Observations@NavigationLink:
  1324. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  1325. Locations@NavigationLink:
  1326. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  1327. unitId:
  1328. description: Identifier of the unit
  1329. type: integer
  1330. format: int64
  1331. imei:
  1332. type: string
  1333. description:
  1334. type: string
  1335. fromTime:
  1336. description: Time when the validity of the unit starts within the campaign
  1337. type: string
  1338. format: date-time
  1339. toTime:
  1340. description: Time when the validity of the unit ends within the campaign
  1341. type: string
  1342. format: date-time
  1343. example:
  1344. self@NavigationLink: "<domain>/campaigns/1/units/25"
  1345. Unit@NavigationLink: "<domain>/units/25"
  1346. Campaign@NavigationLink: "<domain>/campaigns/1"
  1347. Sensors@NavigationLink: "<domain>/campaigns/1/units/25/sensors"
  1348. Observations@NavigationLink: "<domain>/campaigns/1/units/25/observations"
  1349. Locations@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations"
  1350. unitId: 25
  1351. imei: "3434533453"
  1352. description: "Purpose of the Unit 25"
  1353. fromTime: "2023-01-25 15:35:32Z"
  1354. toTime: "2023-03-20 10:35:32Z"
  1355. CampaignUnitBasicSensor:
  1356. type: object
  1357. required:
  1358. - sensorId
  1359. - name
  1360. - type
  1361. x-NavigationLinks:
  1362. CampaignSensor@NavigationLink:
  1363. type: string
  1364. format: uri
  1365. x-graph-properties:
  1366. linkTo: campaignIdUnitIdSensorIdGET
  1367. properties:
  1368. CampaignSensor@NavigationLink:
  1369. $ref: '#/components/schemas/CampaignUnitBasicSensor/x-NavigationLinks/CampaignSensor@NavigationLink'
  1370. sensorId:
  1371. description: Identifier of the unit
  1372. type: integer
  1373. format: int64
  1374. name:
  1375. type: string
  1376. type:
  1377. type: string
  1378. example:
  1379. CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  1380. sensorId: 105
  1381. name: "Sensor 105"
  1382. type: "X"
  1383. CampaignUnitDetailedSensor:
  1384. type: object
  1385. required:
  1386. - sensorId
  1387. - name
  1388. - phenomenon
  1389. - type
  1390. x-NavigationLinks:
  1391. self@NavigationLink:
  1392. type: string
  1393. format: uri
  1394. x-graph-properties:
  1395. linkTo: campaignIdUnitIdSensorIdGET
  1396. Sensor@NavigationLink:
  1397. type: string
  1398. format: uri
  1399. x-graph-properties:
  1400. linkTo: sensorIdGET
  1401. CampaignUnit@NavigationLink:
  1402. type: string
  1403. format: uri
  1404. x-graph-properties:
  1405. linkTo: campaignIdUnitIdGET
  1406. Phenomenon@NavigationLink:
  1407. type: string
  1408. format: uri
  1409. x-graph-properties:
  1410. linkTo: phenomenonIdGET
  1411. Observations@NavigationLink:
  1412. type: string
  1413. format: uri
  1414. x-graph-properties:
  1415. linkTo: campaignIdUnitIdSensorIdObservationsGET
  1416. properties:
  1417. self@NavigationLink:
  1418. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/self@NavigationLink'
  1419. Sensor@NavigationLink:
  1420. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Sensor@NavigationLink'
  1421. CampaignUnit@NavigationLink:
  1422. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/CampaignUnit@NavigationLink'
  1423. Phenomenon@NavigationLink:
  1424. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Phenomenon@NavigationLink'
  1425. Observations@NavigationLink:
  1426. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Observations@NavigationLink'
  1427. sensorId:
  1428. type: integer
  1429. format: int64
  1430. name:
  1431. type: string
  1432. phenomenon:
  1433. type: string
  1434. type:
  1435. type: string
  1436. description:
  1437. type: string
  1438. example:
  1439. self@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  1440. Sensor@NavigationLink: "<domain>/sensors/105"
  1441. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  1442. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  1443. Observations@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations"
  1444. sensorId: 105
  1445. name: "Sensor 105"
  1446. description: "Description of the sensor 105"
  1447. type: "type of sensor"
  1448. phenomenon: "Temperature"
  1449. CampaignObservation:
  1450. type: object
  1451. required:
  1452. - params
  1453. - hasNext
  1454. - size
  1455. - offset
  1456. - data
  1457. x-NavigationLinks:
  1458. Campaign@NavigationLink:
  1459. type: string
  1460. format: uri
  1461. x-graph-properties:
  1462. linkTo: campaignIdGET
  1463. next@NavigationLink:
  1464. type: string
  1465. format: uri
  1466. x-graph-properties:
  1467. linkTo: campaignIdUnitsObservationsGET
  1468. properties:
  1469. Campaign@NavigationLink:
  1470. $ref: '#/components/schemas/CampaignObservation/x-NavigationLinks/Campaign@NavigationLink'
  1471. next@NavigationLink:
  1472. $ref: '#/components/schemas/CampaignObservation/x-NavigationLinks/next@NavigationLink'
  1473. params:
  1474. type: object
  1475. description: Used params in URL
  1476. hasNext:
  1477. type: boolean
  1478. size:
  1479. type: integer
  1480. offset:
  1481. type: integer
  1482. data:
  1483. type: array
  1484. items:
  1485. $ref: '#/components/schemas/CampaignDataObservation'
  1486. example:
  1487. Campaign@NavigationLink: "<domain>/campaigns/1"
  1488. next@NavigationLink: "<domain>/campaigns/1/observations?offset=500"
  1489. size: 500
  1490. offset: 0
  1491. data: []
  1492. GeoFeatureCollectionUnit:
  1493. type: object
  1494. required:
  1495. - type
  1496. - features
  1497. properties:
  1498. type:
  1499. type: string
  1500. enum:
  1501. - FeatureCollection
  1502. metadata:
  1503. type: object
  1504. features:
  1505. type: array
  1506. minLength: 1
  1507. items:
  1508. $ref: '#/components/schemas/GeoFeatureUnitObservation'
  1509. GeoFeatureUnitObservation:
  1510. type: object
  1511. required:
  1512. - type
  1513. - geometry
  1514. - properties
  1515. properties:
  1516. type:
  1517. type: string
  1518. enum:
  1519. - Feature
  1520. geometry:
  1521. $ref: '#/components/schemas/GeoPoint'
  1522. properties:
  1523. type: object
  1524. required:
  1525. - unitId
  1526. - timestamp
  1527. - speed
  1528. properties:
  1529. unitId:
  1530. type: integer
  1531. format: int64
  1532. timestamp:
  1533. type: string
  1534. format: date-time
  1535. speed:
  1536. type: integer
  1537. format: int64
  1538. observedValues:
  1539. type: object
  1540. GeoPoint:
  1541. type: object
  1542. required:
  1543. - type
  1544. - coordinates
  1545. properties:
  1546. type:
  1547. type: string
  1548. enum:
  1549. - Point
  1550. coordinates:
  1551. type: array
  1552. items:
  1553. type: number
  1554. format: float
  1555. minLength: 3
  1556. maxLength: 3
  1557. description: "[lon, lat, alt]"
  1558. CampaignUnitObservation:
  1559. type: object
  1560. required:
  1561. - params
  1562. - hasNext
  1563. - size
  1564. - offset
  1565. - data
  1566. x-NavigationLinks:
  1567. CampaignUnit@NavigationLink:
  1568. type: string
  1569. format: uri
  1570. x-graph-properties:
  1571. linkTo: campaignIdUnitIdGET
  1572. next@NavigationLink:
  1573. type: string
  1574. format: uri
  1575. x-graph-properties:
  1576. linkTo: campaignIdUnitIdObservationsGET
  1577. properties:
  1578. CampaignUnit@NavigationLink:
  1579. $ref: '#/components/schemas/CampaignUnitObservation/x-NavigationLinks/CampaignUnit@NavigationLink'
  1580. next@NavigationLink:
  1581. $ref: '#/components/schemas/CampaignUnitObservation/x-NavigationLinks/next@NavigationLink'
  1582. params:
  1583. type: object
  1584. description: Used params in URL
  1585. hasNext:
  1586. type: boolean
  1587. size:
  1588. type: integer
  1589. offset:
  1590. type: integer
  1591. data:
  1592. type: array
  1593. items:
  1594. $ref: '#/components/schemas/UnitDataObservation'
  1595. example:
  1596. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  1597. next@NavigationLink: "<domain>/campaigns/1/units/25/observations?offset=500"
  1598. params: []
  1599. size: 500
  1600. hasNext: true
  1601. offset: 0
  1602. data: []
  1603. CampaignUnitSensorObservation:
  1604. type: object
  1605. required:
  1606. - params
  1607. - size
  1608. - offset
  1609. - hasNext
  1610. - data
  1611. x-NavigationLinks:
  1612. CampaignSensor@NavigationLink:
  1613. type: string
  1614. format: uri
  1615. x-graph-properties:
  1616. linkTo: campaignIdUnitIdSensorIdGET
  1617. next@NavigationLink:
  1618. type: string
  1619. format: uri
  1620. x-graph-properties:
  1621. linkTo: campaignIdUnitIdSensorIdObservationsGET
  1622. properties:
  1623. CampaignSensor@NavigationLink:
  1624. $ref: '#/components/schemas/CampaignUnitSensorObservation/x-NavigationLinks/CampaignSensor@NavigationLink'
  1625. next@NavigationLink:
  1626. $ref: '#/components/schemas/CampaignUnitSensorObservation/x-NavigationLinks/next@NavigationLink'
  1627. params:
  1628. type: object
  1629. description: Used params in URL
  1630. size:
  1631. type: integer
  1632. offset:
  1633. type: integer
  1634. hasNext:
  1635. type: boolean
  1636. data:
  1637. type: array
  1638. items:
  1639. $ref: '#/components/schemas/SensorDataObservation'
  1640. example:
  1641. CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  1642. next@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations?offset=500"
  1643. size: 500
  1644. offset: 0
  1645. data: []
  1646. ActionEventObservation:
  1647. type: object
  1648. required:
  1649. - params
  1650. - hasNext
  1651. - size
  1652. - offset
  1653. - data
  1654. x-NavigationLinks:
  1655. Event@NavigationLink:
  1656. type: string
  1657. format: uri
  1658. x-graph-properties:
  1659. linkTo: eventIdGET
  1660. next@NavigationLink:
  1661. type: string
  1662. format: uri
  1663. x-graph-properties:
  1664. linkTo: eventIdObservationsGET
  1665. properties:
  1666. Event@NavigationLink:
  1667. $ref: '#/components/schemas/ActionEventObservation/x-NavigationLinks/Event@NavigationLink'
  1668. next@NavigationLink:
  1669. $ref: '#/components/schemas/ActionEventObservation/x-NavigationLinks/next@NavigationLink'
  1670. params:
  1671. type: object
  1672. description: Used params in URL
  1673. hasNext:
  1674. type: boolean
  1675. size:
  1676. type: integer
  1677. offset:
  1678. type: integer
  1679. data:
  1680. type: array
  1681. items:
  1682. $ref: '#/components/schemas/UnitDataObservation'
  1683. example:
  1684. Event@NavigationLink: "<domain>/events/999"
  1685. next@NavigationLink: "<domain>/events/999/observations?offset=500"
  1686. params: []
  1687. size: 500
  1688. hasNext: true
  1689. offset: 0
  1690. data: []
  1691. CampaignDataObservation:
  1692. type: object
  1693. required:
  1694. - unitId
  1695. - timestamp
  1696. - speed
  1697. - location
  1698. - observedValues
  1699. properties:
  1700. unitId:
  1701. type: integer
  1702. format: int64
  1703. timestamp:
  1704. type: string
  1705. format: date-time
  1706. speed:
  1707. type: integer
  1708. format: int64
  1709. location:
  1710. $ref: '#/components/schemas/Location'
  1711. observedValues:
  1712. type: object
  1713. example:
  1714. unitId: 25
  1715. timestamp: "2023-01-25 15:35:32Z"
  1716. location:
  1717. longitude: 49.7384
  1718. latitude: 13.3736
  1719. altitude: 350.3
  1720. observedValues:
  1721. 105: 1434
  1722. UnitDataObservation:
  1723. type: object
  1724. required:
  1725. - timestamp
  1726. - speed
  1727. - location
  1728. - observedValues
  1729. properties:
  1730. timestamp:
  1731. type: string
  1732. format: date-time
  1733. speed:
  1734. type: integer
  1735. format: int64
  1736. location:
  1737. $ref: '#/components/schemas/Location'
  1738. observedValues:
  1739. type: object
  1740. example:
  1741. timestamp: "2023-01-25 15:35:32Z"
  1742. speed: 34
  1743. location:
  1744. longitude: 49.7384
  1745. latitude: 13.3736
  1746. altitude: 350.3
  1747. observedValues:
  1748. 105: 1434
  1749. SensorDataObservation:
  1750. type: object
  1751. required:
  1752. - timestamp
  1753. - value
  1754. - speed
  1755. - location
  1756. properties:
  1757. timestamp:
  1758. type: string
  1759. format: date-time
  1760. observedValue:
  1761. type: integer
  1762. format: int64
  1763. speed:
  1764. type: integer
  1765. format: int64
  1766. location:
  1767. $ref: '#/components/schemas/Location'
  1768. example:
  1769. timestamp: "2023-01-25 15:35:32Z"
  1770. observedValue: 1434
  1771. speed: 34
  1772. location:
  1773. longitude: 49.7384
  1774. latitude: 13.3736
  1775. altitude: 350.3
  1776. CampaignUnitLocation:
  1777. type: object
  1778. required:
  1779. - params
  1780. - hasNext
  1781. - size
  1782. - offset
  1783. - data
  1784. x-NavigationLinks:
  1785. Campaign@NavigationLink:
  1786. type: string
  1787. format: uri
  1788. x-graph-properties:
  1789. linkTo: campaignIdGET
  1790. Unit@NavigationLink:
  1791. type: string
  1792. format: uri
  1793. x-graph-properties:
  1794. linkTo: campaignIdUnitIdGET
  1795. next@NavigationLink:
  1796. type: string
  1797. format: uri
  1798. x-graph-properties:
  1799. linkTo: campaignIdUnitIdLocationsGET
  1800. properties:
  1801. Campaign@NavigationLink:
  1802. $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/Campaign@NavigationLink'
  1803. Unit@NavigationLink:
  1804. $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/Unit@NavigationLink'
  1805. next@NavigationLink:
  1806. $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/next@NavigationLink'
  1807. params:
  1808. type: object
  1809. description: Used params in URL
  1810. hasNext:
  1811. type: boolean
  1812. size:
  1813. type: integer
  1814. offset:
  1815. type: integer
  1816. data:
  1817. type: array
  1818. items:
  1819. type: object
  1820. properties:
  1821. timestamp:
  1822. type: string
  1823. format: date-time
  1824. location:
  1825. $ref: '#/components/schemas/Location'
  1826. example:
  1827. Campaign@NavigationLink: "<domain>/campaigns/1"
  1828. Unit@NavigationLink: "<domain>/campaigns/1/units/25"
  1829. next@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations?offset=500"
  1830. params:
  1831. offset: 0
  1832. limit: 500
  1833. navigationLinks: true
  1834. size: 500
  1835. hasNext: true
  1836. offset: 0
  1837. data:
  1838. - timestamp: "2023-01-25 15:35:32Z"
  1839. location:
  1840. longitude: 49.7384
  1841. latitude: 13.3736
  1842. altitude: 350.3
  1843. CampaignUnitsLocations:
  1844. type: object
  1845. required:
  1846. - size
  1847. - data
  1848. x-NavigationLinks:
  1849. Campaign@NavigationLink:
  1850. type: string
  1851. format: uri
  1852. x-graph-properties:
  1853. linkTo: campaignIdGET
  1854. properties:
  1855. Campaign@NavigationLink:
  1856. $ref: '#/components/schemas/CampaignUnitsLocations/x-NavigationLinks/Campaign@NavigationLink'
  1857. params:
  1858. type: object
  1859. description: Used params in URL
  1860. size:
  1861. type: integer
  1862. data:
  1863. type: array
  1864. items:
  1865. type: object
  1866. required:
  1867. - unitId
  1868. - timestamp
  1869. - location
  1870. properties:
  1871. unitId:
  1872. type: integer
  1873. format: int64
  1874. timestamp:
  1875. type: string
  1876. format: date-time
  1877. location:
  1878. $ref: '#/components/schemas/Location'
  1879. example:
  1880. Campaign@NavigationLink: "<domain>/campaigns/1"
  1881. params:
  1882. from: "2023-01-25 15:35:32Z"
  1883. to: "2023-01-25 15:35:32Z"
  1884. navigationLinks: true
  1885. size: 8
  1886. data:
  1887. - unitId: 25
  1888. timestamp: "2023-01-25 15:35:32Z"
  1889. location:
  1890. longitude: 49.7384
  1891. latitude: 13.3736
  1892. altitude: 350.3
  1893. GeoCampaignUnitsLocations:
  1894. type: object
  1895. required:
  1896. - type
  1897. - features
  1898. properties:
  1899. type:
  1900. type: string
  1901. enum:
  1902. - FeatureCollection
  1903. metadata:
  1904. type: object
  1905. features:
  1906. type: array
  1907. minLength: 1
  1908. items:
  1909. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  1910. GeoFeatureUnitMultiLocation:
  1911. type: object
  1912. required:
  1913. - type
  1914. - properties
  1915. - geometry
  1916. properties:
  1917. type:
  1918. type: string
  1919. enum:
  1920. - Feature
  1921. properties:
  1922. type: object
  1923. required:
  1924. - unitId
  1925. properties:
  1926. unitId:
  1927. type: integer
  1928. format: int64
  1929. geometry:
  1930. $ref: '#/components/schemas/GeoMultiPoint'
  1931. GeoMultiPoint:
  1932. type: object
  1933. required:
  1934. - type
  1935. - coordinates
  1936. properties:
  1937. type:
  1938. type: string
  1939. enum:
  1940. - MultiPoint
  1941. coordinates:
  1942. type: array
  1943. minLength: 1
  1944. items:
  1945. type: array
  1946. items:
  1947. type: integer
  1948. format: float
  1949. minLength: 3
  1950. maxLength: 3
  1951. description: "[lon, lat, alt]"
  1952. ActionEventLocation:
  1953. type: object
  1954. required:
  1955. - params
  1956. - hasNext
  1957. - size
  1958. - offset
  1959. - data
  1960. x-NavigationLinks:
  1961. Event@NavigationLink:
  1962. type: string
  1963. format: uri
  1964. x-graph-properties:
  1965. linkTo: eventIdGET
  1966. next@NavigationLink:
  1967. type: string
  1968. format: uri
  1969. x-graph-properties:
  1970. linkTo: eventIdLocationsGET
  1971. properties:
  1972. Event@NavigationLink:
  1973. $ref: '#/components/schemas/ActionEventLocation/x-NavigationLinks/Event@NavigationLink'
  1974. next@NavigationLink:
  1975. $ref: '#/components/schemas/ActionEventLocation/x-NavigationLinks/next@NavigationLink'
  1976. params:
  1977. type: object
  1978. description: Used params in URL
  1979. hasNext:
  1980. type: boolean
  1981. size:
  1982. type: integer
  1983. offset:
  1984. type: integer
  1985. data:
  1986. type: array
  1987. items:
  1988. type: object
  1989. properties:
  1990. timestamp:
  1991. type: string
  1992. format: date-time
  1993. location:
  1994. $ref: '#/components/schemas/Location'
  1995. example:
  1996. Event@NavigationLink: "<domain>/events/999"
  1997. next@NavigationLink: "<domain>/events/999/observations/locations?offset=500"
  1998. params:
  1999. offset: 0
  2000. limit: 500
  2001. navigationLinks: true
  2002. size: 500
  2003. hasNext: true
  2004. offset: 0
  2005. data:
  2006. - timestamp: "2023-01-25 15:35:32Z"
  2007. location:
  2008. longitude: 49.7384
  2009. latitude: 13.3736
  2010. altitude: 350.3
  2011. Location:
  2012. type: object
  2013. properties:
  2014. longitude:
  2015. type: number
  2016. format: float
  2017. latitude:
  2018. type: number
  2019. format: float
  2020. altitude:
  2021. type: number
  2022. format: float
  2023. example:
  2024. longitude: 49.7384
  2025. latitude: 13.3736
  2026. altitude: 350.3
  2027. UnitBasicInfo:
  2028. type: object
  2029. required:
  2030. - unitId
  2031. - name
  2032. x-NavigationLinks:
  2033. Unit@NavigationLink:
  2034. type: string
  2035. format: uri
  2036. x-graph-properties:
  2037. linkTo: unitIdGET
  2038. properties:
  2039. Unit@NavigationLink:
  2040. $ref: '#/components/schemas/UnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
  2041. unitId:
  2042. description: Identifier of the unit
  2043. type: integer
  2044. format: int64
  2045. name:
  2046. type: string
  2047. description:
  2048. type: string
  2049. example:
  2050. Unit@NavigationLink: "<domain>/units/25"
  2051. unitId: 25
  2052. name: "Mobile Unit"
  2053. description: "Mobile Unit 25"
  2054. UnitDetailInfo:
  2055. type: object
  2056. required:
  2057. - unitId
  2058. - name
  2059. - imei
  2060. x-NavigationLinks:
  2061. self@NavigationLink:
  2062. type: string
  2063. format: uri
  2064. x-graph-properties:
  2065. linkTo: unitIdGET
  2066. Sensors@NavigationLink:
  2067. type: string
  2068. format: uri
  2069. x-graph-properties:
  2070. linkTo: unitIdSensorsGET
  2071. Campaigns@NavigationLink:
  2072. type: string
  2073. format: uri
  2074. x-graph-properties:
  2075. linkTo: unitIdCampaignsGET
  2076. Drivers@NavigationLink:
  2077. type: string
  2078. format: uri
  2079. x-graph-properties:
  2080. linkTo: unitIdDriversGET
  2081. properties:
  2082. self@NavigationLink:
  2083. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  2084. Sensors@NavigationLink:
  2085. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  2086. Campaigns@NavigationLink:
  2087. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Campaigns@NavigationLink'
  2088. Drivers@NavigationLink:
  2089. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Drivers@NavigationLink'
  2090. unitId:
  2091. description: Identifier of the unit
  2092. type: integer
  2093. format: int64
  2094. name:
  2095. type: string
  2096. imei:
  2097. type: string
  2098. description:
  2099. type: string
  2100. example:
  2101. self@NavigationLink: "<domain>/units/25"
  2102. Sensors@NavigationLink: "<domain>/units/25/sensors"
  2103. Campaigns@NavigationLink: "<domain>/units/25/campaigns"
  2104. Drivers@NavigationLink: "<domain>/units/25/drivers"
  2105. unitId: 25
  2106. name: "Mobile Unit"
  2107. description: "Mobile Unit 25"
  2108. imei: "3434535323345"
  2109. UnitSensorBasicInfo:
  2110. type: object
  2111. required:
  2112. - sensorId
  2113. - name
  2114. x-NavigationLinks:
  2115. Sensor@NavigationLink:
  2116. type: string
  2117. format: uri
  2118. x-graph-properties:
  2119. linkTo: sensorIdGET
  2120. properties:
  2121. Sensor@NavigationLink:
  2122. $ref: '#/components/schemas/UnitSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  2123. sensorId:
  2124. description: Identifier of the unit
  2125. type: integer
  2126. format: int64
  2127. name:
  2128. type: string
  2129. type:
  2130. type: string
  2131. example:
  2132. Sensor@NavigationLink: "<domain>/sensors/105"
  2133. sensorId: 105
  2134. name: "Sensor 105"
  2135. type: "temperature"
  2136. UnitCampaignBasicInfo:
  2137. type: object
  2138. required:
  2139. - id
  2140. - fromTime
  2141. - toTime
  2142. x-NavigationLinks:
  2143. Campaign@NavigationLink:
  2144. type: string
  2145. format: uri
  2146. x-graph-properties:
  2147. linkTo: campaignIdGET
  2148. properties:
  2149. Campaign@NavigationLink:
  2150. $ref: '#/components/schemas/UnitCampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
  2151. id:
  2152. type: integer
  2153. format: int64
  2154. description: Identifier of the campaign
  2155. description:
  2156. type: string
  2157. description: Description of the campaign
  2158. fromTime:
  2159. type: string
  2160. format: date-time
  2161. description: Time from the unit was active in the campaign
  2162. toTime:
  2163. type: string
  2164. format: date-time
  2165. description: Time until the unit was active in the campaign
  2166. example:
  2167. Campaign@NavigationLink: "<domain>/campaigns/1"
  2168. id: 1
  2169. description: "Campaign 1"
  2170. fromTime: "2023-01-25 15:35:32Z"
  2171. toTime: "2023-03-20 10:35:32Z"
  2172. UnitDriverBasicInfo:
  2173. type: object
  2174. required:
  2175. - id
  2176. - name
  2177. x-NavigationLinks:
  2178. Driver@NavigationLink:
  2179. type: string
  2180. format: uri
  2181. x-graph-properties:
  2182. linkTo: driverIdGET
  2183. properties:
  2184. Driver@NavigationLink:
  2185. $ref: '#/components/schemas/UnitDriverBasicInfo/x-NavigationLinks/Driver@NavigationLink'
  2186. id:
  2187. type: integer
  2188. format: int64
  2189. name:
  2190. type: string
  2191. example:
  2192. Driver@NavigationLink: "<domain>/drivers/42"
  2193. id: 42
  2194. name: "Steve Smith"
  2195. DriverActionUnitBasicInfo:
  2196. type: object
  2197. required:
  2198. - unitId
  2199. - name
  2200. x-NavigationLinks:
  2201. DriverActionUnit@NavigationLink:
  2202. type: string
  2203. format: uri
  2204. x-graph-properties:
  2205. linkTo: driverIdActionIdUnitIdGET
  2206. properties:
  2207. DriverActionUnit@NavigationLink:
  2208. $ref: '#/components/schemas/DriverActionUnitBasicInfo/x-NavigationLinks/DriverActionUnit@NavigationLink'
  2209. unitId:
  2210. description: Identifier of the unit
  2211. type: integer
  2212. format: int64
  2213. name:
  2214. type: string
  2215. description:
  2216. type: string
  2217. example:
  2218. DriverActionUnit@NavigationLink: "<domain>/drivers/42/actions/258/units/25"
  2219. unitId: 25
  2220. name: "Unit name"
  2221. description: "Purpose of the Unit 25"
  2222. DriverActionUnitDetailInfo:
  2223. type: object
  2224. required:
  2225. - unitId
  2226. - name
  2227. - imei
  2228. x-NavigationLinks:
  2229. self@NavigationLink:
  2230. type: string
  2231. format: uri
  2232. x-graph-properties:
  2233. linkTo: driverIdActionIdUnitIdGET
  2234. DriverAction@NavigationLink:
  2235. type: string
  2236. format: uri
  2237. x-graph-properties:
  2238. linkTo: driverIdActionIdGET
  2239. Events@NavigationLink:
  2240. type: string
  2241. format: uri
  2242. x-graph-properties:
  2243. linkTo: driverIdUnitIdActionIdEventsGET
  2244. Unit@NavigationLink:
  2245. type: string
  2246. format: uri
  2247. x-graph-properties:
  2248. linkTo: unitIdGET
  2249. properties:
  2250. self@NavigationLink:
  2251. $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  2252. DriverAction@NavigationLink:
  2253. $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/DriverAction@NavigationLink'
  2254. Unit@NavigationLink:
  2255. $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  2256. Events@NavigationLink:
  2257. $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/Events@NavigationLink'
  2258. unitId:
  2259. description: Identifier of the unit
  2260. type: integer
  2261. format: int64
  2262. name:
  2263. type: string
  2264. imei:
  2265. type: string
  2266. description:
  2267. type: string
  2268. example:
  2269. self@NavigationLink: "<domain>/drivers/42/actions/258/units/25"
  2270. DriverAction@NavigationLink: "<domain>/drivers/42/actions/258"
  2271. Events@NavigationLink: "<domain>/drivers/42/units/25/actions/258/events"
  2272. Unit@NavigationLink: "<domain>/units/25"
  2273. unitId: 25
  2274. name: "Mobile Unit"
  2275. description: "Mobile Unit 25"
  2276. imei: "3434535323345"
  2277. SensorBasicInfo:
  2278. type: object
  2279. required:
  2280. - id
  2281. - name
  2282. x-NavigationLinks:
  2283. Sensor@NavigationLink:
  2284. type: string
  2285. format: uri
  2286. x-graph-properties:
  2287. linkTo: sensorIdGET
  2288. properties:
  2289. Sensor@NavigationLink:
  2290. $ref: '#/components/schemas/SensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  2291. id:
  2292. type: integer
  2293. format: int64
  2294. name:
  2295. type: string
  2296. description:
  2297. type: string
  2298. example:
  2299. Sensor@NavigationLink: "<domain>/sensors/105"
  2300. id: 105
  2301. name: "Sensor 105"
  2302. description: "Description of the sensor 105"
  2303. SensorDetailInfo:
  2304. type: object
  2305. required:
  2306. - sensorId
  2307. - ioId
  2308. - name
  2309. - phenomenon
  2310. x-NavigationLinks:
  2311. self@NavigationLink:
  2312. type: string
  2313. format: uri
  2314. x-graph-properties:
  2315. linkTo: sensorIdGET
  2316. Units@NavigationLink:
  2317. type: string
  2318. format: uri
  2319. x-graph-properties:
  2320. linkTo: sensorIdUnitsGET
  2321. Phenomenon@NavigationLink:
  2322. type: string
  2323. format: uri
  2324. x-graph-properties:
  2325. linkTo: phenomenonIdGET
  2326. properties:
  2327. self@NavigationLink:
  2328. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/self@NavigationLink'
  2329. Units@NavigationLink:
  2330. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Units@NavigationLink'
  2331. Phenomenon@NavigationLink:
  2332. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Phenomenon@NavigationLink'
  2333. sensorId:
  2334. type: integer
  2335. format: int64
  2336. ioId:
  2337. type: integer
  2338. format: int16
  2339. name:
  2340. type: string
  2341. phenomenon:
  2342. type: string
  2343. type:
  2344. type: string
  2345. description:
  2346. type: string
  2347. example:
  2348. self@NavigationLink: "<domain>/sensors/105"
  2349. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  2350. Units@NavigationLink: "<domain>/sensors/105/units"
  2351. sensorId: 105
  2352. name: "Sensor 105"
  2353. description: "Description of the sensor 105"
  2354. type: "type of sensor"
  2355. phenomenon: "Temperature"
  2356. SensorUnitBasicInfo:
  2357. type: object
  2358. required:
  2359. - unitId
  2360. - name
  2361. properties:
  2362. Unit@NavigationLink:
  2363. type: string
  2364. format: uri
  2365. unitId:
  2366. description: Identifier of the unit
  2367. type: integer
  2368. format: int64
  2369. name:
  2370. type: string
  2371. description:
  2372. type: string
  2373. example:
  2374. Unit@NavigationLink: "<domain>/units/25"
  2375. unitId: 25
  2376. name: "Mobile Unit"
  2377. description: "Mobile Unit 25"
  2378. PhenomenonBasicInfo:
  2379. type: object
  2380. required:
  2381. - id
  2382. - name
  2383. x-NavigationLinks:
  2384. Phenomenon@NavigationLink:
  2385. type: string
  2386. format: uri
  2387. x-graph-properties:
  2388. linkTo: phenomenonIdGET
  2389. properties:
  2390. Phenomenon@NavigationLink:
  2391. $ref: '#/components/schemas/PhenomenonBasicInfo/x-NavigationLinks/Phenomenon@NavigationLink'
  2392. id:
  2393. type: integer
  2394. format: int64
  2395. name:
  2396. type: string
  2397. example:
  2398. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  2399. id: 15
  2400. name: "Temperature"
  2401. PhenomenonDetailInfo:
  2402. type: object
  2403. required:
  2404. - id
  2405. - name
  2406. - uom
  2407. x-NavigationLinks:
  2408. self@NavigationLink:
  2409. type: string
  2410. format: uri
  2411. x-graph-properties:
  2412. linkTo: phenomenonIdGET
  2413. Sensors@NavigationLink:
  2414. type: string
  2415. format: uri
  2416. x-graph-properties:
  2417. linkTo: phenomenonIdSensorsGET
  2418. properties:
  2419. self@NavigationLink:
  2420. $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/self@NavigationLink'
  2421. Sensors@NavigationLink:
  2422. $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  2423. id:
  2424. type: integer
  2425. format: int64
  2426. name:
  2427. type: string
  2428. uom:
  2429. type: string
  2430. maxLength: 30
  2431. uomLink:
  2432. type: string
  2433. format: uri
  2434. example:
  2435. self@NavigationLink: "<domain>/phenomenons/15"
  2436. Sensors@NavigationLink: "<domain>/phenomenons/15/sensors"
  2437. id: 15
  2438. name: "Temperature"
  2439. uom: "uom"
  2440. uomLink: "uom link"
  2441. PhenomenonSensorBasicInfo:
  2442. type: object
  2443. required:
  2444. - Phenomenon@NavigationLink
  2445. - Sensor@NavigationLink
  2446. - sensorId
  2447. - name
  2448. x-NavigationLinks:
  2449. Phenomenon@NavigationLink:
  2450. type: string
  2451. format: uri
  2452. x-graph-properties:
  2453. linkTo: phenomenonIdGET
  2454. Sensor@NavigationLink:
  2455. type: string
  2456. format: uri
  2457. x-graph-properties:
  2458. linkTo: sensorIdGET
  2459. properties:
  2460. Phenomenon@NavigationLink:
  2461. $ref: '#/components/schemas/PhenomenonSensorBasicInfo/x-NavigationLinks/Phenomenon@NavigationLink'
  2462. Sensor@NavigationLink:
  2463. $ref: '#/components/schemas/PhenomenonSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  2464. sensorId:
  2465. type: integer
  2466. format: int64
  2467. name:
  2468. type: string
  2469. description:
  2470. type: string
  2471. example:
  2472. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  2473. Sensor@NavigationLink: "<domain>/sensors/105"
  2474. sensorId: 105
  2475. name: "Sensor 105"
  2476. description: "Description of Sensor 105"
  2477. DriverBasicInfo:
  2478. type: object
  2479. required:
  2480. - id
  2481. - name
  2482. x-NavigationLinks:
  2483. Driver@NavigationLink:
  2484. type: string
  2485. format: uri
  2486. x-graph-properties:
  2487. linkTo: driverIdGET
  2488. properties:
  2489. Driver@NavigationLink:
  2490. $ref: '#/components/schemas/DriverBasicInfo/x-NavigationLinks/Driver@NavigationLink'
  2491. id:
  2492. type: integer
  2493. format: int64
  2494. name:
  2495. type: string
  2496. example:
  2497. Driver@NavigationLink: "<domain>/drivers/42"
  2498. id: 42
  2499. name: "Steve Smith"
  2500. DriverDetailInfo:
  2501. type: object
  2502. required:
  2503. - id
  2504. - name
  2505. x-NavigationLinks:
  2506. self@NavigationLink:
  2507. type: string
  2508. format: uri
  2509. x-graph-properties:
  2510. linkTo: driverIdGET
  2511. Units@NavigationLink:
  2512. type: string
  2513. format: uri
  2514. x-graph-properties:
  2515. linkTo: driverIdUnitsGET
  2516. Actions@NavigationLink:
  2517. type: string
  2518. format: uri
  2519. x-graph-properties:
  2520. linkTo: driverIdActionsGET
  2521. properties:
  2522. self@NavigationLink:
  2523. $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/self@NavigationLink'
  2524. Units@NavigationLink:
  2525. $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/Units@NavigationLink'
  2526. Actions@NavigationLink:
  2527. $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/Actions@NavigationLink'
  2528. id:
  2529. type: integer
  2530. format: int64
  2531. name:
  2532. type: string
  2533. example:
  2534. self@NavigationLink: "<domain>/drivers/42"
  2535. Units@NavigationLink: "<domain>/drivers/42/units"
  2536. Actions@NavigationLink: "<domain>/drivers/42/actions"
  2537. id: 42
  2538. name: "Steve Smith"
  2539. DriverUnitBasicInfo:
  2540. type: object
  2541. required:
  2542. - unitId
  2543. - name
  2544. x-NavigationLinks:
  2545. DriverUnit@NavigationLink:
  2546. type: string
  2547. format: uri
  2548. x-graph-properties:
  2549. linkTo: driverIdUnitsGET
  2550. properties:
  2551. DriverUnit@NavigationLink:
  2552. $ref: '#/components/schemas/DriverUnitBasicInfo/x-NavigationLinks/DriverUnit@NavigationLink'
  2553. unitId:
  2554. description: Identifier of the unit
  2555. type: integer
  2556. format: int64
  2557. name:
  2558. type: string
  2559. description:
  2560. type: string
  2561. example:
  2562. DriverUnit@NavigationLink: "<domain>/drivers/42/units/25"
  2563. unitId: 25
  2564. name: "Unit name"
  2565. description: "Purpose of the Unit 25"
  2566. DriverUnitDetailInfo:
  2567. type: object
  2568. required:
  2569. - unitId
  2570. - imei
  2571. - name
  2572. x-NavigationLinks:
  2573. self@NavigationLink:
  2574. type: string
  2575. format: uri
  2576. x-graph-properties:
  2577. linkTo: driverIdUnitIdGET
  2578. Unit@NavigationLink:
  2579. type: string
  2580. format: uri
  2581. x-graph-properties:
  2582. linkTo: unitIdGET
  2583. Actions@NavigationLink:
  2584. type: string
  2585. format: uri
  2586. x-graph-properties:
  2587. linkTo: driverIdUnitIdActionsGET
  2588. properties:
  2589. self@NavigationLink:
  2590. $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  2591. Unit@NavigationLink:
  2592. $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  2593. Actions@NavigationLink:
  2594. $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  2595. unitId:
  2596. description: Identifier of the unit
  2597. type: integer
  2598. format: int64
  2599. name:
  2600. type: string
  2601. imei:
  2602. type: string
  2603. description:
  2604. type: string
  2605. example:
  2606. self@NavigationLink: "<domain>/drivers/42/units/25"
  2607. Unit@NavigationLink: "<domain>/units/25"
  2608. Actions@NavigationLink: "<domain>/drivers/42/units/25/actions"
  2609. unitId: 25
  2610. name: "Mobile Unit"
  2611. description: "Mobile Unit 25"
  2612. imei: "3434535323345"
  2613. DriverActionBasicInfo:
  2614. type: object
  2615. required:
  2616. - id
  2617. - name
  2618. x-NavigationLinks:
  2619. DriverAction@NavigationLink:
  2620. type: string
  2621. format: uri
  2622. x-graph-properties:
  2623. linkTo: driverIdActionIdGET
  2624. properties:
  2625. DriverAction@NavigationLink:
  2626. $ref: '#/components/schemas/DriverActionBasicInfo/x-NavigationLinks/DriverAction@NavigationLink'
  2627. id:
  2628. type: integer
  2629. format: int64
  2630. name:
  2631. type: string
  2632. example:
  2633. DriverAction@NavigationLink: "<domain>/drivers/42/actions/258"
  2634. id: 258
  2635. name: "Delivering"
  2636. DriverUnitActionBasicInfo:
  2637. type: object
  2638. required:
  2639. - id
  2640. - name
  2641. x-NavigationLinks:
  2642. DriverUntAction@NavigationLink:
  2643. type: string
  2644. format: uri
  2645. x-graph-properties:
  2646. linkTo: driverIdUnitIdActionIdGET
  2647. properties:
  2648. DriverUntAction@NavigationLink:
  2649. $ref: '#/components/schemas/DriverUnitActionBasicInfo/x-NavigationLinks/DriverUntAction@NavigationLink'
  2650. id:
  2651. type: integer
  2652. format: int64
  2653. name:
  2654. type: string
  2655. example:
  2656. DriverUntAction@NavigationLink: "<domain>/drivers/42/units/{25}/actions/258"
  2657. id: 258
  2658. name: "Delivering"
  2659. DriverActionDetailInfo:
  2660. type: object
  2661. x-NavigationLinks:
  2662. self@NavigationLink:
  2663. type: string
  2664. format: uri
  2665. x-graph-properties:
  2666. linkTo: driverIdActionIdGET
  2667. Driver@NavigationLink:
  2668. type: string
  2669. format: uri
  2670. x-graph-properties:
  2671. linkTo: driverIdGET
  2672. Units@NavigationLink:
  2673. type: string
  2674. format: uri
  2675. x-graph-properties:
  2676. linkTo: driverIdActionIdUnitsGET
  2677. properties:
  2678. self@NavigationLink:
  2679. $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/self@NavigationLink'
  2680. Driver@NavigationLink:
  2681. $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/Driver@NavigationLink'
  2682. Units@NavigationLink:
  2683. $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/Units@NavigationLink'
  2684. id:
  2685. type: integer
  2686. format: int64
  2687. name:
  2688. type: string
  2689. example:
  2690. self@NavigationLink: "<domain>/drivers/42/actions/258"
  2691. Driver@NavigationLink: "<domain>/drivers/42"
  2692. Units@NavigationLink: "<domain>/drivers/42/actions/258/units"
  2693. id: 258
  2694. name: "Delivering"
  2695. DriverUnitActionDetailInfo:
  2696. type: object
  2697. x-NavigationLinks:
  2698. self@NavigationLink:
  2699. type: string
  2700. format: uri
  2701. x-graph-properties:
  2702. linkTo: driverIdUnitIdActionIdGET
  2703. Driver@NavigationLink:
  2704. type: string
  2705. format: uri
  2706. x-graph-properties:
  2707. linkTo: driverIdGET
  2708. DriverUnit@NavigationLink:
  2709. type: string
  2710. format: uri
  2711. x-graph-properties:
  2712. linkTo: driverIdUnitIdGET
  2713. Events@NavigationLink:
  2714. type: string
  2715. format: uri
  2716. x-graph-properties:
  2717. linkTo: driverIdUnitIdActionIdEventsGET
  2718. properties:
  2719. self@NavigationLink:
  2720. $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/self@NavigationLink'
  2721. Driver@NavigationLink:
  2722. $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/Driver@NavigationLink'
  2723. DriverUnit@NavigationLink:
  2724. $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/DriverUnit@NavigationLink'
  2725. Events@NavigationLink:
  2726. $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/Events@NavigationLink'
  2727. id:
  2728. type: integer
  2729. format: int64
  2730. name:
  2731. type: string
  2732. example:
  2733. self@NavigationLink: "<domain>/drivers/42/units/25/actions/258"
  2734. Driver@NavigationLink: "<domain>/drivers/42"
  2735. DriverUnit@NavigationLink: "<domain>/drivers/42/units/25"
  2736. Events@NavigationLink: "<domain>/drivers/42/units/25/actions/258/events"
  2737. id: 258
  2738. name: "Delivering"
  2739. EventBasicInfo:
  2740. type: object
  2741. required:
  2742. - id
  2743. - fromTime
  2744. - toTime
  2745. x-NavigationLinks:
  2746. Event@NavigationLink:
  2747. type: string
  2748. format: uri
  2749. x-graph-properties:
  2750. linkTo: driverIdUnitIdActionIdEventIdGET
  2751. properties:
  2752. Event@NavigationLink:
  2753. $ref: '#/components/schemas/EventBasicInfo/x-NavigationLinks/Event@NavigationLink'
  2754. id:
  2755. type: integer
  2756. format: int64
  2757. fromTime:
  2758. description: Time when the event starts
  2759. type: string
  2760. format: date-time
  2761. toTime:
  2762. description: Time when the end ends
  2763. type: string
  2764. format: date-time
  2765. example:
  2766. Event@NavigationLink: "<domain>/drivers/42/units/105/actions/258/events/999"
  2767. id: 999
  2768. fromTime: "2023-01-25 15:35:32Z"
  2769. toTime: "2023-03-20 10:35:32Z"
  2770. EventDetailInfo:
  2771. type: object
  2772. required:
  2773. - id
  2774. - driverId
  2775. - actionId
  2776. - unitId
  2777. - fromTime
  2778. - toTime
  2779. x-NavigationLinks:
  2780. self@NavigationLink:
  2781. type: string
  2782. format: uri
  2783. x-graph-properties:
  2784. linkTo: driverIdUnitIdActionIdEventIdGET
  2785. Driver@NavigationLink:
  2786. type: string
  2787. format: uri
  2788. x-graph-properties:
  2789. linkTo: driverIdGET
  2790. DriverUnit@NavigationLink:
  2791. type: string
  2792. format: uri
  2793. x-graph-properties:
  2794. linkTo: driverIdUnitIdGET
  2795. Action@NavigationLink:
  2796. type: string
  2797. format: uri
  2798. x-graph-properties:
  2799. linkTo: driverIdActionIdGET
  2800. Observations@NavigationLink:
  2801. type: string
  2802. format: uri
  2803. x-graph-properties:
  2804. linkTo: eventIdObservationsGET
  2805. Locations@NavigationLink:
  2806. type: string
  2807. format: uri
  2808. x-graph-properties:
  2809. linkTo: eventIdLocationsGET
  2810. properties:
  2811. self@NavigationLink:
  2812. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/self@NavigationLink'
  2813. Driver@NavigationLink:
  2814. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Driver@NavigationLink'
  2815. DriverUnit@NavigationLink:
  2816. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/DriverUnit@NavigationLink'
  2817. Action@NavigationLink:
  2818. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Action@NavigationLink'
  2819. Observations@NavigationLink:
  2820. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  2821. Locations@NavigationLink:
  2822. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  2823. id:
  2824. type: integer
  2825. format: int64
  2826. driverId:
  2827. type: integer
  2828. format: int64
  2829. actionId:
  2830. type: integer
  2831. format: int64
  2832. unitId:
  2833. type: integer
  2834. format: int64
  2835. fromTime:
  2836. description: Time when the event starts
  2837. type: string
  2838. format: date-time
  2839. toTime:
  2840. description: Time when the end ends
  2841. type: string
  2842. format: date-time
  2843. example:
  2844. self@NavigationLink: "<domain>/drivers/42/units/105/actions/258/events/999"
  2845. Driver@NavigationLink: "<domain>/drivers/42"
  2846. DriverUnit@NavigationLink: "<domain>/drivers/42/units/105"
  2847. Action@NavigationLink: "<domain>/actions/258"
  2848. Observations@NavigationLink: "<domain>/events/999/observations"
  2849. Locations@NavigationLink: "<domain>/events/999/observations/locations"
  2850. id: 999
  2851. driverId: 42
  2852. actionId: 258
  2853. unitId: 105
  2854. fromTime: "2023-01-25 15:35:32Z"
  2855. toTime: "2023-03-20 10:35:32Z"
  2856. PostResponse:
  2857. type: object
  2858. required:
  2859. - saved
  2860. - errors
  2861. properties:
  2862. saved:
  2863. type: integer
  2864. minimum: 0
  2865. errors:
  2866. type: integer
  2867. minimum: 0
  2868. Info:
  2869. required:
  2870. - name
  2871. - version
  2872. - build
  2873. - uptime
  2874. - uptimeMillis
  2875. properties:
  2876. name:
  2877. type: string
  2878. version:
  2879. type: string
  2880. build:
  2881. type: string
  2882. uptimeMillis:
  2883. type: integer
  2884. format: int64
  2885. uptime:
  2886. type: string
  2887. example:
  2888. name: "senslog-telemetry"
  2889. version: "1.1.0"
  2890. build: "123456789"
  2891. uptimeMillis: 1684862333
  2892. uptime: "1:20:00"
  2893. Error:
  2894. required:
  2895. - code
  2896. - message
  2897. properties:
  2898. code:
  2899. type: integer
  2900. format: int32
  2901. message:
  2902. type: string
  2903. example:
  2904. code: 404
  2905. message: "Not Found"