openAPISpec.yaml 125 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160
  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:8085
  7. - url: https://theros.wirelessinfo.cz
  8. paths:
  9. /info:
  10. get:
  11. operationId: infoGET
  12. summary: Information about running instance
  13. tags:
  14. - Server
  15. responses:
  16. 200:
  17. description: Instance information
  18. content:
  19. application/json:
  20. schema:
  21. $ref: "#/components/schemas/Info"
  22. default:
  23. description: unexpected error
  24. content:
  25. application/json:
  26. schema:
  27. $ref: "#/components/schemas/Error"
  28. /campaigns:
  29. get:
  30. operationId: campaignsGET
  31. summary: Publish info about all campaigns
  32. tags:
  33. - Campaign
  34. security:
  35. - bearerAuth: [read:personal]
  36. - bearerAuth: [read:infrastructure]
  37. parameters:
  38. - $ref: '#/components/parameters/zoneParam'
  39. - $ref: '#/components/parameters/navigationLinksParam'
  40. responses:
  41. 200:
  42. description: JSON array of basic info of each campaign
  43. content:
  44. application/json:
  45. schema:
  46. type: array
  47. items:
  48. $ref: '#/components/schemas/CampaignBasicInfo'
  49. default:
  50. description: unexpected error
  51. content:
  52. application/json:
  53. schema:
  54. $ref: '#/components/schemas/Error'
  55. /campaigns/{campaignId}:
  56. get:
  57. operationId: campaignIdGET
  58. summary: Publish info about a campaign
  59. tags:
  60. - Campaign
  61. security:
  62. - bearerAuth: [read:personal]
  63. - bearerAuth: [read:infrastructure]
  64. parameters:
  65. - $ref: '#/components/parameters/campaignIdParam'
  66. - $ref: '#/components/parameters/zoneParam'
  67. - $ref: '#/components/parameters/navigationLinksParam'
  68. responses:
  69. 200:
  70. description: JSON object containing info about a campaign
  71. content:
  72. application/json:
  73. schema:
  74. $ref: '#/components/schemas/CampaignDetailInfo'
  75. default:
  76. description: unexpected error
  77. content:
  78. application/json:
  79. schema:
  80. $ref: '#/components/schemas/Error'
  81. /campaigns/{campaignId}/units:
  82. get:
  83. operationId: campaignIdUnitsGET
  84. summary: Publish info about the campaign's units
  85. tags:
  86. - Unit
  87. security:
  88. - bearerAuth: [read:personal]
  89. - bearerAuth: [read:infrastructure]
  90. parameters:
  91. - $ref: '#/components/parameters/campaignIdParam'
  92. - $ref: '#/components/parameters/zoneParam'
  93. - $ref: '#/components/parameters/navigationLinksParam'
  94. responses:
  95. 200:
  96. description: JSON Array containing info about campaign's units
  97. content:
  98. application/json:
  99. schema:
  100. type: array
  101. items:
  102. $ref: '#/components/schemas/CampaignUnitBasicInfo'
  103. default:
  104. description: unexpected error
  105. content:
  106. application/json:
  107. schema:
  108. $ref: '#/components/schemas/Error'
  109. /campaigns/{campaignId}/units/observations:
  110. get:
  111. operationId: campaignIdUnitsObservationsGET
  112. summary: Publish info about all data of units merged together within the campaign
  113. tags:
  114. - Observation
  115. security:
  116. - bearerAuth: [read:personal]
  117. - bearerAuth: [read:infrastructure]
  118. parameters:
  119. - $ref: '#/components/parameters/campaignIdParam'
  120. - $ref: '#/components/parameters/fromParam'
  121. - $ref: '#/components/parameters/toParam'
  122. - $ref: '#/components/parameters/zoneParam'
  123. - $ref: '#/components/parameters/offsetParam'
  124. - $ref: '#/components/parameters/limitParam'
  125. - $ref: '#/components/parameters/formatParam'
  126. - $ref: '#/components/parameters/filterParam'
  127. - $ref: '#/components/parameters/navigationLinksParam'
  128. responses:
  129. 200:
  130. description: JSON containing stream of telemetry data
  131. content:
  132. application/json:
  133. schema:
  134. $ref: '#/components/schemas/CampaignObservationPaging'
  135. application/geojson:
  136. schema:
  137. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  138. default:
  139. description: unexpected error
  140. content:
  141. application/json:
  142. schema:
  143. $ref: '#/components/schemas/Error'
  144. post:
  145. operationId: campaignIdUnitsObservationsPOST
  146. tags:
  147. - Observation
  148. security:
  149. - bearerAuth: [write:infrastructure]
  150. parameters:
  151. - $ref: '#/components/parameters/campaignIdParam'
  152. requestBody:
  153. # required: true
  154. content:
  155. application/json:
  156. schema:
  157. type: array
  158. description: JSON Array of Observations. The attribute 'timestamp' accepts only ISO8601 or the pattern 'yyyy-MM-dd[+][ ]HH:mm:ss'. The attribute can be substituted by 'epoch'.
  159. items:
  160. $ref: '#/components/schemas/CampaignDataObservation'
  161. application/geojson:
  162. schema:
  163. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  164. responses:
  165. 200:
  166. description: JSON
  167. content:
  168. application/json:
  169. schema:
  170. type: array
  171. items:
  172. $ref: '#/components/schemas/CampaignDataObservation'
  173. default:
  174. description: unexpected error
  175. content:
  176. application/json:
  177. schema:
  178. $ref: '#/components/schemas/Error'
  179. /test/observations:
  180. post:
  181. operationId: testObservationsPOST
  182. tags:
  183. - Test
  184. requestBody:
  185. # required: true
  186. content:
  187. application/json:
  188. schema:
  189. type: array
  190. description: JSON Array of Observations. The attribute 'timestamp' accepts only ISO8601 or the pattern 'yyyy-MM-dd[+][ ]HH:mm:ss'. The attribute can be substituted by 'epoch'.
  191. minLength: 1
  192. items:
  193. $ref: '#/components/schemas/CampaignDataObservation'
  194. application/geojson:
  195. schema:
  196. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  197. responses:
  198. 200:
  199. description: JSON
  200. content:
  201. application/json:
  202. schema:
  203. type: array
  204. items:
  205. $ref: '#/components/schemas/CampaignDataObservation'
  206. default:
  207. description: unexpected error
  208. content:
  209. application/json:
  210. schema:
  211. $ref: '#/components/schemas/Error'
  212. /campaigns/{campaignId}/units/observations/locations:
  213. get:
  214. operationId: campaignIdUnitsObservationsLocationsGET
  215. summary: Publish info about all data of units merged together within the campaign
  216. tags:
  217. - Locations
  218. security:
  219. - bearerAuth: [read:personal]
  220. - bearerAuth: [read:infrastructure]
  221. parameters:
  222. - $ref: '#/components/parameters/campaignIdParam'
  223. - $ref: '#/components/parameters/limitPerUnitParam'
  224. - $ref: '#/components/parameters/fromParam'
  225. - $ref: '#/components/parameters/toParam'
  226. - $ref: '#/components/parameters/zoneParam'
  227. - $ref: '#/components/parameters/sortParam'
  228. - $ref: '#/components/parameters/formatParam'
  229. - $ref: '#/components/parameters/filterParam'
  230. - $ref: '#/components/parameters/navigationLinksParam'
  231. responses:
  232. 200:
  233. description: JSON containing stream of telemetry data
  234. content:
  235. application/geojson:
  236. schema:
  237. $ref: '#/components/schemas/GeoCampaignUnitsMultiLocations'
  238. application/json:
  239. schema:
  240. $ref: '#/components/schemas/CampaignUnitsLocationsPaging'
  241. default:
  242. description: unexpected error
  243. content:
  244. application/json:
  245. schema:
  246. $ref: '#/components/schemas/Error'
  247. put:
  248. operationId: campaignIdUnitsObservationsLocationsPUT
  249. summary: Adjusting locations of all observations within 'fromTime' to 'toTime' interval.
  250. tags:
  251. - Locations
  252. security:
  253. - bearerAuth: [ read:infrastructure ]
  254. parameters:
  255. - $ref: '#/components/parameters/campaignIdParam'
  256. requestBody:
  257. required: true
  258. content:
  259. application/json:
  260. schema:
  261. $ref: '#/components/schemas/CampaignUnitsLocationArray'
  262. application/geojson:
  263. schema:
  264. $ref: '#/components/schemas/GeoCampaignUnitsSingleLocations'
  265. responses:
  266. 200:
  267. description: JSON Object containing number of updated observations.
  268. content:
  269. application/json:
  270. schema:
  271. type: object
  272. default:
  273. description: unexpected error
  274. content:
  275. application/json:
  276. schema:
  277. $ref: '#/components/schemas/Error'
  278. /campaigns/{campaignId}/units/{unitId}:
  279. get:
  280. operationId: campaignIdUnitIdGET
  281. summary: Publish info about the unit within its campaign's scope
  282. tags:
  283. - Unit
  284. security:
  285. - bearerAuth: [read:personal]
  286. - bearerAuth: [read:infrastructure]
  287. parameters:
  288. - $ref: '#/components/parameters/campaignIdParam'
  289. - $ref: '#/components/parameters/unitIdParam'
  290. - $ref: '#/components/parameters/zoneParam'
  291. - $ref: '#/components/parameters/navigationLinksParam'
  292. responses:
  293. 200:
  294. description: JSON Object containing info about the unit within its campaign' scope
  295. content:
  296. application/json:
  297. schema:
  298. $ref: '#/components/schemas/CampaignUnitDetailInfo'
  299. default:
  300. description: unexpected error
  301. content:
  302. application/json:
  303. schema:
  304. $ref: '#/components/schemas/Error'
  305. /campaigns/{campaignId}/units/{unitId}/observations:
  306. get:
  307. operationId: campaignIdUnitIdObservationsGET
  308. summary: Publish info about all data of the unit within the campaign
  309. tags:
  310. - Observation
  311. security:
  312. - bearerAuth: [read:personal]
  313. - bearerAuth: [read:infrastructure]
  314. parameters:
  315. - $ref: '#/components/parameters/campaignIdParam'
  316. - $ref: '#/components/parameters/unitIdParam'
  317. - $ref: '#/components/parameters/fromParam'
  318. - $ref: '#/components/parameters/toParam'
  319. - $ref: '#/components/parameters/zoneParam'
  320. - $ref: '#/components/parameters/offsetParam'
  321. - $ref: '#/components/parameters/limitParam'
  322. - $ref: '#/components/parameters/sortParam'
  323. - $ref: '#/components/parameters/formatParam'
  324. - $ref: '#/components/parameters/filterParam'
  325. - $ref: '#/components/parameters/navigationLinksParam'
  326. responses:
  327. 200:
  328. description: JSON containing stream of telemetry data
  329. content:
  330. application/json:
  331. schema:
  332. $ref: '#/components/schemas/CampaignUnitObservationPaging'
  333. application/geojson:
  334. schema:
  335. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  336. default:
  337. description: unexpected error
  338. content:
  339. application/json:
  340. schema:
  341. $ref: '#/components/schemas/Error'
  342. /campaigns/{campaignId}/units/{unitId}/observations/locations:
  343. get:
  344. operationId: campaignIdUnitIdLocationsGET
  345. summary: Publish locations of the unit within the campaign
  346. tags:
  347. - Locations
  348. security:
  349. - bearerAuth: [read:personal]
  350. - bearerAuth: [read:infrastructure]
  351. parameters:
  352. - $ref: '#/components/parameters/campaignIdParam'
  353. - $ref: '#/components/parameters/unitIdParam'
  354. - $ref: '#/components/parameters/fromParam'
  355. - $ref: '#/components/parameters/toParam'
  356. - $ref: '#/components/parameters/zoneParam'
  357. - $ref: '#/components/parameters/offsetParam'
  358. - $ref: '#/components/parameters/limitParam'
  359. - $ref: '#/components/parameters/filterParam'
  360. - $ref: '#/components/parameters/formatParam'
  361. - $ref: '#/components/parameters/navigationLinksParam'
  362. responses:
  363. 200:
  364. description: JSON containing stream of locations
  365. content:
  366. application/json:
  367. schema:
  368. $ref: '#/components/schemas/CampaignUnitLocationPaging'
  369. application/geojson:
  370. schema:
  371. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  372. default:
  373. description: unexpected error
  374. content:
  375. application/json:
  376. schema:
  377. $ref: '#/components/schemas/Error'
  378. /campaigns/{campaignId}/units/{unitId}/sensors:
  379. get:
  380. operationId: campaignIdUnitIdSensorsGET
  381. summary: Publish info about all sensors of the unit within the campaign
  382. tags:
  383. - Sensor
  384. security:
  385. - bearerAuth: [read:personal]
  386. - bearerAuth: [read:infrastructure]
  387. parameters:
  388. - $ref: '#/components/parameters/campaignIdParam'
  389. - $ref: '#/components/parameters/unitIdParam'
  390. - $ref: '#/components/parameters/navigationLinksParam'
  391. responses:
  392. 200:
  393. description: JSON containing information of sensors assigned to the unit within its campaign
  394. content:
  395. application/json:
  396. schema:
  397. type: array
  398. items:
  399. $ref: '#/components/schemas/CampaignUnitBasicSensor'
  400. default:
  401. description: unexpected error
  402. content:
  403. application/json:
  404. schema:
  405. $ref: '#/components/schemas/Error'
  406. /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}:
  407. get:
  408. operationId: campaignIdUnitIdSensorIdGET
  409. summary: Publish info about all sensors associated with the unit and the campaign
  410. tags:
  411. - Sensor
  412. security:
  413. - bearerAuth: [read:personal]
  414. - bearerAuth: [read:infrastructure]
  415. parameters:
  416. - $ref: '#/components/parameters/campaignIdParam'
  417. - $ref: '#/components/parameters/unitIdParam'
  418. - $ref: '#/components/parameters/sensorIdParam'
  419. - $ref: '#/components/parameters/navigationLinksParam'
  420. responses:
  421. 200:
  422. description: JSON Object containing info about the sensor
  423. content:
  424. application/json:
  425. schema:
  426. $ref: '#/components/schemas/CampaignUnitDetailedSensor'
  427. default:
  428. description: unexpected error
  429. content:
  430. application/json:
  431. schema:
  432. $ref: '#/components/schemas/Error'
  433. /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}/observations:
  434. get:
  435. operationId: campaignIdUnitIdSensorIdObservationsGET
  436. summary: Publish info about all data of the unit within the campaign
  437. tags:
  438. - Observation
  439. security:
  440. - bearerAuth: [read:personal]
  441. - bearerAuth: [read:infrastructure]
  442. parameters:
  443. - $ref: '#/components/parameters/campaignIdParam'
  444. - $ref: '#/components/parameters/unitIdParam'
  445. - $ref: '#/components/parameters/sensorIdParam'
  446. - $ref: '#/components/parameters/fromParam'
  447. - $ref: '#/components/parameters/toParam'
  448. - $ref: '#/components/parameters/zoneParam'
  449. - $ref: '#/components/parameters/offsetParam'
  450. - $ref: '#/components/parameters/limitParam'
  451. - $ref: '#/components/parameters/formatParam'
  452. - $ref: '#/components/parameters/filterParam'
  453. - $ref: '#/components/parameters/navigationLinksParam'
  454. responses:
  455. 200:
  456. description: JSON containing stream of telemetry data
  457. content:
  458. application/json:
  459. schema:
  460. $ref: '#/components/schemas/CampaignUnitSensorObservationPaging'
  461. application/geojson:
  462. schema:
  463. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  464. default:
  465. description: unexpected error
  466. content:
  467. application/json:
  468. schema:
  469. $ref: '#/components/schemas/Error'
  470. /units:
  471. get:
  472. operationId: unitsGET
  473. summary: Publish info about all units
  474. tags:
  475. - Unit
  476. security:
  477. - bearerAuth: [read:personal]
  478. - bearerAuth: [read:infrastructure]
  479. parameters:
  480. - $ref: '#/components/parameters/navigationLinksParam'
  481. responses:
  482. 200:
  483. description: JSON array of basic info of each unit
  484. content:
  485. application/json:
  486. schema:
  487. type: array
  488. items:
  489. $ref: '#/components/schemas/UnitBasicInfo'
  490. default:
  491. description: unexpected error
  492. content:
  493. application/json:
  494. schema:
  495. $ref: '#/components/schemas/Error'
  496. /units/{unitId}:
  497. get:
  498. operationId: unitIdGET
  499. summary: Publish info about the unit
  500. tags:
  501. - Unit
  502. security:
  503. - bearerAuth: [read:personal]
  504. - bearerAuth: [read:infrastructure]
  505. parameters:
  506. - $ref: '#/components/parameters/unitIdParam'
  507. - $ref: '#/components/parameters/navigationLinksParam'
  508. responses:
  509. 200:
  510. description: JSON Object of info of the unit
  511. content:
  512. application/json:
  513. schema:
  514. $ref: '#/components/schemas/UnitDetailInfo'
  515. default:
  516. description: unexpected error
  517. content:
  518. application/json:
  519. schema:
  520. $ref: '#/components/schemas/Error'
  521. /units/{unitId}/sensors:
  522. get:
  523. operationId: unitIdSensorsGET
  524. summary: Publish info about sensors assigned to the unit
  525. tags:
  526. - Sensor
  527. security:
  528. - bearerAuth: [read:personal]
  529. - bearerAuth: [read:infrastructure]
  530. parameters:
  531. - $ref: '#/components/parameters/unitIdParam'
  532. - $ref: '#/components/parameters/navigationLinksParam'
  533. responses:
  534. 200:
  535. description: JSON Array of info of the sensors
  536. content:
  537. application/json:
  538. schema:
  539. type: array
  540. items:
  541. $ref: '#/components/schemas/UnitSensorBasicInfo'
  542. default:
  543. description: unexpected error
  544. content:
  545. application/json:
  546. schema:
  547. $ref: '#/components/schemas/Error'
  548. /units/{unitId}/campaigns:
  549. get:
  550. operationId: unitIdCampaignsGET
  551. summary: Publish info about campaigns where the unit was/is assigned
  552. tags:
  553. - Campaign
  554. security:
  555. - bearerAuth: [read:personal]
  556. - bearerAuth: [read:infrastructure]
  557. parameters:
  558. - $ref: '#/components/parameters/unitIdParam'
  559. - $ref: '#/components/parameters/zoneParam'
  560. - $ref: '#/components/parameters/navigationLinksParam'
  561. responses:
  562. 200:
  563. description: JSON Array of info about campaigns
  564. content:
  565. application/json:
  566. schema:
  567. type: array
  568. items:
  569. $ref: '#/components/schemas/UnitCampaignBasicInfo'
  570. default:
  571. description: unexpected error
  572. content:
  573. application/json:
  574. schema:
  575. $ref: '#/components/schemas/Error'
  576. /units/{unitId}/entities:
  577. get:
  578. operationId: unitIdEntitiesGET
  579. summary: Publish basic info about entities who performed actions upon the unit
  580. tags:
  581. - Entity
  582. security:
  583. - bearerAuth: [read:personal]
  584. - bearerAuth: [read:infrastructure]
  585. parameters:
  586. - $ref: '#/components/parameters/unitIdParam'
  587. - $ref: '#/components/parameters/navigationLinksParam'
  588. responses:
  589. 200:
  590. description: JSON Array of entities
  591. content:
  592. application/json:
  593. schema:
  594. type: array
  595. items:
  596. $ref: '#/components/schemas/UnitEntityBasicInfo'
  597. default:
  598. description: unexpected error
  599. content:
  600. application/json:
  601. schema:
  602. $ref: '#/components/schemas/Error'
  603. /sensors:
  604. get:
  605. operationId: sensorsGET
  606. summary: Publish info about all sensors
  607. tags:
  608. - Sensor
  609. security:
  610. - bearerAuth: [read:personal]
  611. - bearerAuth: [read:infrastructure]
  612. parameters:
  613. - $ref: '#/components/parameters/navigationLinksParam'
  614. responses:
  615. 200:
  616. description: JSON Array of info about sensors
  617. content:
  618. application/json:
  619. schema:
  620. type: array
  621. items:
  622. $ref: '#/components/schemas/SensorBasicInfo'
  623. default:
  624. description: unexpected error
  625. content:
  626. application/json:
  627. schema:
  628. $ref: '#/components/schemas/Error'
  629. /sensors/{sensorId}:
  630. get:
  631. operationId: sensorIdGET
  632. summary: Publish info about the sensor
  633. tags:
  634. - Sensor
  635. security:
  636. - bearerAuth: [read:personal]
  637. - bearerAuth: [read:infrastructure]
  638. parameters:
  639. - $ref: '#/components/parameters/sensorIdParam'
  640. - $ref: '#/components/parameters/navigationLinksParam'
  641. responses:
  642. 200:
  643. description: JSON Object of info about the sensor
  644. content:
  645. application/json:
  646. schema:
  647. $ref: '#/components/schemas/SensorDetailInfo'
  648. default:
  649. description: unexpected error
  650. content:
  651. application/json:
  652. schema:
  653. $ref: '#/components/schemas/Error'
  654. /sensors/{sensorId}/units:
  655. get:
  656. operationId: sensorIdUnitsGET
  657. summary: Publish info about units to whom the sensor is assigned
  658. tags:
  659. - Unit
  660. security:
  661. - bearerAuth: [read:personal]
  662. - bearerAuth: [read:infrastructure]
  663. parameters:
  664. - $ref: '#/components/parameters/sensorIdParam'
  665. - $ref: '#/components/parameters/navigationLinksParam'
  666. responses:
  667. 200:
  668. description: JSON Array of info about the units
  669. content:
  670. application/json:
  671. schema:
  672. type: array
  673. items:
  674. $ref: '#/components/schemas/SensorUnitBasicInfo'
  675. default:
  676. description: unexpected error
  677. content:
  678. application/json:
  679. schema:
  680. $ref: '#/components/schemas/Error'
  681. /phenomenons:
  682. get:
  683. operationId: phenomenonsGET
  684. summary: Publish info about all phenomenons
  685. tags:
  686. - Phenomenon
  687. security:
  688. - bearerAuth: [read:personal]
  689. - bearerAuth: [read:infrastructure]
  690. parameters:
  691. - $ref: '#/components/parameters/navigationLinksParam'
  692. responses:
  693. 200:
  694. description: JSON Array of info about phenomenons
  695. content:
  696. application/json:
  697. schema:
  698. type: array
  699. items:
  700. $ref: '#/components/schemas/PhenomenonBasicInfo'
  701. default:
  702. description: unexpected error
  703. content:
  704. application/json:
  705. schema:
  706. $ref: '#/components/schemas/Error'
  707. /phenomenons/{phenomenonId}:
  708. get:
  709. operationId: phenomenonIdGET
  710. summary: Publish info about the phenomenon
  711. tags:
  712. - Phenomenon
  713. security:
  714. - bearerAuth: [read:personal]
  715. - bearerAuth: [read:infrastructure]
  716. parameters:
  717. - $ref: '#/components/parameters/phenomenonIdParam'
  718. - $ref: '#/components/parameters/navigationLinksParam'
  719. responses:
  720. 200:
  721. description: JSON Object of info about the phenomenon
  722. content:
  723. application/json:
  724. schema:
  725. $ref: '#/components/schemas/PhenomenonDetailInfo'
  726. default:
  727. description: unexpected error
  728. content:
  729. application/json:
  730. schema:
  731. $ref: '#/components/schemas/Error'
  732. /phenomenons/{phenomenonId}/sensors:
  733. get:
  734. operationId: phenomenonIdSensorsGET
  735. summary: Publish info about sensors of the phenomenon
  736. tags:
  737. - Sensor
  738. security:
  739. - bearerAuth: [read:personal]
  740. - bearerAuth: [read:infrastructure]
  741. parameters:
  742. - $ref: '#/components/parameters/phenomenonIdParam'
  743. - $ref: '#/components/parameters/navigationLinksParam'
  744. responses:
  745. 200:
  746. description: JSON Array of info about sensors
  747. content:
  748. application/json:
  749. schema:
  750. type: array
  751. items:
  752. $ref: '#/components/schemas/PhenomenonSensorBasicInfo'
  753. default:
  754. description: unexpected error
  755. content:
  756. application/json:
  757. schema:
  758. $ref: '#/components/schemas/Error'
  759. /entities:
  760. get:
  761. operationId: entitiesGET
  762. summary: Publish basic info about all entities
  763. tags:
  764. - Entity
  765. security:
  766. - bearerAuth: [read:personal]
  767. - bearerAuth: [read:infrastructure]
  768. parameters:
  769. - $ref: '#/components/parameters/navigationLinksParam'
  770. responses:
  771. 200:
  772. description: JSON Array of basic info about entities
  773. content:
  774. application/json:
  775. schema:
  776. type: array
  777. items:
  778. $ref: '#/components/schemas/EntityBasicInfo'
  779. default:
  780. description: unexpected error
  781. content:
  782. application/json:
  783. schema:
  784. $ref: '#/components/schemas/Error'
  785. /entities/{entityId}:
  786. get:
  787. operationId: entityIdGET
  788. summary: Publish detailed info about the entity
  789. tags:
  790. - Entity
  791. security:
  792. - bearerAuth: [read:personal]
  793. - bearerAuth: [read:infrastructure]
  794. parameters:
  795. - $ref: '#/components/parameters/entityIdParam'
  796. - $ref: '#/components/parameters/navigationLinksParam'
  797. responses:
  798. 200:
  799. description: JSON Object of detailed info about the entity
  800. content:
  801. application/json:
  802. schema:
  803. $ref: '#/components/schemas/EntityDetailInfo'
  804. default:
  805. description: unexpected error
  806. content:
  807. application/json:
  808. schema:
  809. $ref: '#/components/schemas/Error'
  810. /entities/{entityId}/units:
  811. get:
  812. operationId: entityIdUnitsGET
  813. summary: Publish basic info about entity's units
  814. tags:
  815. - Unit
  816. security:
  817. - bearerAuth: [read:personal]
  818. - bearerAuth: [read:infrastructure]
  819. parameters:
  820. - $ref: '#/components/parameters/entityIdParam'
  821. - $ref: '#/components/parameters/fromParam'
  822. - $ref: '#/components/parameters/toParam'
  823. - $ref: '#/components/parameters/navigationLinksParam'
  824. responses:
  825. 200:
  826. description: JSON Array of basic info about units
  827. content:
  828. application/json:
  829. schema:
  830. type: array
  831. items:
  832. $ref: '#/components/schemas/EntityUnitBasicInfo'
  833. default:
  834. description: unexpected error
  835. content:
  836. application/json:
  837. schema:
  838. $ref: '#/components/schemas/Error'
  839. /entities/{entityId}/units/{unitId}:
  840. get:
  841. operationId: entityIdUnitIdGET
  842. summary: Publish detailed info about entity's unit
  843. tags:
  844. - Unit
  845. security:
  846. - bearerAuth: [read:personal]
  847. - bearerAuth: [read:infrastructure]
  848. parameters:
  849. - $ref: '#/components/parameters/entityIdParam'
  850. - $ref: '#/components/parameters/unitIdParam'
  851. - $ref: '#/components/parameters/navigationLinksParam'
  852. responses:
  853. 200:
  854. description: JSON Object of detailed info about entity's unit
  855. content:
  856. application/json:
  857. schema:
  858. $ref: '#/components/schemas/EntityUnitDetailInfo'
  859. default:
  860. description: unexpected error
  861. content:
  862. application/json:
  863. schema:
  864. $ref: '#/components/schemas/Error'
  865. /entities/{entityId}/units/{unitId}/actions:
  866. get:
  867. operationId: entityIdUnitIdActionsGET
  868. summary: Publish basic info actions performed on the unit by the entity
  869. tags:
  870. - Action
  871. security:
  872. - bearerAuth: [read:personal]
  873. - bearerAuth: [read:infrastructure]
  874. parameters:
  875. - $ref: '#/components/parameters/entityIdParam'
  876. - $ref: '#/components/parameters/unitIdParam'
  877. - $ref: '#/components/parameters/navigationLinksParam'
  878. responses:
  879. 200:
  880. description: JSON Object of actions
  881. content:
  882. application/json:
  883. schema:
  884. type: array
  885. items:
  886. $ref: '#/components/schemas/EntityUnitActionBasicInfo'
  887. default:
  888. description: unexpected error
  889. content:
  890. application/json:
  891. schema:
  892. $ref: '#/components/schemas/Error'
  893. /entities/{entityId}/actions:
  894. get:
  895. operationId: entityIdActionsGET
  896. summary: Publish basic info about entity's actions
  897. tags:
  898. - Action
  899. security:
  900. - bearerAuth: [read:personal]
  901. - bearerAuth: [read:infrastructure]
  902. parameters:
  903. - $ref: '#/components/parameters/entityIdParam'
  904. - $ref: '#/components/parameters/fromParam'
  905. - $ref: '#/components/parameters/toParam'
  906. - $ref: '#/components/parameters/navigationLinksParam'
  907. responses:
  908. 200:
  909. description: JSON Array of basic info about entity's actions'
  910. content:
  911. application/json:
  912. schema:
  913. type: array
  914. items:
  915. $ref: '#/components/schemas/EntityActionBasicInfo'
  916. default:
  917. description: unexpected error
  918. content:
  919. application/json:
  920. schema:
  921. $ref: '#/components/schemas/Error'
  922. /entities/{entityId}/actions/{actionId}:
  923. get:
  924. operationId: entityIdActionIdGET
  925. summary: Publish detailed info about the entity's action
  926. tags:
  927. - Action
  928. security:
  929. - bearerAuth: [read:personal]
  930. - bearerAuth: [read:infrastructure]
  931. parameters:
  932. - $ref: '#/components/parameters/entityIdParam'
  933. - $ref: '#/components/parameters/actionIdParam'
  934. - $ref: '#/components/parameters/navigationLinksParam'
  935. responses:
  936. 200:
  937. description: JSON Object of detailed info about the entity's action
  938. content:
  939. application/json:
  940. schema:
  941. $ref: '#/components/schemas/EntityActionDetailInfo'
  942. default:
  943. description: unexpected error
  944. content:
  945. application/json:
  946. schema:
  947. $ref: '#/components/schemas/Error'
  948. /entities/{entityId}/actions/{actionId}/units:
  949. get:
  950. operationId: entityIdActionIdUnitsGET
  951. summary: Publish basic info about units on which the entity performed its action
  952. tags:
  953. - Unit
  954. security:
  955. - bearerAuth: [read:personal]
  956. - bearerAuth: [read:infrastructure]
  957. parameters:
  958. - $ref: '#/components/parameters/entityIdParam'
  959. - $ref: '#/components/parameters/actionIdParam'
  960. - $ref: '#/components/parameters/navigationLinksParam'
  961. responses:
  962. 200:
  963. description: JSON Array of units
  964. content:
  965. application/json:
  966. schema:
  967. type: array
  968. items:
  969. $ref: '#/components/schemas/EntityActionUnitBasicInfo'
  970. default:
  971. description: unexpected error
  972. content:
  973. application/json:
  974. schema:
  975. $ref: '#/components/schemas/Error'
  976. /entities/{entityId}/actions/{actionId}/units/{unitId}:
  977. get:
  978. operationId: entityIdActionIdUnitIdGET
  979. summary: Publish detail info about the unit on which the entity performed the action
  980. tags:
  981. - Unit
  982. security:
  983. - bearerAuth: [read:personal]
  984. - bearerAuth: [read:infrastructure]
  985. parameters:
  986. - $ref: '#/components/parameters/entityIdParam'
  987. - $ref: '#/components/parameters/actionIdParam'
  988. - $ref: '#/components/parameters/unitIdParam'
  989. - $ref: '#/components/parameters/navigationLinksParam'
  990. responses:
  991. 200:
  992. description: JSON Object of the unit
  993. content:
  994. application/json:
  995. schema:
  996. $ref: '#/components/schemas/EntityActionUnitDetailInfo'
  997. default:
  998. description: unexpected error
  999. content:
  1000. application/json:
  1001. schema:
  1002. $ref: '#/components/schemas/Error'
  1003. /entities/{entityId}/units/{unitId}/actions/{actionId}:
  1004. get:
  1005. operationId: entityIdUnitIdActionIdGET
  1006. summary: Publish detailed info about the action performed on the unit by the entity
  1007. tags:
  1008. - Action
  1009. security:
  1010. - bearerAuth: [read:personal]
  1011. - bearerAuth: [read:infrastructure]
  1012. parameters:
  1013. - $ref: '#/components/parameters/entityIdParam'
  1014. - $ref: '#/components/parameters/unitIdParam'
  1015. - $ref: '#/components/parameters/actionIdParam'
  1016. - $ref: '#/components/parameters/navigationLinksParam'
  1017. responses:
  1018. 200:
  1019. description: JSON Object of the action
  1020. content:
  1021. application/json:
  1022. schema:
  1023. $ref: '#/components/schemas/EntityUnitActionDetailInfo'
  1024. default:
  1025. description: unexpected error
  1026. content:
  1027. application/json:
  1028. schema:
  1029. $ref: '#/components/schemas/Error'
  1030. /entities/{entityId}/units/{unitId}/actions/{actionId}/events:
  1031. get:
  1032. operationId: entityIdUnitIdActionIdEventsGET
  1033. summary: Publish basic info about events that where performed on the unit byt the entity with the specific action
  1034. tags:
  1035. - Event
  1036. security:
  1037. - bearerAuth: [read:personal]
  1038. - bearerAuth: [read:infrastructure]
  1039. parameters:
  1040. - $ref: '#/components/parameters/entityIdParam'
  1041. - $ref: '#/components/parameters/unitIdParam'
  1042. - $ref: '#/components/parameters/actionIdParam'
  1043. - $ref: '#/components/parameters/fromParam'
  1044. - $ref: '#/components/parameters/toParam'
  1045. - $ref: '#/components/parameters/zoneParam'
  1046. - $ref: '#/components/parameters/navigationLinksParam'
  1047. responses:
  1048. 200:
  1049. description: JSON Array of events
  1050. content:
  1051. application/json:
  1052. schema:
  1053. type: array
  1054. items:
  1055. $ref: '#/components/schemas/EventBasicInfo'
  1056. default:
  1057. description: unexpected error
  1058. content:
  1059. application/json:
  1060. schema:
  1061. $ref: '#/components/schemas/Error'
  1062. post:
  1063. operationId: entityIdUnitIdActionIdEventsPOST
  1064. tags:
  1065. - Event
  1066. security:
  1067. - bearerAuth: [write:infrastructure]
  1068. parameters:
  1069. - $ref: '#/components/parameters/entityIdParam'
  1070. - $ref: '#/components/parameters/unitIdParam'
  1071. - $ref: '#/components/parameters/actionIdParam'
  1072. requestBody:
  1073. required: true
  1074. content:
  1075. application/json:
  1076. schema:
  1077. oneOf:
  1078. - type: array
  1079. description: Array of events where an object with inserted events can be expected as a result.
  1080. items:
  1081. $ref: '#/components/schemas/EventInsertInfo'
  1082. - $ref: '#/components/schemas/EventInsertInfo'
  1083. responses:
  1084. 200:
  1085. description: Returns an object of number of the newly inserted alerts
  1086. content:
  1087. application/json:
  1088. schema:
  1089. oneOf:
  1090. - $ref: '#/components/schemas/ResponseArrayChange'
  1091. - $ref: '#/components/schemas/ResponseSingleChange'
  1092. default:
  1093. description: unexpected error
  1094. content:
  1095. application/json:
  1096. schema:
  1097. $ref: '#/components/schemas/Error'
  1098. /events/{eventId}:
  1099. get:
  1100. operationId: eventIdGET
  1101. summary: Publish basic info about events that where performed on the unit byt the entity with the specific action
  1102. tags:
  1103. - Event
  1104. security:
  1105. - bearerAuth: [read:personal]
  1106. - bearerAuth: [read:infrastructure]
  1107. parameters:
  1108. - $ref: '#/components/parameters/eventIdParam'
  1109. - $ref: '#/components/parameters/zoneParam'
  1110. - $ref: '#/components/parameters/navigationLinksParam'
  1111. responses:
  1112. 200:
  1113. description: JSON Array of events
  1114. content:
  1115. application/json:
  1116. schema:
  1117. $ref: '#/components/schemas/EventDetailInfo'
  1118. default:
  1119. description: unexpected error
  1120. content:
  1121. application/json:
  1122. schema:
  1123. $ref: '#/components/schemas/Error'
  1124. put:
  1125. operationId: eventIdPUT
  1126. tags:
  1127. - Event
  1128. security:
  1129. - bearerAuth: [write:infrastructure]
  1130. parameters:
  1131. - $ref: '#/components/parameters/eventIdParam'
  1132. requestBody:
  1133. required: true
  1134. content:
  1135. application/json:
  1136. schema:
  1137. type: object
  1138. properties:
  1139. toTime:
  1140. type: string
  1141. format: date-time
  1142. example: "2011-12-03T10:15:30+01:00"
  1143. responses:
  1144. 200:
  1145. description: Returns IO of the adjusted event.
  1146. content:
  1147. application/json:
  1148. schema:
  1149. $ref: '#/components/schemas/ResponseSingleChange'
  1150. default:
  1151. description: unexpected error
  1152. content:
  1153. application/json:
  1154. schema:
  1155. $ref: '#/components/schemas/Error'
  1156. /events/{eventId}/observations:
  1157. get:
  1158. operationId: eventIdObservationsGET
  1159. summary: Publish telemetry observations created by the entity while performing specific action on the unit at the time/event
  1160. tags:
  1161. - Observation
  1162. security:
  1163. - bearerAuth: [read:personal]
  1164. - bearerAuth: [read:infrastructure]
  1165. parameters:
  1166. - $ref: '#/components/parameters/eventIdParam'
  1167. - $ref: '#/components/parameters/zoneParam'
  1168. - $ref: '#/components/parameters/fromParam'
  1169. - $ref: '#/components/parameters/toParam'
  1170. - $ref: '#/components/parameters/offsetParam'
  1171. - $ref: '#/components/parameters/limitParam'
  1172. - $ref: '#/components/parameters/formatParam'
  1173. - $ref: '#/components/parameters/filterParam'
  1174. - $ref: '#/components/parameters/navigationLinksParam'
  1175. responses:
  1176. 200:
  1177. description: JSON Object of telemetry observations
  1178. content:
  1179. application/json:
  1180. schema:
  1181. $ref: '#/components/schemas/ActionEventObservationPaging'
  1182. application/geojson:
  1183. schema:
  1184. $ref: '#/components/schemas/GeoFeatureCollectionUnit'
  1185. default:
  1186. description: unexpected error
  1187. content:
  1188. application/json:
  1189. schema:
  1190. $ref: '#/components/schemas/Error'
  1191. /events/{eventId}/observations/locations:
  1192. get:
  1193. operationId: eventIdLocationsGET
  1194. summary: Publish locations created by the entity while performing specific action on the unit at the time/event
  1195. tags:
  1196. - Locations
  1197. security:
  1198. - bearerAuth: [read:personal]
  1199. - bearerAuth: [read:infrastructure]
  1200. parameters:
  1201. - $ref: '#/components/parameters/eventIdParam'
  1202. - $ref: '#/components/parameters/fromParam'
  1203. - $ref: '#/components/parameters/toParam'
  1204. - $ref: '#/components/parameters/zoneParam'
  1205. - $ref: '#/components/parameters/offsetParam'
  1206. - $ref: '#/components/parameters/limitParam'
  1207. - $ref: '#/components/parameters/formatParam'
  1208. - $ref: '#/components/parameters/filterParam'
  1209. - $ref: '#/components/parameters/navigationLinksParam'
  1210. responses:
  1211. 200:
  1212. description: JSON containing stream of locations
  1213. content:
  1214. application/json:
  1215. schema:
  1216. $ref: '#/components/schemas/ActionEventLocationPaging'
  1217. application/geojson:
  1218. schema:
  1219. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  1220. default:
  1221. description: unexpected error
  1222. content:
  1223. application/json:
  1224. schema:
  1225. $ref: '#/components/schemas/Error'
  1226. /alerts/{alertId}:
  1227. get:
  1228. operationId: alertIdGET
  1229. tags:
  1230. - Alert
  1231. security:
  1232. - bearerAuth: [read:personal]
  1233. - bearerAuth: [read:infrastructure]
  1234. parameters:
  1235. - $ref: '#/components/parameters/alertIdParam'
  1236. - $ref: '#/components/parameters/zoneParam'
  1237. - $ref: '#/components/parameters/navigationLinksParam'
  1238. responses:
  1239. 200:
  1240. description: JSON Object of the Alert
  1241. content:
  1242. application/json:
  1243. schema:
  1244. $ref: '#/components/schemas/AlertDetailInfo'
  1245. default:
  1246. description: unexpected error
  1247. content:
  1248. application/json:
  1249. schema:
  1250. $ref: '#/components/schemas/Error'
  1251. put:
  1252. operationId: alertIdPUT
  1253. tags:
  1254. - Alert
  1255. security:
  1256. - bearerAuth: [write:infrastructure]
  1257. parameters:
  1258. - $ref: '#/components/parameters/alertIdParam'
  1259. requestBody:
  1260. required: true
  1261. content:
  1262. application/json:
  1263. schema:
  1264. $ref: '#/components/schemas/AlertChange'
  1265. responses:
  1266. 200:
  1267. description: Returns ID of the changed alert
  1268. content:
  1269. application/json:
  1270. schema:
  1271. $ref: '#/components/schemas/ResponseSingleChange'
  1272. default:
  1273. description: unexpected error
  1274. content:
  1275. application/json:
  1276. schema:
  1277. $ref: '#/components/schemas/Error'
  1278. delete:
  1279. operationId: alertIdDELETE
  1280. tags:
  1281. - Alert
  1282. security:
  1283. - bearerAuth: [write:infrastructure]
  1284. parameters:
  1285. - $ref: '#/components/parameters/alertIdParam'
  1286. responses:
  1287. 200:
  1288. description: Returns ID of the changed alert
  1289. content:
  1290. application/json:
  1291. schema:
  1292. $ref: '#/components/schemas/ResponseSingleChange'
  1293. default:
  1294. description: unexpected error
  1295. content:
  1296. application/json:
  1297. schema:
  1298. $ref: '#/components/schemas/Error'
  1299. /events/{eventId}/alerts:
  1300. get:
  1301. operationId: eventIdAlertsGET
  1302. tags:
  1303. - Alert
  1304. security:
  1305. - bearerAuth: [read:personal]
  1306. - bearerAuth: [read:infrastructure]
  1307. parameters:
  1308. - $ref: '#/components/parameters/eventIdParam'
  1309. - $ref: '#/components/parameters/alertStatusParam'
  1310. - $ref: '#/components/parameters/zoneParam'
  1311. - $ref: '#/components/parameters/sortParam'
  1312. - $ref: '#/components/parameters/navigationLinksParam'
  1313. responses:
  1314. 200:
  1315. description: JSON Array of Alerts
  1316. content:
  1317. application/json:
  1318. schema:
  1319. type: array
  1320. items:
  1321. $ref: '#/components/schemas/AlertBasicInfo'
  1322. default:
  1323. description: unexpected error
  1324. content:
  1325. application/json:
  1326. schema:
  1327. $ref: '#/components/schemas/Error'
  1328. /events/{eventId}/alerts/{alertId}:
  1329. get:
  1330. operationId: entityIdActionIdUnitIdAlertIdGET
  1331. tags:
  1332. - Alert
  1333. security:
  1334. - bearerAuth: [read:personal]
  1335. - bearerAuth: [read:infrastructure]
  1336. parameters:
  1337. - $ref: '#/components/parameters/eventIdParam'
  1338. - $ref: '#/components/parameters/alertIdParam'
  1339. - $ref: '#/components/parameters/zoneParam'
  1340. - $ref: '#/components/parameters/navigationLinksParam'
  1341. responses:
  1342. 200:
  1343. description: JSON Object of Alert
  1344. content:
  1345. application/json:
  1346. schema:
  1347. $ref: '#/components/schemas/EventAlertDetailInfo'
  1348. default:
  1349. description: unexpected error
  1350. content:
  1351. application/json:
  1352. schema:
  1353. $ref: '#/components/schemas/Error'
  1354. /campaigns/{campaignId}/units/alerts:
  1355. get:
  1356. operationId: campaignIdUnitsAlertsGET
  1357. tags:
  1358. - Alert
  1359. security:
  1360. - bearerAuth: [read:personal]
  1361. - bearerAuth: [read:infrastructure]
  1362. parameters:
  1363. - $ref: '#/components/parameters/campaignIdParam'
  1364. - $ref: '#/components/parameters/fromParam'
  1365. - $ref: '#/components/parameters/toParam'
  1366. - $ref: '#/components/parameters/sortParam'
  1367. - $ref: '#/components/parameters/alertStatusParam'
  1368. - $ref: '#/components/parameters/zoneParam'
  1369. - $ref: '#/components/parameters/navigationLinksParam'
  1370. responses:
  1371. 200:
  1372. description: JSON Array of Alerts
  1373. content:
  1374. application/json:
  1375. schema:
  1376. type: array
  1377. items:
  1378. $ref: '#/components/schemas/CampaignAlertBasicInfo'
  1379. default:
  1380. description: unexpected error
  1381. content:
  1382. application/json:
  1383. schema:
  1384. $ref: '#/components/schemas/Error'
  1385. post:
  1386. operationId: campaignIdUnitsAlertsPOST
  1387. tags:
  1388. - Alert
  1389. security:
  1390. - bearerAuth: [write:infrastructure]
  1391. parameters:
  1392. - $ref: '#/components/parameters/campaignIdParam'
  1393. requestBody:
  1394. required: true
  1395. content:
  1396. application/json:
  1397. schema:
  1398. oneOf:
  1399. - type: array
  1400. items:
  1401. $ref: '#/components/schemas/AlertInsert'
  1402. - $ref: '#/components/schemas/AlertInsert'
  1403. responses:
  1404. 200:
  1405. description: Returns an object of number of the newly inserted alerts
  1406. content:
  1407. application/json:
  1408. schema:
  1409. oneOf:
  1410. - type: array
  1411. items:
  1412. $ref: '#/components/schemas/CampaignAlertBasicInfo'
  1413. - $ref: '#/components/schemas/CampaignAlertBasicInfo'
  1414. default:
  1415. description: unexpected error
  1416. content:
  1417. application/json:
  1418. schema:
  1419. $ref: '#/components/schemas/Error'
  1420. /campaigns/{campaignId}/units/{unitId}/alerts:
  1421. get:
  1422. operationId: campaignIdUnitIdAlertsGET
  1423. tags:
  1424. - Alert
  1425. security:
  1426. - bearerAuth: [read:personal]
  1427. - bearerAuth: [read:infrastructure]
  1428. parameters:
  1429. - $ref: '#/components/parameters/campaignIdParam'
  1430. - $ref: '#/components/parameters/unitIdParam'
  1431. - $ref: '#/components/parameters/fromParam'
  1432. - $ref: '#/components/parameters/toParam'
  1433. - $ref: '#/components/parameters/zoneParam'
  1434. - $ref: '#/components/parameters/alertStatusParam'
  1435. - $ref: '#/components/parameters/sortParam'
  1436. - $ref: '#/components/parameters/navigationLinksParam'
  1437. responses:
  1438. 200:
  1439. description: JSON Array of Alerts
  1440. content:
  1441. application/json:
  1442. schema:
  1443. type: array
  1444. items:
  1445. $ref: '#/components/schemas/AlertBasicInfo'
  1446. default:
  1447. description: unexpected error
  1448. content:
  1449. application/json:
  1450. schema:
  1451. $ref: '#/components/schemas/Error'
  1452. /entities/{entityId}/actions/{actionId}/units/{unitId}/alerts:
  1453. get:
  1454. operationId: entityIdActionIdUnitIdAlertsGET
  1455. tags:
  1456. - Alert
  1457. security:
  1458. - bearerAuth: [read:personal]
  1459. - bearerAuth: [read:infrastructure]
  1460. parameters:
  1461. - $ref: '#/components/parameters/entityIdParam'
  1462. - $ref: '#/components/parameters/actionIdParam'
  1463. - $ref: '#/components/parameters/unitIdParam'
  1464. - $ref: '#/components/parameters/zoneParam'
  1465. - $ref: '#/components/parameters/alertStatusParam'
  1466. - $ref: '#/components/parameters/sortParam'
  1467. - $ref: '#/components/parameters/navigationLinksParam'
  1468. responses:
  1469. 200:
  1470. description: JSON Array of Alerts
  1471. content:
  1472. application/json:
  1473. schema:
  1474. type: array
  1475. items:
  1476. $ref: '#/components/schemas/AlertBasicInfo'
  1477. default:
  1478. description: unexpected error
  1479. content:
  1480. application/json:
  1481. schema:
  1482. $ref: '#/components/schemas/Error'
  1483. /legacy/observations:
  1484. get:
  1485. operationId: legacyInsertObservationsGET
  1486. description: Legacy endpoint from SensLog v1 to insert observations from static units that are assigned to a mobile unit to get locations.
  1487. tags:
  1488. - Legacy
  1489. parameters:
  1490. - in: query
  1491. name: Operation
  1492. required: true
  1493. schema:
  1494. type: string
  1495. enum:
  1496. - InsertObservation
  1497. - in: query
  1498. name: value
  1499. required: true
  1500. schema:
  1501. type: number
  1502. format: double
  1503. - in: query
  1504. name: date
  1505. required: true
  1506. schema:
  1507. type: string
  1508. - in: query
  1509. name: unit_id
  1510. required: true
  1511. schema:
  1512. type: integer
  1513. format: int64
  1514. minimum: 1
  1515. - in: query
  1516. name: sensor_id
  1517. required: true
  1518. schema:
  1519. type: integer
  1520. format: int64
  1521. minimum: 1
  1522. responses:
  1523. 200:
  1524. description: Boolean value representing success of the insert operation.
  1525. content:
  1526. text/plain:
  1527. schema:
  1528. type: boolean
  1529. /integration/order/create:
  1530. get:
  1531. operationId: integrationOrderCreateGET
  1532. tags:
  1533. - Integration
  1534. parameters:
  1535. - in: query
  1536. description: Order ID is the unique identifier of the order.
  1537. name: order_id
  1538. required: true
  1539. schema:
  1540. type: integer
  1541. format: int64
  1542. minimum: 1
  1543. - in: query
  1544. description: Unit ID is the unique identifier of the box.
  1545. name: unit_id
  1546. required: true
  1547. schema:
  1548. type: integer
  1549. format: int64
  1550. minimum: 1
  1551. - in: query
  1552. description: Tracking ID is a related number to the delivery_type parameter. If the delivery_type is chosen as SERVICE_XYZ (e.g., SERVICE_FOFR) than the tracking ID is the number for tracking provided by the parcel service. Otherwise, it is the identifier (i.e., unit id) of the transporting vehicle (e.g., Peugeot).
  1553. name: tracking_id
  1554. required: true
  1555. schema:
  1556. type: integer
  1557. format: int64
  1558. minimum: 1
  1559. - in: query
  1560. name: delivery_type
  1561. required: true
  1562. schema:
  1563. type: string
  1564. enum:
  1565. - SERVICE_FOFR
  1566. - VEHICLE_CITROEN
  1567. - VEHICLE_PEUGEOT
  1568. responses:
  1569. 200:
  1570. description: Text information about new order.
  1571. content:
  1572. application/json:
  1573. schema:
  1574. type: object
  1575. properties:
  1576. message:
  1577. type: string
  1578. default:
  1579. description: unexpected error
  1580. content:
  1581. application/json:
  1582. schema:
  1583. $ref: '#/components/schemas/Error'
  1584. /integration/tracking/all:
  1585. get:
  1586. operationId: integrationTrackingAllGET
  1587. tags:
  1588. - Integration
  1589. responses:
  1590. 200:
  1591. description: JSON Array of all active tracking packages.
  1592. content:
  1593. application/json:
  1594. schema:
  1595. type: array
  1596. items:
  1597. type: object
  1598. properties:
  1599. parcelId:
  1600. type: integer
  1601. format: int64
  1602. minimum: 1
  1603. unitId:
  1604. type: integer
  1605. format: int64
  1606. minimum: 1
  1607. orderId:
  1608. type: integer
  1609. format: int64
  1610. minimum: 1
  1611. default:
  1612. description: unexpected error
  1613. content:
  1614. application/json:
  1615. schema:
  1616. $ref: '#/components/schemas/Error'
  1617. /integration/tracking/change:
  1618. get:
  1619. operationId: integrationTrackingChangeGET
  1620. tags:
  1621. - Integration
  1622. parameters:
  1623. - in: query
  1624. name: unit_id
  1625. required: true
  1626. schema:
  1627. type: integer
  1628. format: int64
  1629. minimum: 1
  1630. - in: query
  1631. name: action
  1632. required: true
  1633. schema:
  1634. type: string
  1635. enum:
  1636. - START
  1637. - STOP
  1638. responses:
  1639. 200:
  1640. description: JSON Object including message of the change.
  1641. content:
  1642. application/json:
  1643. schema:
  1644. type: object
  1645. properties:
  1646. message:
  1647. type: string
  1648. plain/text:
  1649. schema:
  1650. type: string
  1651. default:
  1652. description: unexpected error
  1653. content:
  1654. application/json:
  1655. schema:
  1656. $ref: '#/components/schemas/Error'
  1657. /integration/tracking/status:
  1658. get:
  1659. operationId: integrationTrackingStatusGET
  1660. tags:
  1661. - Integration
  1662. parameters:
  1663. - in: query
  1664. name: unit_id
  1665. required: true
  1666. schema:
  1667. type: integer
  1668. format: int64
  1669. minimum: 1
  1670. responses:
  1671. 200:
  1672. description: Text information about tracking
  1673. content:
  1674. application/json:
  1675. schema:
  1676. type: object
  1677. properties:
  1678. unitId:
  1679. type: integer
  1680. format: int64
  1681. minimum: 1
  1682. orderId:
  1683. type: integer
  1684. format: int64
  1685. minimum: 1
  1686. isDelivering:
  1687. type: boolean
  1688. deliveryType:
  1689. type: string
  1690. enum:
  1691. - SERVICE_FOFR
  1692. - CAR_CITROEN
  1693. - CAR_PEUGEOT
  1694. text/html:
  1695. schema:
  1696. type: string
  1697. default:
  1698. description: unexpected error
  1699. content:
  1700. application/json:
  1701. schema:
  1702. $ref: '#/components/schemas/Error'
  1703. /integration/certificate:
  1704. get:
  1705. operationId: integrationCertificateGET
  1706. tags:
  1707. - Integration
  1708. parameters:
  1709. - in: query
  1710. description: Order ID encoded by Base64
  1711. name: h
  1712. required: true
  1713. schema:
  1714. type: string
  1715. responses:
  1716. 200:
  1717. description: A PDF file
  1718. content:
  1719. application/pdf:
  1720. schema:
  1721. type: string
  1722. format: binary
  1723. default:
  1724. description: unexpected error
  1725. content:
  1726. application/json:
  1727. schema:
  1728. $ref: '#/components/schemas/Error'
  1729. components:
  1730. securitySchemes:
  1731. bearerAuth:
  1732. type: http
  1733. scheme: bearer
  1734. bearerFormat: JWT
  1735. parameters:
  1736. campaignIdParam:
  1737. in: path
  1738. name: campaignId
  1739. schema:
  1740. type: integer
  1741. format: int64
  1742. required: true
  1743. description: Numeric ID of the campaign to get
  1744. unitIdParam:
  1745. in: path
  1746. name: unitId
  1747. schema:
  1748. type: integer
  1749. required: true
  1750. description: Numeric ID of the unit to get
  1751. sensorIdParam:
  1752. in: path
  1753. name: sensorId
  1754. schema:
  1755. type: integer
  1756. required: true
  1757. description: Numeric ID of the sensor to get
  1758. phenomenonIdParam:
  1759. in: path
  1760. name: phenomenonId
  1761. schema:
  1762. type: integer
  1763. format: int64
  1764. required: true
  1765. description: Numeric ID of the phenomenon to get
  1766. entityIdParam:
  1767. in: path
  1768. name: entityId
  1769. schema:
  1770. type: integer
  1771. format: int64
  1772. required: true
  1773. description: Numeric ID of the entity to get
  1774. actionIdParam:
  1775. in: path
  1776. name: actionId
  1777. schema:
  1778. type: integer
  1779. format: int64
  1780. required: true
  1781. description: Numeric ID of the action to get
  1782. eventIdParam:
  1783. in: path
  1784. name: eventId
  1785. schema:
  1786. type: integer
  1787. format: int64
  1788. required: true
  1789. description: Numeric ID of the event to get
  1790. alertIdParam:
  1791. in: path
  1792. name: alertId
  1793. schema:
  1794. type: integer
  1795. format: int64
  1796. required: true
  1797. description: Numeric ID of the alert to get
  1798. zoneParam:
  1799. in: query
  1800. name: zone
  1801. schema:
  1802. type: string
  1803. default: UTC
  1804. required: false
  1805. examples:
  1806. UTC:
  1807. value: UTC
  1808. GMT:
  1809. value: GMT
  1810. navigationLinksParam:
  1811. in: query
  1812. name: navigationLinks
  1813. schema:
  1814. type: boolean
  1815. default: true
  1816. description: Option to disable @NavigationLinks in a response
  1817. limitParam:
  1818. in: query
  1819. name: limit
  1820. schema:
  1821. type: integer
  1822. format: int64
  1823. maximum: 500
  1824. required: false
  1825. example: 100
  1826. offsetParam:
  1827. in: query
  1828. name: offset
  1829. schema:
  1830. type: integer
  1831. format: int64
  1832. example: 100
  1833. fromParam:
  1834. in: query
  1835. name: from
  1836. schema:
  1837. type: string
  1838. format: date-time
  1839. required: false
  1840. example: 2017-07-21T17:32:28Z
  1841. toParam:
  1842. in: query
  1843. name: to
  1844. schema:
  1845. type: string
  1846. format: date-time
  1847. required: false
  1848. example: 2017-07-21T17:32:28Z
  1849. limitPerUnitParam:
  1850. in: query
  1851. name: limitPerUnit
  1852. schema:
  1853. type: integer
  1854. default: 1
  1855. examples:
  1856. One locations:
  1857. value: 1
  1858. summary: One location of each unit
  1859. sortParam:
  1860. in: query
  1861. name: sort
  1862. schema:
  1863. type: string
  1864. enum: [ asc, desc ]
  1865. default: asc
  1866. examples:
  1867. Descending Order:
  1868. value: desc
  1869. summary: Last location of the units. Last location is combination of sort=desc & limitPerUnit=1
  1870. Ascending Order:
  1871. value: asc
  1872. filterParam:
  1873. in: query
  1874. name: filter
  1875. description: Filter for results following the pattern
  1876. <unit | sensor>(<numeric_float_id | speed | longitude | latitude | altitude>)<lt | le | eq | ne | ge | lt><float_value>, e.g,
  1877. schema:
  1878. type: string
  1879. required: false
  1880. examples:
  1881. Units latitude:
  1882. value: unit(latitude)lt50.1
  1883. summary: Returns all units with its latitude coordination lower than (LT) 50.1
  1884. Units speed:
  1885. value: unit(speed)gt90.0
  1886. summary: Returns all units with its speed greater than 90.0 Km/h
  1887. Sensor ID value:
  1888. value: sensor(105)gt10
  1889. summary: Returns sensors having its value greater than 10
  1890. formatParam:
  1891. in: query
  1892. name: format
  1893. schema:
  1894. type: string
  1895. enum: [json, geojson]
  1896. default: json
  1897. required: false
  1898. alertStatusParam:
  1899. in: query
  1900. name: status
  1901. schema:
  1902. $ref: '#/components/schemas/AlertStatus'
  1903. schemas:
  1904. CampaignBasicInfo:
  1905. type: object
  1906. required:
  1907. - id
  1908. - name
  1909. - fromTime
  1910. - toTime
  1911. x-NavigationLinks:
  1912. Campaign@NavigationLink:
  1913. type: string
  1914. format: uri
  1915. x-graph-properties:
  1916. linkTo: campaignIdGET
  1917. color: blue
  1918. properties:
  1919. Campaign@NavigationLink:
  1920. $ref: '#/components/schemas/CampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
  1921. id:
  1922. type: integer
  1923. format: int64
  1924. name:
  1925. type: string
  1926. fromTime:
  1927. type: string
  1928. format: date-time
  1929. toTime:
  1930. type: string
  1931. format: date-time
  1932. example:
  1933. Campaign@NavigationLink: "<domain>/campaigns/1"
  1934. id: 1
  1935. name: "Campaign 1"
  1936. fromTime: "2011-12-03T10:15:30+01:00"
  1937. toTime: "2011-12-03T10:15:30+01:00"
  1938. CampaignDetailInfo:
  1939. type: object
  1940. required:
  1941. - id
  1942. - name
  1943. - fromTime
  1944. - toTime
  1945. x-NavigationLinks:
  1946. self@NavigationLink:
  1947. type: string
  1948. format: uri
  1949. x-graph-properties:
  1950. linkTo: campaignIdGET
  1951. Observations@NavigationLink:
  1952. type: string
  1953. format: uri
  1954. x-graph-properties:
  1955. linkTo: campaignIdUnitsObservationsGET
  1956. Locations@NavigationLink:
  1957. type: string
  1958. format: uri
  1959. x-graph-properties:
  1960. linkTo: campaignIdUnitsObservationsLocationsGET
  1961. Units@NavigationLink:
  1962. type: string
  1963. format: uri
  1964. x-graph-properties:
  1965. linkTo: campaignIdUnitsGET
  1966. properties:
  1967. self@NavigationLink:
  1968. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/self@NavigationLink'
  1969. Observations@NavigationLink:
  1970. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  1971. Locations@NavigationLink:
  1972. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  1973. Units@NavigationLink:
  1974. $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Units@NavigationLink'
  1975. id:
  1976. description: Identifier of the campaign
  1977. type: integer
  1978. format: int64
  1979. name:
  1980. type: string
  1981. description:
  1982. description: Text description of the campaign
  1983. type: string
  1984. fromTime:
  1985. description: Time when the campaign starts
  1986. type: string
  1987. format: date-time
  1988. toTime:
  1989. description: Time when the campaign ends
  1990. type: string
  1991. format: date-time
  1992. example:
  1993. self@NavigationLink: "<domain>/campaigns/1"
  1994. Observations@NavigationLink: "<domain>/campaigns/1/units/observations"
  1995. Locations@NavigationLink: "<domain>/campaigns/1/units/observations/locations"
  1996. Units@NavigationLink: "<domain>/campaigns/1/units"
  1997. id: 1
  1998. name: "Campaign 1"
  1999. description: "Campaign description"
  2000. fromTime: "2011-12-03T10:15:30+01:00"
  2001. toTime: "2011-12-03T10:15:30+01:00"
  2002. CampaignUnitBasicInfo:
  2003. type: object
  2004. required:
  2005. - unitId
  2006. - name
  2007. - fromTime
  2008. - toTime
  2009. x-NavigationLinks:
  2010. Unit@NavigationLink:
  2011. type: string
  2012. format: uri
  2013. x-graph-properties:
  2014. linkTo: unitIdGET
  2015. CampaignUnit@NavigationLink:
  2016. type: string
  2017. format: uri
  2018. x-graph-properties:
  2019. linkTo: campaignIdUnitIdGET
  2020. properties:
  2021. Unit@NavigationLink:
  2022. $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
  2023. CampaignUnit@NavigationLink:
  2024. $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/CampaignUnit@NavigationLink'
  2025. unitId:
  2026. description: Identifier of the unit
  2027. type: integer
  2028. format: int64
  2029. name:
  2030. type: string
  2031. description:
  2032. type: string
  2033. fromTime:
  2034. description: Time when the validity of the unit starts within the campaign
  2035. type: string
  2036. format: date-time
  2037. toTime:
  2038. description: Time when the validity of the unit ends within the campaign
  2039. type: string
  2040. format: date-time
  2041. example:
  2042. Unit@NavigationLink: "<domain>/units/25"
  2043. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  2044. unitId: 25
  2045. name: "Unit name"
  2046. description: "Purpose of the Unit 25"
  2047. fromTime: "2011-12-03T10:15:30+01:00"
  2048. toTime: "2011-12-03T10:15:30+01:00"
  2049. CampaignUnitDetailInfo:
  2050. type: object
  2051. required:
  2052. - unitId
  2053. - imei
  2054. - fromTime
  2055. - toTime
  2056. x-NavigationLinks:
  2057. self@NavigationLink:
  2058. type: string
  2059. format: uri
  2060. x-graph-properties:
  2061. linkTo: campaignIdUnitIdGET
  2062. Unit@NavigationLink:
  2063. type: string
  2064. format: uri
  2065. x-graph-properties:
  2066. linkTo: unitIdGET
  2067. Campaign@NavigationLink:
  2068. type: string
  2069. format: uri
  2070. x-graph-properties:
  2071. linkTo: campaignIdGET
  2072. Sensors@NavigationLink:
  2073. type: string
  2074. format: uri
  2075. x-graph-properties:
  2076. linkTo: campaignIdUnitIdSensorsGET
  2077. Observations@NavigationLink:
  2078. type: string
  2079. format: uri
  2080. x-graph-properties:
  2081. linkTo: campaignIdUnitIdObservationsGET
  2082. Locations@NavigationLink:
  2083. type: string
  2084. format: uri
  2085. x-graph-properties:
  2086. linkTo: campaignIdUnitIdLocationsGET
  2087. Alerts@NavigationLink:
  2088. type: string
  2089. format: uni
  2090. x-graph-properties:
  2091. linkTo: campaignIdUnitIdAlertsGET
  2092. properties:
  2093. self@NavigationLink:
  2094. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  2095. Unit@NavigationLink:
  2096. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  2097. Campaign@NavigationLink:
  2098. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Campaign@NavigationLink'
  2099. Sensors@NavigationLink:
  2100. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  2101. Observations@NavigationLink:
  2102. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  2103. Locations@NavigationLink:
  2104. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  2105. Alerts@NavigationLink:
  2106. $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Alerts@NavigationLink'
  2107. unitId:
  2108. description: Identifier of the unit
  2109. type: integer
  2110. format: int64
  2111. imei:
  2112. type: string
  2113. description:
  2114. type: string
  2115. fromTime:
  2116. description: Time when the validity of the unit starts within the campaign
  2117. type: string
  2118. format: date-time
  2119. toTime:
  2120. description: Time when the validity of the unit ends within the campaign
  2121. type: string
  2122. format: date-time
  2123. example:
  2124. self@NavigationLink: "<domain>/campaigns/1/units/25"
  2125. Unit@NavigationLink: "<domain>/units/25"
  2126. Campaign@NavigationLink: "<domain>/campaigns/1"
  2127. Sensors@NavigationLink: "<domain>/campaigns/1/units/25/sensors"
  2128. Observations@NavigationLink: "<domain>/campaigns/1/units/25/observations"
  2129. Locations@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations"
  2130. Alerts@NavigationLink: "<domain>/campaigns/1/units/25/alerts"
  2131. unitId: 25
  2132. imei: "3434533453"
  2133. description: "Purpose of the Unit 25"
  2134. fromTime: "2011-12-03T10:15:30+01:00"
  2135. toTime: "2011-12-03T10:15:30+01:00"
  2136. CampaignUnitBasicSensor:
  2137. type: object
  2138. required:
  2139. - sensorId
  2140. - name
  2141. - type
  2142. x-NavigationLinks:
  2143. CampaignSensor@NavigationLink:
  2144. type: string
  2145. format: uri
  2146. x-graph-properties:
  2147. linkTo: campaignIdUnitIdSensorIdGET
  2148. properties:
  2149. CampaignSensor@NavigationLink:
  2150. $ref: '#/components/schemas/CampaignUnitBasicSensor/x-NavigationLinks/CampaignSensor@NavigationLink'
  2151. sensorId:
  2152. description: Identifier of the unit
  2153. type: integer
  2154. format: int64
  2155. name:
  2156. type: string
  2157. type:
  2158. type: string
  2159. example:
  2160. CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  2161. sensorId: 105
  2162. name: "Sensor 105"
  2163. type: "X"
  2164. CampaignUnitDetailedSensor:
  2165. type: object
  2166. required:
  2167. - sensorId
  2168. - ioId
  2169. - ioMultiplier
  2170. - name
  2171. - phenomenon
  2172. - type
  2173. x-NavigationLinks:
  2174. self@NavigationLink:
  2175. type: string
  2176. format: uri
  2177. x-graph-properties:
  2178. linkTo: campaignIdUnitIdSensorIdGET
  2179. Sensor@NavigationLink:
  2180. type: string
  2181. format: uri
  2182. x-graph-properties:
  2183. linkTo: sensorIdGET
  2184. CampaignUnit@NavigationLink:
  2185. type: string
  2186. format: uri
  2187. x-graph-properties:
  2188. linkTo: campaignIdUnitIdGET
  2189. Phenomenon@NavigationLink:
  2190. type: string
  2191. format: uri
  2192. x-graph-properties:
  2193. linkTo: phenomenonIdGET
  2194. Observations@NavigationLink:
  2195. type: string
  2196. format: uri
  2197. x-graph-properties:
  2198. linkTo: campaignIdUnitIdSensorIdObservationsGET
  2199. properties:
  2200. self@NavigationLink:
  2201. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/self@NavigationLink'
  2202. Sensor@NavigationLink:
  2203. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Sensor@NavigationLink'
  2204. CampaignUnit@NavigationLink:
  2205. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/CampaignUnit@NavigationLink'
  2206. Phenomenon@NavigationLink:
  2207. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Phenomenon@NavigationLink'
  2208. Observations@NavigationLink:
  2209. $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Observations@NavigationLink'
  2210. sensorId:
  2211. type: integer
  2212. format: int64
  2213. ioId:
  2214. type: integer
  2215. format: int32
  2216. minimum: 1
  2217. ioMultiplier:
  2218. type: number
  2219. name:
  2220. type: string
  2221. phenomenon:
  2222. type: string
  2223. type:
  2224. type: string
  2225. description:
  2226. type: string
  2227. example:
  2228. self@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  2229. Sensor@NavigationLink: "<domain>/sensors/105"
  2230. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  2231. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  2232. Observations@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations"
  2233. sensorId: 105
  2234. ioId: 98
  2235. ioMultiplier: 0.1
  2236. name: "Sensor 105"
  2237. description: "Description of the sensor 105"
  2238. type: "type of sensor"
  2239. phenomenon: "Temperature"
  2240. CampaignObservationPaging:
  2241. type: object
  2242. required:
  2243. - params
  2244. - hasNext
  2245. - size
  2246. - offset
  2247. - data
  2248. x-NavigationLinks:
  2249. Campaign@NavigationLink:
  2250. type: string
  2251. format: uri
  2252. x-graph-properties:
  2253. linkTo: campaignIdGET
  2254. next@NavigationLink:
  2255. type: string
  2256. format: uri
  2257. x-graph-properties:
  2258. linkTo: campaignIdUnitsObservationsGET
  2259. properties:
  2260. Campaign@NavigationLink:
  2261. $ref: '#/components/schemas/CampaignObservationPaging/x-NavigationLinks/Campaign@NavigationLink'
  2262. next@NavigationLink:
  2263. $ref: '#/components/schemas/CampaignObservationPaging/x-NavigationLinks/next@NavigationLink'
  2264. params:
  2265. type: object
  2266. description: Used params in URL
  2267. hasNext:
  2268. type: boolean
  2269. size:
  2270. type: integer
  2271. offset:
  2272. type: integer
  2273. data:
  2274. type: array
  2275. items:
  2276. $ref: '#/components/schemas/CampaignDataObservation'
  2277. example:
  2278. Campaign@NavigationLink: "<domain>/campaigns/1"
  2279. next@NavigationLink: "<domain>/campaigns/1/observations?offset=500"
  2280. size: 500
  2281. offset: 0
  2282. data: []
  2283. GeoFeatureCollectionUnit:
  2284. type: object
  2285. required:
  2286. - type
  2287. - features
  2288. properties:
  2289. type:
  2290. type: string
  2291. enum:
  2292. - FeatureCollection
  2293. metadata:
  2294. type: object
  2295. features:
  2296. type: array
  2297. minLength: 1
  2298. items:
  2299. $ref: '#/components/schemas/GeoFeatureUnitObservation'
  2300. GeoFeatureUnitObservation:
  2301. type: object
  2302. required:
  2303. - type
  2304. - geometry
  2305. - properties
  2306. properties:
  2307. type:
  2308. type: string
  2309. enum:
  2310. - Feature
  2311. geometry:
  2312. $ref: '#/components/schemas/GeoPoint'
  2313. properties:
  2314. type: object
  2315. required:
  2316. - unitId
  2317. - timestamp
  2318. - speed
  2319. properties:
  2320. unitId:
  2321. type: integer
  2322. format: int64
  2323. timestamp:
  2324. type: string
  2325. format: date-time
  2326. speed:
  2327. type: integer
  2328. format: int64
  2329. observedValues:
  2330. type: object
  2331. GeoPoint:
  2332. type: object
  2333. required:
  2334. - type
  2335. - coordinates
  2336. properties:
  2337. type:
  2338. type: string
  2339. enum:
  2340. - Point
  2341. coordinates:
  2342. type: array
  2343. items:
  2344. type: number
  2345. format: float
  2346. minLength: 3
  2347. maxLength: 3
  2348. description: "[lon, lat, alt]"
  2349. CampaignUnitObservationPaging:
  2350. type: object
  2351. required:
  2352. - params
  2353. - hasNext
  2354. - size
  2355. - offset
  2356. - data
  2357. x-NavigationLinks:
  2358. CampaignUnit@NavigationLink:
  2359. type: string
  2360. format: uri
  2361. x-graph-properties:
  2362. linkTo: campaignIdUnitIdGET
  2363. next@NavigationLink:
  2364. type: string
  2365. format: uri
  2366. x-graph-properties:
  2367. linkTo: campaignIdUnitIdObservationsGET
  2368. properties:
  2369. CampaignUnit@NavigationLink:
  2370. $ref: '#/components/schemas/CampaignUnitObservationPaging/x-NavigationLinks/CampaignUnit@NavigationLink'
  2371. next@NavigationLink:
  2372. $ref: '#/components/schemas/CampaignUnitObservationPaging/x-NavigationLinks/next@NavigationLink'
  2373. params:
  2374. type: object
  2375. description: Used params in URL
  2376. hasNext:
  2377. type: boolean
  2378. size:
  2379. type: integer
  2380. offset:
  2381. type: integer
  2382. data:
  2383. type: array
  2384. items:
  2385. $ref: '#/components/schemas/UnitDataObservation'
  2386. example:
  2387. CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
  2388. next@NavigationLink: "<domain>/campaigns/1/units/25/observations?offset=500"
  2389. params: []
  2390. size: 500
  2391. hasNext: true
  2392. offset: 0
  2393. data: []
  2394. CampaignUnitSensorObservationPaging:
  2395. type: object
  2396. required:
  2397. - params
  2398. - size
  2399. - offset
  2400. - hasNext
  2401. - data
  2402. x-NavigationLinks:
  2403. CampaignSensor@NavigationLink:
  2404. type: string
  2405. format: uri
  2406. x-graph-properties:
  2407. linkTo: campaignIdUnitIdSensorIdGET
  2408. next@NavigationLink:
  2409. type: string
  2410. format: uri
  2411. x-graph-properties:
  2412. linkTo: campaignIdUnitIdSensorIdObservationsGET
  2413. properties:
  2414. CampaignSensor@NavigationLink:
  2415. $ref: '#/components/schemas/CampaignUnitSensorObservationPaging/x-NavigationLinks/CampaignSensor@NavigationLink'
  2416. next@NavigationLink:
  2417. $ref: '#/components/schemas/CampaignUnitSensorObservationPaging/x-NavigationLinks/next@NavigationLink'
  2418. params:
  2419. type: object
  2420. description: Used params in URL
  2421. size:
  2422. type: integer
  2423. offset:
  2424. type: integer
  2425. hasNext:
  2426. type: boolean
  2427. data:
  2428. type: array
  2429. items:
  2430. $ref: '#/components/schemas/SensorDataObservation'
  2431. example:
  2432. CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
  2433. next@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations?offset=500"
  2434. size: 500
  2435. offset: 0
  2436. data: []
  2437. ActionEventObservationPaging:
  2438. type: object
  2439. required:
  2440. - params
  2441. - hasNext
  2442. - size
  2443. - offset
  2444. - data
  2445. x-NavigationLinks:
  2446. Event@NavigationLink:
  2447. type: string
  2448. format: uri
  2449. x-graph-properties:
  2450. linkTo: eventIdGET
  2451. next@NavigationLink:
  2452. type: string
  2453. format: uri
  2454. x-graph-properties:
  2455. linkTo: eventIdObservationsGET
  2456. properties:
  2457. Event@NavigationLink:
  2458. $ref: '#/components/schemas/ActionEventObservationPaging/x-NavigationLinks/Event@NavigationLink'
  2459. next@NavigationLink:
  2460. $ref: '#/components/schemas/ActionEventObservationPaging/x-NavigationLinks/next@NavigationLink'
  2461. params:
  2462. type: object
  2463. description: Used params in URL
  2464. hasNext:
  2465. type: boolean
  2466. size:
  2467. type: integer
  2468. offset:
  2469. type: integer
  2470. data:
  2471. type: array
  2472. items:
  2473. $ref: '#/components/schemas/UnitDataObservation'
  2474. example:
  2475. Event@NavigationLink: "<domain>/events/999"
  2476. next@NavigationLink: "<domain>/events/999/observations?offset=500"
  2477. params: []
  2478. size: 500
  2479. hasNext: true
  2480. offset: 0
  2481. data: []
  2482. CampaignDataObservation:
  2483. type: object
  2484. required:
  2485. - unitId
  2486. - observedValues
  2487. properties:
  2488. unitId:
  2489. type: integer
  2490. format: int64
  2491. timestamp:
  2492. type: string
  2493. epoch:
  2494. type: integer
  2495. format: int64
  2496. speed:
  2497. type: integer
  2498. format: int64
  2499. location:
  2500. $ref: '#/components/schemas/Location'
  2501. observedValues:
  2502. type: object
  2503. example:
  2504. unitId: 25
  2505. timestamp: "2011-12-03T10:15:30+01:00"
  2506. location:
  2507. longitude: 49.7384
  2508. latitude: 13.3736
  2509. altitude: 350.3
  2510. observedValues:
  2511. 105: 1434
  2512. UnitDataObservation:
  2513. type: object
  2514. required:
  2515. - timestamp
  2516. - speed
  2517. - location
  2518. - observedValues
  2519. properties:
  2520. timestamp:
  2521. type: string
  2522. format: date-time
  2523. speed:
  2524. type: integer
  2525. format: int64
  2526. location:
  2527. $ref: '#/components/schemas/Location'
  2528. observedValues:
  2529. type: object
  2530. example:
  2531. timestamp: "2011-12-03T10:15:30+01:00"
  2532. speed: 34
  2533. location:
  2534. longitude: 49.7384
  2535. latitude: 13.3736
  2536. altitude: 350.3
  2537. observedValues:
  2538. temperature: 28
  2539. SensorDataObservation:
  2540. type: object
  2541. required:
  2542. - timestamp
  2543. - observedValue
  2544. - speed
  2545. - location
  2546. properties:
  2547. timestamp:
  2548. type: string
  2549. format: date-time
  2550. observedValue:
  2551. type: number
  2552. format: double
  2553. speed:
  2554. type: integer
  2555. format: int64
  2556. location:
  2557. $ref: '#/components/schemas/Location'
  2558. example:
  2559. timestamp: "2011-12-03T10:15:30+01:00"
  2560. observedValue: 1434
  2561. speed: 34
  2562. location:
  2563. longitude: 49.7384
  2564. latitude: 13.3736
  2565. altitude: 350.3
  2566. CampaignUnitLocationPaging:
  2567. type: object
  2568. required:
  2569. - params
  2570. - hasNext
  2571. - size
  2572. - offset
  2573. - data
  2574. x-NavigationLinks:
  2575. Campaign@NavigationLink:
  2576. type: string
  2577. format: uri
  2578. x-graph-properties:
  2579. linkTo: campaignIdGET
  2580. Unit@NavigationLink:
  2581. type: string
  2582. format: uri
  2583. x-graph-properties:
  2584. linkTo: campaignIdUnitIdGET
  2585. next@NavigationLink:
  2586. type: string
  2587. format: uri
  2588. x-graph-properties:
  2589. linkTo: campaignIdUnitIdLocationsGET
  2590. properties:
  2591. Campaign@NavigationLink:
  2592. $ref: '#/components/schemas/CampaignUnitLocationPaging/x-NavigationLinks/Campaign@NavigationLink'
  2593. Unit@NavigationLink:
  2594. $ref: '#/components/schemas/CampaignUnitLocationPaging/x-NavigationLinks/Unit@NavigationLink'
  2595. next@NavigationLink:
  2596. $ref: '#/components/schemas/CampaignUnitLocationPaging/x-NavigationLinks/next@NavigationLink'
  2597. params:
  2598. type: object
  2599. description: Used params in URL
  2600. hasNext:
  2601. type: boolean
  2602. size:
  2603. type: integer
  2604. offset:
  2605. type: integer
  2606. data:
  2607. type: array
  2608. items:
  2609. type: object
  2610. properties:
  2611. timestamp:
  2612. type: string
  2613. format: date-time
  2614. location:
  2615. $ref: '#/components/schemas/Location'
  2616. example:
  2617. Campaign@NavigationLink: "<domain>/campaigns/1"
  2618. Unit@NavigationLink: "<domain>/campaigns/1/units/25"
  2619. next@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations?offset=500"
  2620. params:
  2621. offset: 0
  2622. limit: 500
  2623. navigationLinks: true
  2624. size: 500
  2625. hasNext: true
  2626. offset: 0
  2627. data:
  2628. - timestamp: "2011-12-03T10:15:30+01:00"
  2629. location:
  2630. longitude: 49.7384
  2631. latitude: 13.3736
  2632. altitude: 350.3
  2633. CampaignUnitsLocationArray:
  2634. type: array
  2635. items:
  2636. $ref: '#/components/schemas/CampaignUnitsLocation'
  2637. CampaignUnitsLocation:
  2638. type: object
  2639. required:
  2640. - unitId
  2641. - timestamp
  2642. - location
  2643. properties:
  2644. unitId:
  2645. type: integer
  2646. format: int64
  2647. timestamp:
  2648. type: string
  2649. format: date-time
  2650. location:
  2651. $ref: '#/components/schemas/Location'
  2652. example:
  2653. unitId: 25
  2654. timestamp: "2011-12-03T10:15:30+01:00"
  2655. location:
  2656. longitude: 49.7384
  2657. latitude: 13.3736
  2658. altitude: 350.3
  2659. CampaignUnitsLocationsPaging:
  2660. type: object
  2661. required:
  2662. - params
  2663. - size
  2664. - data
  2665. x-NavigationLinks:
  2666. Campaign@NavigationLink:
  2667. type: string
  2668. format: uri
  2669. x-graph-properties:
  2670. linkTo: campaignIdGET
  2671. properties:
  2672. Campaign@NavigationLink:
  2673. $ref: '#/components/schemas/CampaignUnitsLocationsPaging/x-NavigationLinks/Campaign@NavigationLink'
  2674. params:
  2675. type: object
  2676. description: Used params in URL
  2677. size:
  2678. type: integer
  2679. data:
  2680. $ref: '#/components/schemas/CampaignUnitsLocationArray'
  2681. example:
  2682. Campaign@NavigationLink: "<domain>/campaigns/1"
  2683. params:
  2684. from: "2011-12-03T10:15:30+01:00"
  2685. to: "2011-12-03T10:15:30+01:00"
  2686. navigationLinks: true
  2687. size: 8
  2688. data:
  2689. - unitId: 25
  2690. timestamp: "2011-12-03T10:15:30+01:00"
  2691. location:
  2692. longitude: 49.7384
  2693. latitude: 13.3736
  2694. altitude: 350.3
  2695. GeoCampaignUnitsSingleLocations:
  2696. type: object
  2697. required:
  2698. - type
  2699. - features
  2700. properties:
  2701. type:
  2702. type: string
  2703. enum:
  2704. - FeatureCollection
  2705. metadata:
  2706. type: object
  2707. features:
  2708. type: array
  2709. minLength: 2
  2710. items:
  2711. $ref: '#/components/schemas/GeoFeatureUnitSingleLocation'
  2712. GeoFeatureUnitSingleLocation:
  2713. type: object
  2714. required:
  2715. - type
  2716. - properties
  2717. - geometry
  2718. properties:
  2719. type:
  2720. type: string
  2721. enum:
  2722. - Feature
  2723. properties:
  2724. type: object
  2725. required:
  2726. - unitId
  2727. - timestamp
  2728. properties:
  2729. unitId:
  2730. type: integer
  2731. format: int64
  2732. timestamp:
  2733. type: string
  2734. format: date-time
  2735. geometry:
  2736. $ref: '#/components/schemas/GeoPoint'
  2737. GeoCampaignUnitsMultiLocations:
  2738. type: object
  2739. required:
  2740. - type
  2741. - features
  2742. properties:
  2743. type:
  2744. type: string
  2745. enum:
  2746. - FeatureCollection
  2747. metadata:
  2748. type: object
  2749. features:
  2750. type: array
  2751. minLength: 1
  2752. items:
  2753. $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
  2754. GeoFeatureUnitMultiLocation:
  2755. type: object
  2756. required:
  2757. - type
  2758. - properties
  2759. - geometry
  2760. properties:
  2761. type:
  2762. type: string
  2763. enum:
  2764. - Feature
  2765. properties:
  2766. type: object
  2767. required:
  2768. - unitId
  2769. - fromTime
  2770. - toTime
  2771. properties:
  2772. unitId:
  2773. type: integer
  2774. format: int64
  2775. fromTime:
  2776. type: string
  2777. format: date-time
  2778. toTime:
  2779. type: string
  2780. format: date-time
  2781. geometry:
  2782. $ref: '#/components/schemas/GeoMultiPoint'
  2783. GeoMultiPoint:
  2784. type: object
  2785. required:
  2786. - type
  2787. - coordinates
  2788. properties:
  2789. type:
  2790. type: string
  2791. enum:
  2792. - MultiPoint
  2793. coordinates:
  2794. type: array
  2795. minLength: 1
  2796. items:
  2797. type: array
  2798. items:
  2799. type: number
  2800. format: float
  2801. minLength: 3
  2802. maxLength: 3
  2803. description: "[lon, lat, alt]"
  2804. ActionEventLocationPaging:
  2805. type: object
  2806. required:
  2807. - params
  2808. - hasNext
  2809. - size
  2810. - offset
  2811. - data
  2812. x-NavigationLinks:
  2813. Event@NavigationLink:
  2814. type: string
  2815. format: uri
  2816. x-graph-properties:
  2817. linkTo: eventIdGET
  2818. next@NavigationLink:
  2819. type: string
  2820. format: uri
  2821. x-graph-properties:
  2822. linkTo: eventIdLocationsGET
  2823. properties:
  2824. Event@NavigationLink:
  2825. $ref: '#/components/schemas/ActionEventLocationPaging/x-NavigationLinks/Event@NavigationLink'
  2826. next@NavigationLink:
  2827. $ref: '#/components/schemas/ActionEventLocationPaging/x-NavigationLinks/next@NavigationLink'
  2828. params:
  2829. type: object
  2830. description: Used params in URL
  2831. hasNext:
  2832. type: boolean
  2833. size:
  2834. type: integer
  2835. offset:
  2836. type: integer
  2837. data:
  2838. type: array
  2839. items:
  2840. type: object
  2841. properties:
  2842. timestamp:
  2843. type: string
  2844. format: date-time
  2845. location:
  2846. $ref: '#/components/schemas/Location'
  2847. example:
  2848. Event@NavigationLink: "<domain>/events/999"
  2849. next@NavigationLink: "<domain>/events/999/observations/locations?offset=500"
  2850. params:
  2851. offset: 0
  2852. limit: 500
  2853. navigationLinks: true
  2854. size: 500
  2855. hasNext: true
  2856. offset: 0
  2857. data:
  2858. - timestamp: "2011-12-03T10:15:30+01:00"
  2859. location:
  2860. longitude: 49.7384
  2861. latitude: 13.3736
  2862. altitude: 350.3
  2863. Location:
  2864. type: object
  2865. required:
  2866. - longitude
  2867. - latitude
  2868. - altitude
  2869. properties:
  2870. longitude:
  2871. type: number
  2872. format: float
  2873. latitude:
  2874. type: number
  2875. format: float
  2876. altitude:
  2877. type: number
  2878. format: float
  2879. example:
  2880. longitude: 49.7384
  2881. latitude: 13.3736
  2882. altitude: 350.3
  2883. UnitBasicInfo:
  2884. type: object
  2885. required:
  2886. - unitId
  2887. - name
  2888. x-NavigationLinks:
  2889. Unit@NavigationLink:
  2890. type: string
  2891. format: uri
  2892. x-graph-properties:
  2893. linkTo: unitIdGET
  2894. properties:
  2895. Unit@NavigationLink:
  2896. $ref: '#/components/schemas/UnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
  2897. unitId:
  2898. description: Identifier of the unit
  2899. type: integer
  2900. format: int64
  2901. name:
  2902. type: string
  2903. description:
  2904. type: string
  2905. example:
  2906. Unit@NavigationLink: "<domain>/units/25"
  2907. unitId: 25
  2908. name: "Mobile Unit"
  2909. description: "Mobile Unit 25"
  2910. UnitDetailInfo:
  2911. type: object
  2912. required:
  2913. - unitId
  2914. - name
  2915. - imei
  2916. x-NavigationLinks:
  2917. self@NavigationLink:
  2918. type: string
  2919. format: uri
  2920. x-graph-properties:
  2921. linkTo: unitIdGET
  2922. Sensors@NavigationLink:
  2923. type: string
  2924. format: uri
  2925. x-graph-properties:
  2926. linkTo: unitIdSensorsGET
  2927. Campaigns@NavigationLink:
  2928. type: string
  2929. format: uri
  2930. x-graph-properties:
  2931. linkTo: unitIdCampaignsGET
  2932. Entities@NavigationLink:
  2933. type: string
  2934. format: uri
  2935. x-graph-properties:
  2936. linkTo: unitIdEntitiesGET
  2937. properties:
  2938. self@NavigationLink:
  2939. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  2940. Sensors@NavigationLink:
  2941. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  2942. Campaigns@NavigationLink:
  2943. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Campaigns@NavigationLink'
  2944. Entities@NavigationLink:
  2945. $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Entities@NavigationLink'
  2946. unitId:
  2947. description: Identifier of the unit
  2948. type: integer
  2949. format: int64
  2950. name:
  2951. type: string
  2952. imei:
  2953. type: string
  2954. description:
  2955. type: string
  2956. example:
  2957. self@NavigationLink: "<domain>/units/25"
  2958. Sensors@NavigationLink: "<domain>/units/25/sensors"
  2959. Campaigns@NavigationLink: "<domain>/units/25/campaigns"
  2960. Entities@NavigationLink: "<domain>/units/25/entities"
  2961. unitId: 25
  2962. name: "Mobile Unit"
  2963. description: "Mobile Unit 25"
  2964. imei: "3434535323345"
  2965. UnitSensorBasicInfo:
  2966. type: object
  2967. required:
  2968. - sensorId
  2969. - name
  2970. x-NavigationLinks:
  2971. Sensor@NavigationLink:
  2972. type: string
  2973. format: uri
  2974. x-graph-properties:
  2975. linkTo: sensorIdGET
  2976. properties:
  2977. Sensor@NavigationLink:
  2978. $ref: '#/components/schemas/UnitSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  2979. sensorId:
  2980. description: Identifier of the unit
  2981. type: integer
  2982. format: int64
  2983. name:
  2984. type: string
  2985. type:
  2986. type: string
  2987. example:
  2988. Sensor@NavigationLink: "<domain>/sensors/105"
  2989. sensorId: 105
  2990. name: "Sensor 105"
  2991. type: "temperature"
  2992. UnitCampaignBasicInfo:
  2993. type: object
  2994. required:
  2995. - id
  2996. - name
  2997. - fromTime
  2998. - toTime
  2999. x-NavigationLinks:
  3000. Campaign@NavigationLink:
  3001. type: string
  3002. format: uri
  3003. x-graph-properties:
  3004. linkTo: campaignIdGET
  3005. properties:
  3006. Campaign@NavigationLink:
  3007. $ref: '#/components/schemas/UnitCampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
  3008. id:
  3009. type: integer
  3010. format: int64
  3011. description: Identifier of the campaign
  3012. name:
  3013. type: string
  3014. description: Description of the campaign
  3015. fromTime:
  3016. type: string
  3017. format: date-time
  3018. description: Time from the unit was active in the campaign
  3019. toTime:
  3020. type: string
  3021. format: date-time
  3022. description: Time until the unit was active in the campaign
  3023. example:
  3024. Campaign@NavigationLink: "<domain>/campaigns/1"
  3025. id: 1
  3026. name: "Campaign 1"
  3027. fromTime: "2011-12-03T10:15:30+01:00"
  3028. toTime: "2011-12-03T10:15:30+01:00"
  3029. UnitEntityBasicInfo:
  3030. type: object
  3031. required:
  3032. - id
  3033. - name
  3034. x-NavigationLinks:
  3035. Entity@NavigationLink:
  3036. type: string
  3037. format: uri
  3038. x-graph-properties:
  3039. linkTo: entityIdGET
  3040. properties:
  3041. Entity@NavigationLink:
  3042. $ref: '#/components/schemas/UnitEntityBasicInfo/x-NavigationLinks/Entity@NavigationLink'
  3043. id:
  3044. type: integer
  3045. format: int64
  3046. name:
  3047. type: string
  3048. example:
  3049. Entity@NavigationLink: "<domain>/entities/42"
  3050. id: 42
  3051. name: "Steve Smith"
  3052. EntityActionUnitBasicInfo:
  3053. type: object
  3054. required:
  3055. - unitId
  3056. - name
  3057. x-NavigationLinks:
  3058. EntityActionUnit@NavigationLink:
  3059. type: string
  3060. format: uri
  3061. x-graph-properties:
  3062. linkTo: entityIdActionIdUnitIdGET
  3063. properties:
  3064. EntityActionUnit@NavigationLink:
  3065. $ref: '#/components/schemas/EntityActionUnitBasicInfo/x-NavigationLinks/EntityActionUnit@NavigationLink'
  3066. unitId:
  3067. description: Identifier of the unit
  3068. type: integer
  3069. format: int64
  3070. name:
  3071. type: string
  3072. description:
  3073. type: string
  3074. example:
  3075. EntityActionUnit@NavigationLink: "<domain>/entities/42/actions/258/units/25"
  3076. unitId: 25
  3077. name: "Unit name"
  3078. description: "Purpose of the Unit 25"
  3079. EntityActionUnitDetailInfo:
  3080. type: object
  3081. required:
  3082. - unitId
  3083. - name
  3084. - imei
  3085. x-NavigationLinks:
  3086. self@NavigationLink:
  3087. type: string
  3088. format: uri
  3089. x-graph-properties:
  3090. linkTo: entityIdActionIdUnitIdGET
  3091. EntityAction@NavigationLink:
  3092. type: string
  3093. format: uri
  3094. x-graph-properties:
  3095. linkTo: entityIdActionIdGET
  3096. Events@NavigationLink:
  3097. type: string
  3098. format: uri
  3099. x-graph-properties:
  3100. linkTo: entityIdUnitIdActionIdEventsGET
  3101. Unit@NavigationLink:
  3102. type: string
  3103. format: uri
  3104. x-graph-properties:
  3105. linkTo: unitIdGET
  3106. Alerts@NavigationLink:
  3107. type: string
  3108. format: uri
  3109. x-graph-properties:
  3110. linkTo: entityIdActionIdUnitIdAlertsGET
  3111. properties:
  3112. self@NavigationLink:
  3113. $ref: '#/components/schemas/EntityActionUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  3114. EntityAction@NavigationLink:
  3115. $ref: '#/components/schemas/EntityActionUnitDetailInfo/x-NavigationLinks/EntityAction@NavigationLink'
  3116. Unit@NavigationLink:
  3117. $ref: '#/components/schemas/EntityActionUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  3118. Events@NavigationLink:
  3119. $ref: '#/components/schemas/EntityActionUnitDetailInfo/x-NavigationLinks/Events@NavigationLink'
  3120. Alerts@NavigationLink:
  3121. $ref: '#/components/schemas/EntityActionUnitDetailInfo/x-NavigationLinks/Alerts@NavigationLink'
  3122. unitId:
  3123. description: Identifier of the unit
  3124. type: integer
  3125. format: int64
  3126. name:
  3127. type: string
  3128. imei:
  3129. type: string
  3130. description:
  3131. type: string
  3132. example:
  3133. self@NavigationLink: "<domain>/entities/42/actions/258/units/25"
  3134. EntityAction@NavigationLink: "<domain>/entities/42/actions/258"
  3135. Events@NavigationLink: "<domain>/entities/42/units/25/actions/258/events"
  3136. Unit@NavigationLink: "<domain>/units/25"
  3137. Alerts@NavigationLink: "<domain>/alerts/34"
  3138. unitId: 25
  3139. name: "Mobile Unit"
  3140. description: "Mobile Unit 25"
  3141. imei: "3434535323345"
  3142. SensorBasicInfo:
  3143. type: object
  3144. required:
  3145. - sensorId
  3146. - name
  3147. x-NavigationLinks:
  3148. Sensor@NavigationLink:
  3149. type: string
  3150. format: uri
  3151. x-graph-properties:
  3152. linkTo: sensorIdGET
  3153. properties:
  3154. Sensor@NavigationLink:
  3155. $ref: '#/components/schemas/SensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  3156. sensorId:
  3157. type: integer
  3158. format: int64
  3159. name:
  3160. type: string
  3161. description:
  3162. type: string
  3163. example:
  3164. Sensor@NavigationLink: "<domain>/sensors/105"
  3165. sensorId: 105
  3166. name: "Sensor 105"
  3167. description: "Description of the sensor 105"
  3168. SensorDetailInfo:
  3169. type: object
  3170. required:
  3171. - sensorId
  3172. - ioId
  3173. - ioMultiplier
  3174. - name
  3175. - phenomenon
  3176. x-NavigationLinks:
  3177. self@NavigationLink:
  3178. type: string
  3179. format: uri
  3180. x-graph-properties:
  3181. linkTo: sensorIdGET
  3182. Units@NavigationLink:
  3183. type: string
  3184. format: uri
  3185. x-graph-properties:
  3186. linkTo: sensorIdUnitsGET
  3187. Phenomenon@NavigationLink:
  3188. type: string
  3189. format: uri
  3190. x-graph-properties:
  3191. linkTo: phenomenonIdGET
  3192. properties:
  3193. self@NavigationLink:
  3194. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/self@NavigationLink'
  3195. Units@NavigationLink:
  3196. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Units@NavigationLink'
  3197. Phenomenon@NavigationLink:
  3198. $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Phenomenon@NavigationLink'
  3199. sensorId:
  3200. type: integer
  3201. format: int64
  3202. ioId:
  3203. type: integer
  3204. format: int32
  3205. minimum: 1
  3206. ioMultiplier:
  3207. type: number
  3208. name:
  3209. type: string
  3210. phenomenon:
  3211. type: string
  3212. type:
  3213. type: string
  3214. description:
  3215. type: string
  3216. example:
  3217. self@NavigationLink: "<domain>/sensors/105"
  3218. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  3219. Units@NavigationLink: "<domain>/sensors/105/units"
  3220. sensorId: 105
  3221. ioId: 98
  3222. ioMultiplier: 0.1
  3223. name: "Sensor 105"
  3224. description: "Description of the sensor 105"
  3225. type: "type of sensor"
  3226. phenomenon: "Temperature"
  3227. SensorUnitBasicInfo:
  3228. type: object
  3229. required:
  3230. - unitId
  3231. - name
  3232. properties:
  3233. Unit@NavigationLink:
  3234. type: string
  3235. format: uri
  3236. unitId:
  3237. description: Identifier of the unit
  3238. type: integer
  3239. format: int64
  3240. name:
  3241. type: string
  3242. description:
  3243. type: string
  3244. example:
  3245. Unit@NavigationLink: "<domain>/units/25"
  3246. unitId: 25
  3247. name: "Mobile Unit"
  3248. description: "Mobile Unit 25"
  3249. PhenomenonBasicInfo:
  3250. type: object
  3251. required:
  3252. - id
  3253. - name
  3254. x-NavigationLinks:
  3255. Phenomenon@NavigationLink:
  3256. type: string
  3257. format: uri
  3258. x-graph-properties:
  3259. linkTo: phenomenonIdGET
  3260. properties:
  3261. Phenomenon@NavigationLink:
  3262. $ref: '#/components/schemas/PhenomenonBasicInfo/x-NavigationLinks/Phenomenon@NavigationLink'
  3263. id:
  3264. type: integer
  3265. format: int64
  3266. name:
  3267. type: string
  3268. example:
  3269. Phenomenon@NavigationLink: "<domain>/phenomenons/15"
  3270. id: 15
  3271. name: "Temperature"
  3272. PhenomenonDetailInfo:
  3273. type: object
  3274. required:
  3275. - id
  3276. - name
  3277. - uom
  3278. x-NavigationLinks:
  3279. self@NavigationLink:
  3280. type: string
  3281. format: uri
  3282. x-graph-properties:
  3283. linkTo: phenomenonIdGET
  3284. Sensors@NavigationLink:
  3285. type: string
  3286. format: uri
  3287. x-graph-properties:
  3288. linkTo: phenomenonIdSensorsGET
  3289. properties:
  3290. self@NavigationLink:
  3291. $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/self@NavigationLink'
  3292. Sensors@NavigationLink:
  3293. $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
  3294. id:
  3295. type: integer
  3296. format: int64
  3297. name:
  3298. type: string
  3299. uom:
  3300. type: string
  3301. maxLength: 30
  3302. uomLink:
  3303. type: string
  3304. format: uri
  3305. example:
  3306. self@NavigationLink: "<domain>/phenomenons/15"
  3307. Sensors@NavigationLink: "<domain>/phenomenons/15/sensors"
  3308. id: 15
  3309. name: "Temperature"
  3310. uom: "uom"
  3311. uomLink: "uom link"
  3312. PhenomenonSensorBasicInfo:
  3313. type: object
  3314. required:
  3315. - sensorId
  3316. - name
  3317. x-NavigationLinks:
  3318. Sensor@NavigationLink:
  3319. type: string
  3320. format: uri
  3321. x-graph-properties:
  3322. linkTo: sensorIdGET
  3323. properties:
  3324. Sensor@NavigationLink:
  3325. $ref: '#/components/schemas/PhenomenonSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
  3326. sensorId:
  3327. type: integer
  3328. format: int64
  3329. name:
  3330. type: string
  3331. description:
  3332. type: string
  3333. example:
  3334. Sensor@NavigationLink: "<domain>/sensors/105"
  3335. sensorId: 105
  3336. name: "Sensor 105"
  3337. description: "Description of Sensor 105"
  3338. EntityBasicInfo:
  3339. type: object
  3340. required:
  3341. - id
  3342. - name
  3343. x-NavigationLinks:
  3344. Entity@NavigationLink:
  3345. type: string
  3346. format: uri
  3347. x-graph-properties:
  3348. linkTo: entityIdGET
  3349. properties:
  3350. Entity@NavigationLink:
  3351. $ref: '#/components/schemas/EntityBasicInfo/x-NavigationLinks/Entity@NavigationLink'
  3352. id:
  3353. type: integer
  3354. format: int64
  3355. name:
  3356. type: string
  3357. example:
  3358. Entity@NavigationLink: "<domain>/entities/42"
  3359. id: 42
  3360. name: "Steve Smith"
  3361. EntityDetailInfo:
  3362. type: object
  3363. required:
  3364. - id
  3365. - name
  3366. x-NavigationLinks:
  3367. self@NavigationLink:
  3368. type: string
  3369. format: uri
  3370. x-graph-properties:
  3371. linkTo: entityIdGET
  3372. Units@NavigationLink:
  3373. type: string
  3374. format: uri
  3375. x-graph-properties:
  3376. linkTo: entityIdUnitsGET
  3377. Actions@NavigationLink:
  3378. type: string
  3379. format: uri
  3380. x-graph-properties:
  3381. linkTo: entityIdActionsGET
  3382. properties:
  3383. self@NavigationLink:
  3384. $ref: '#/components/schemas/EntityDetailInfo/x-NavigationLinks/self@NavigationLink'
  3385. Units@NavigationLink:
  3386. $ref: '#/components/schemas/EntityDetailInfo/x-NavigationLinks/Units@NavigationLink'
  3387. Actions@NavigationLink:
  3388. $ref: '#/components/schemas/EntityDetailInfo/x-NavigationLinks/Actions@NavigationLink'
  3389. id:
  3390. type: integer
  3391. format: int64
  3392. name:
  3393. type: string
  3394. example:
  3395. self@NavigationLink: "<domain>/entities/42"
  3396. Units@NavigationLink: "<domain>/entities/42/units"
  3397. Actions@NavigationLink: "<domain>/entities/42/actions"
  3398. id: 42
  3399. name: "Steve Smith"
  3400. EntityUnitBasicInfo:
  3401. type: object
  3402. required:
  3403. - unitId
  3404. - name
  3405. x-NavigationLinks:
  3406. EntityUnit@NavigationLink:
  3407. type: string
  3408. format: uri
  3409. x-graph-properties:
  3410. linkTo: entityIdUnitsGET
  3411. properties:
  3412. EntityUnit@NavigationLink:
  3413. $ref: '#/components/schemas/EntityUnitBasicInfo/x-NavigationLinks/EntityUnit@NavigationLink'
  3414. unitId:
  3415. description: Identifier of the unit
  3416. type: integer
  3417. format: int64
  3418. name:
  3419. type: string
  3420. description:
  3421. type: string
  3422. example:
  3423. EntityUnit@NavigationLink: "<domain>/entities/42/units/25"
  3424. unitId: 25
  3425. name: "Unit name"
  3426. description: "Purpose of the Unit 25"
  3427. EntityUnitDetailInfo:
  3428. type: object
  3429. required:
  3430. - unitId
  3431. - imei
  3432. - name
  3433. x-NavigationLinks:
  3434. self@NavigationLink:
  3435. type: string
  3436. format: uri
  3437. x-graph-properties:
  3438. linkTo: entityIdUnitIdGET
  3439. Unit@NavigationLink:
  3440. type: string
  3441. format: uri
  3442. x-graph-properties:
  3443. linkTo: unitIdGET
  3444. Actions@NavigationLink:
  3445. type: string
  3446. format: uri
  3447. x-graph-properties:
  3448. linkTo: entityIdUnitIdActionsGET
  3449. properties:
  3450. self@NavigationLink:
  3451. $ref: '#/components/schemas/EntityUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
  3452. Unit@NavigationLink:
  3453. $ref: '#/components/schemas/EntityUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  3454. Actions@NavigationLink:
  3455. $ref: '#/components/schemas/EntityUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
  3456. unitId:
  3457. description: Identifier of the unit
  3458. type: integer
  3459. format: int64
  3460. name:
  3461. type: string
  3462. imei:
  3463. type: string
  3464. description:
  3465. type: string
  3466. example:
  3467. self@NavigationLink: "<domain>/entities/42/units/25"
  3468. Unit@NavigationLink: "<domain>/units/25"
  3469. Actions@NavigationLink: "<domain>/entities/42/units/25/actions"
  3470. unitId: 25
  3471. name: "Mobile Unit"
  3472. description: "Mobile Unit 25"
  3473. imei: "3434535323345"
  3474. EntityActionBasicInfo:
  3475. type: object
  3476. required:
  3477. - id
  3478. - name
  3479. x-NavigationLinks:
  3480. EntityAction@NavigationLink:
  3481. type: string
  3482. format: uri
  3483. x-graph-properties:
  3484. linkTo: entityIdActionIdGET
  3485. properties:
  3486. EntityAction@NavigationLink:
  3487. $ref: '#/components/schemas/EntityActionBasicInfo/x-NavigationLinks/EntityAction@NavigationLink'
  3488. id:
  3489. type: integer
  3490. format: int64
  3491. name:
  3492. type: string
  3493. example:
  3494. EntityAction@NavigationLink: "<domain>/entities/42/actions/258"
  3495. id: 258
  3496. name: "Delivering"
  3497. EntityUnitActionBasicInfo:
  3498. type: object
  3499. required:
  3500. - id
  3501. - name
  3502. x-NavigationLinks:
  3503. EntityUntAction@NavigationLink:
  3504. type: string
  3505. format: uri
  3506. x-graph-properties:
  3507. linkTo: entityIdUnitIdActionIdGET
  3508. properties:
  3509. EntityUntAction@NavigationLink:
  3510. $ref: '#/components/schemas/EntityUnitActionBasicInfo/x-NavigationLinks/EntityUntAction@NavigationLink'
  3511. id:
  3512. type: integer
  3513. format: int64
  3514. name:
  3515. type: string
  3516. example:
  3517. EntityUntAction@NavigationLink: "<domain>/entities/42/units/{25}/actions/258"
  3518. id: 258
  3519. name: "Delivering"
  3520. EntityActionDetailInfo:
  3521. type: object
  3522. required:
  3523. - id
  3524. - name
  3525. x-NavigationLinks:
  3526. self@NavigationLink:
  3527. type: string
  3528. format: uri
  3529. x-graph-properties:
  3530. linkTo: entityIdActionIdGET
  3531. Entity@NavigationLink:
  3532. type: string
  3533. format: uri
  3534. x-graph-properties:
  3535. linkTo: entityIdGET
  3536. Units@NavigationLink:
  3537. type: string
  3538. format: uri
  3539. x-graph-properties:
  3540. linkTo: entityIdActionIdUnitsGET
  3541. properties:
  3542. self@NavigationLink:
  3543. $ref: '#/components/schemas/EntityActionDetailInfo/x-NavigationLinks/self@NavigationLink'
  3544. Entity@NavigationLink:
  3545. $ref: '#/components/schemas/EntityActionDetailInfo/x-NavigationLinks/Entity@NavigationLink'
  3546. Units@NavigationLink:
  3547. $ref: '#/components/schemas/EntityActionDetailInfo/x-NavigationLinks/Units@NavigationLink'
  3548. id:
  3549. type: integer
  3550. format: int64
  3551. name:
  3552. type: string
  3553. example:
  3554. self@NavigationLink: "<domain>/entities/42/actions/258"
  3555. Entity@NavigationLink: "<domain>/entities/42"
  3556. Units@NavigationLink: "<domain>/entities/42/actions/258/units"
  3557. id: 258
  3558. name: "Delivering"
  3559. EntityUnitActionDetailInfo:
  3560. type: object
  3561. required:
  3562. - id
  3563. - name
  3564. x-NavigationLinks:
  3565. self@NavigationLink:
  3566. type: string
  3567. format: uri
  3568. x-graph-properties:
  3569. linkTo: entityIdUnitIdActionIdGET
  3570. Entity@NavigationLink:
  3571. type: string
  3572. format: uri
  3573. x-graph-properties:
  3574. linkTo: entityIdGET
  3575. EntityUnit@NavigationLink:
  3576. type: string
  3577. format: uri
  3578. x-graph-properties:
  3579. linkTo: entityIdUnitIdGET
  3580. Events@NavigationLink:
  3581. type: string
  3582. format: uri
  3583. x-graph-properties:
  3584. linkTo: entityIdUnitIdActionIdEventsGET
  3585. properties:
  3586. self@NavigationLink:
  3587. $ref: '#/components/schemas/EntityUnitActionDetailInfo/x-NavigationLinks/self@NavigationLink'
  3588. Entity@NavigationLink:
  3589. $ref: '#/components/schemas/EntityUnitActionDetailInfo/x-NavigationLinks/Entity@NavigationLink'
  3590. EntityUnit@NavigationLink:
  3591. $ref: '#/components/schemas/EntityUnitActionDetailInfo/x-NavigationLinks/EntityUnit@NavigationLink'
  3592. Events@NavigationLink:
  3593. $ref: '#/components/schemas/EntityUnitActionDetailInfo/x-NavigationLinks/Events@NavigationLink'
  3594. id:
  3595. type: integer
  3596. format: int64
  3597. name:
  3598. type: string
  3599. example:
  3600. self@NavigationLink: "<domain>/entities/42/units/25/actions/258"
  3601. Entity@NavigationLink: "<domain>/entities/42"
  3602. EntityUnit@NavigationLink: "<domain>/entities/42/units/25"
  3603. Events@NavigationLink: "<domain>/entities/42/units/25/actions/258/events"
  3604. id: 258
  3605. name: "Delivering"
  3606. EventInsertInfo:
  3607. type: object
  3608. required:
  3609. - fromTime
  3610. properties:
  3611. fromTime:
  3612. description: Time when the event starts
  3613. type: string
  3614. format: date-time
  3615. toTime:
  3616. description: Time when the end ends
  3617. type: string
  3618. format: date-time
  3619. example:
  3620. fromTime: "2011-12-03T10:15:30+01:00"
  3621. toTime: "2011-12-03T10:15:30+01:00"
  3622. EventStatus:
  3623. type: string
  3624. enum:
  3625. - FINISHED
  3626. - ONGOING
  3627. EventBasicInfo:
  3628. type: object
  3629. required:
  3630. - id
  3631. - status
  3632. - fromTime
  3633. - toTime
  3634. x-NavigationLinks:
  3635. Event@NavigationLink:
  3636. type: string
  3637. format: uri
  3638. x-graph-properties:
  3639. linkTo: eventIdGET
  3640. properties:
  3641. Event@NavigationLink:
  3642. $ref: '#/components/schemas/EventBasicInfo/x-NavigationLinks/Event@NavigationLink'
  3643. id:
  3644. type: integer
  3645. format: int64
  3646. status:
  3647. $ref: '#/components/schemas/EventStatus'
  3648. fromTime:
  3649. description: Time when the event starts
  3650. type: string
  3651. format: date-time
  3652. toTime:
  3653. description: Time when the end ends
  3654. type: string
  3655. format: date-time
  3656. example:
  3657. Event@NavigationLink: "<domain>/events/999"
  3658. id: 999
  3659. status: "FINISHED"
  3660. fromTime: "2011-12-03T10:15:30+01:00"
  3661. toTime: "2011-12-03T10:15:30+01:00"
  3662. EventDetailInfo:
  3663. type: object
  3664. required:
  3665. - id
  3666. - entityId
  3667. - actionId
  3668. - unitId
  3669. - status
  3670. - fromTime
  3671. - toTime
  3672. x-NavigationLinks:
  3673. self@NavigationLink:
  3674. type: string
  3675. format: uri
  3676. x-graph-properties:
  3677. linkTo: eventIdGET
  3678. Entity@NavigationLink:
  3679. type: string
  3680. format: uri
  3681. x-graph-properties:
  3682. linkTo: entityIdGET
  3683. EntityUnit@NavigationLink:
  3684. type: string
  3685. format: uri
  3686. x-graph-properties:
  3687. linkTo: entityIdUnitIdGET
  3688. Action@NavigationLink:
  3689. type: string
  3690. format: uri
  3691. x-graph-properties:
  3692. linkTo: entityIdActionIdGET
  3693. Observations@NavigationLink:
  3694. type: string
  3695. format: uri
  3696. x-graph-properties:
  3697. linkTo: eventIdObservationsGET
  3698. Locations@NavigationLink:
  3699. type: string
  3700. format: uri
  3701. x-graph-properties:
  3702. linkTo: eventIdLocationsGET
  3703. properties:
  3704. self@NavigationLink:
  3705. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/self@NavigationLink'
  3706. Entity@NavigationLink:
  3707. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Entity@NavigationLink'
  3708. EntityUnit@NavigationLink:
  3709. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/EntityUnit@NavigationLink'
  3710. Action@NavigationLink:
  3711. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Action@NavigationLink'
  3712. Observations@NavigationLink:
  3713. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Observations@NavigationLink'
  3714. Locations@NavigationLink:
  3715. $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Locations@NavigationLink'
  3716. id:
  3717. type: integer
  3718. format: int64
  3719. entityId:
  3720. type: integer
  3721. format: int64
  3722. actionId:
  3723. type: integer
  3724. format: int64
  3725. unitId:
  3726. type: integer
  3727. format: int64
  3728. status:
  3729. $ref: "#/components/schemas/EventStatus"
  3730. fromTime:
  3731. description: Time when the event starts
  3732. type: string
  3733. format: date-time
  3734. toTime:
  3735. description: Time when the end ends
  3736. type: string
  3737. format: date-time
  3738. example:
  3739. self@NavigationLink: "<domain>/entities/42/units/105/actions/258/events/999"
  3740. Entity@NavigationLink: "<domain>/entities/42"
  3741. EntityUnit@NavigationLink: "<domain>/entities/42/units/105"
  3742. Action@NavigationLink: "<domain>/actions/258"
  3743. Observations@NavigationLink: "<domain>/events/999/observations"
  3744. Locations@NavigationLink: "<domain>/events/999/observations/locations"
  3745. id: 999
  3746. entityId: 42
  3747. actionId: 258
  3748. unitId: 105
  3749. status: "FINISHED"
  3750. fromTime: "2011-12-03T10:15:30+01:00"
  3751. toTime: "2011-12-03T10:15:30+01:00"
  3752. CampaignAlertBasicInfo:
  3753. type: object
  3754. required:
  3755. - id
  3756. - unitId
  3757. - message
  3758. - status
  3759. - timestamp
  3760. x-NavigationLinks:
  3761. Alert@NavigationLink:
  3762. type: string
  3763. format: uri
  3764. x-graph-properties:
  3765. linkTo: alertIdGET
  3766. properties:
  3767. Alert@NavigationLink:
  3768. $ref: '#/components/schemas/AlertBasicInfo/x-NavigationLinks/Alert@NavigationLink'
  3769. id:
  3770. type: integer
  3771. format: int64
  3772. unitId:
  3773. type: integer
  3774. format: int64
  3775. message:
  3776. type: string
  3777. status:
  3778. $ref: '#/components/schemas/AlertStatus'
  3779. timestamp:
  3780. type: string
  3781. format: date-time
  3782. example:
  3783. Alert@NavigationLink: "<domain>/alerts/34"
  3784. id: 34
  3785. unitId: 25
  3786. message: "Example of an alert message"
  3787. status: "CREATED"
  3788. timestamp: "2011-12-03T10:15:30+01:00"
  3789. AlertBasicInfo:
  3790. type: object
  3791. required:
  3792. - id
  3793. - message
  3794. - status
  3795. - timestamp
  3796. x-NavigationLinks:
  3797. Alert@NavigationLink:
  3798. type: string
  3799. format: uri
  3800. x-graph-properties:
  3801. linkTo: alertIdGET
  3802. properties:
  3803. Alert@NavigationLink:
  3804. $ref: '#/components/schemas/AlertBasicInfo/x-NavigationLinks/Alert@NavigationLink'
  3805. id:
  3806. type: integer
  3807. format: int64
  3808. message:
  3809. type: string
  3810. status:
  3811. $ref: '#/components/schemas/AlertStatus'
  3812. timestamp:
  3813. type: string
  3814. format: date-time
  3815. example:
  3816. Alert@NavigationLink: "<domain>/alerts/34"
  3817. id: 34
  3818. message: "Example of an alert message"
  3819. status: "CREATED"
  3820. timestamp: "2011-12-03T10:15:30+01:00"
  3821. EventAlertDetailInfo:
  3822. type: object
  3823. required:
  3824. - id
  3825. - timestamp
  3826. - message
  3827. - status
  3828. x-NavigationLinks:
  3829. self@NavigationLink:
  3830. type: string
  3831. format: uri
  3832. x-graph-properties:
  3833. linkTo: alertIdGET
  3834. Event@NavigationLink:
  3835. type: string
  3836. format: uri
  3837. x-graph-properties:
  3838. linkTo: eventIdGET
  3839. properties:
  3840. self@NavigationLink:
  3841. $ref: '#/components/schemas/EventAlertDetailInfo/x-NavigationLinks/self@NavigationLink'
  3842. Event@NavigationLink:
  3843. $ref: '#/components/schemas/EventAlertDetailInfo/x-NavigationLinks/Event@NavigationLink'
  3844. id:
  3845. type: integer
  3846. format: int32
  3847. timestamp:
  3848. type: string
  3849. format: date-time
  3850. message:
  3851. type: string
  3852. status:
  3853. $ref: '#/components/schemas/AlertStatus'
  3854. example:
  3855. self@NavigationLink: "<domain>/alerts/34"
  3856. Event@NavigationLink: "<domain>/events/345"
  3857. id: 34
  3858. timestamp: "2011-12-03T10:15:30+01:00"
  3859. message: "Example of an alert message"
  3860. status: "CREATED"
  3861. AlertDetailInfo:
  3862. type: object
  3863. required:
  3864. - id
  3865. - unitId
  3866. - timestamp
  3867. - message
  3868. - status
  3869. x-NavigationLinks:
  3870. self@NavigationLink:
  3871. type: string
  3872. format: uri
  3873. x-graph-properties:
  3874. linkTo: alertIdGET
  3875. CampaignUnit@NavigationLink:
  3876. type: string
  3877. format: uri
  3878. x-graph-properties:
  3879. linkTo: campaignIdUnitIdGET
  3880. Events@NavigationLink:
  3881. type: string
  3882. format: uri
  3883. x-graph-properties:
  3884. linkTo: alertIdEventsGET
  3885. properties:
  3886. self@NavigationLink:
  3887. $ref: '#/components/schemas/AlertDetailInfo/x-NavigationLinks/self@NavigationLink'
  3888. CampaignUnit@NavigationLink:
  3889. $ref: '#/components/schemas/AlertDetailInfo/x-NavigationLinks/CampaignUnit@NavigationLink'
  3890. Events@NavigationLink:
  3891. $ref: '#/components/schemas/AlertDetailInfo/x-NavigationLinks/Events@NavigationLink'
  3892. id:
  3893. type: integer
  3894. format: int32
  3895. unitId:
  3896. type: integer
  3897. format: int64
  3898. timestamp:
  3899. type: string
  3900. format: date-time
  3901. message:
  3902. type: string
  3903. status:
  3904. $ref: '#/components/schemas/AlertStatus'
  3905. observation:
  3906. $ref: '#/components/schemas/UnitDataObservation'
  3907. example:
  3908. self@NavigationLink: "<domain>/alerts/34"
  3909. CampaignUnit@NavigationLink: "<domain>/campaign/1/units/25"
  3910. Events@NavigationLink: "<domain>/alerts/34/events"
  3911. id: 34
  3912. unitId: 25
  3913. timestamp: "2011-12-03T10:15:30+01:00"
  3914. message: "Example of an alert message"
  3915. status: "CREATED"
  3916. observation: {}
  3917. AlertInsert:
  3918. type: object
  3919. required:
  3920. - unitId
  3921. - timestamp
  3922. - message
  3923. properties:
  3924. unitId:
  3925. type: integer
  3926. format: int64
  3927. message:
  3928. type: string
  3929. timestamp:
  3930. type: string
  3931. format: date-time
  3932. example:
  3933. unitId: 25
  3934. message: "Alert message"
  3935. timestamp: "2011-12-03T10:15:30+01:00"
  3936. AlertChange:
  3937. type: object
  3938. required:
  3939. - status
  3940. properties:
  3941. status:
  3942. $ref: '#/components/schemas/AlertStatus'
  3943. AlertStatus:
  3944. type: string
  3945. enum:
  3946. - CREATED
  3947. - INFORMED
  3948. - IN_PROCESS
  3949. - SOLVED
  3950. example: "CREATED"
  3951. PostResponse:
  3952. type: object
  3953. required:
  3954. - saved
  3955. - errors
  3956. properties:
  3957. saved:
  3958. type: integer
  3959. minimum: 0
  3960. errors:
  3961. type: integer
  3962. minimum: 0
  3963. ResponseArrayChange:
  3964. type: object
  3965. required:
  3966. - ids
  3967. - message
  3968. properties:
  3969. ids:
  3970. type: array
  3971. items:
  3972. type: integer
  3973. format: int64
  3974. message:
  3975. type: string
  3976. example:
  3977. ids: [34, 35, 36]
  3978. message: "Success"
  3979. ResponseSingleChange:
  3980. type: object
  3981. required:
  3982. - id
  3983. properties:
  3984. id:
  3985. type: integer
  3986. format: int64
  3987. example:
  3988. id: 34
  3989. Info:
  3990. type: object
  3991. required:
  3992. - name
  3993. - version
  3994. - build
  3995. - uptime
  3996. - uptimeMillis
  3997. - authType
  3998. properties:
  3999. name:
  4000. type: string
  4001. version:
  4002. type: string
  4003. build:
  4004. type: string
  4005. uptimeMillis:
  4006. type: integer
  4007. format: int64
  4008. uptime:
  4009. type: string
  4010. authType:
  4011. type: string
  4012. enum: [BEARER, NONE]
  4013. example:
  4014. name: "senslog-telemetry"
  4015. version: "1.1.0"
  4016. build: "123456789"
  4017. uptimeMillis: 1684862333
  4018. uptime: "1:20:00"
  4019. authType: "NONE"
  4020. Error:
  4021. type: object
  4022. required:
  4023. - code
  4024. - message
  4025. properties:
  4026. code:
  4027. type: integer
  4028. format: int32
  4029. message:
  4030. type: string
  4031. example:
  4032. code: 404
  4033. message: "Not Found"