| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006 |
- openapi: "3.0.0"
- info:
- version: 1.0.0
- title: SensLog Telemetry
- servers:
- - url: http://127.0.0.1:8080
- - url: https://theros.wirelessinfo.cz
- paths:
- /info:
- get:
- operationId: infoGET
- summary: Information about running instance
- responses:
- 200:
- description: Instance information
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Info"
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Error"
- /campaigns:
- get:
- operationId: campaignsGET
- summary: Publish info about all campaigns
- security:
- - hubJwtAuth: [telemetry:read]
- parameters:
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON array of basic info of each campaign
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CampaignBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}:
- get:
- operationId: campaignIdGET
- summary: Publish info about a campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON object containing info about a campaign
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units:
- get:
- operationId: campaignIdUnitsGET
- summary: Publish info about the campaign's units
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array containing info about campaign's units
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CampaignUnitBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/observations:
- get:
- operationId: campaignIdUnitsObservationsGET
- summary: Publish info about all data of units merged together within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of telemetry data
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignObservation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureCollectionUnit'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- post:
- operationId: campaignIdUnitsObservationsPOST
- security:
- - hubJwtAuth: [ telemetry:write ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- requestBody:
- required: true
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CampaignDataObservation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureCollectionUnit'
- responses:
- 200:
- description: JSON
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PostResponse'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/observations/locations:
- get:
- operationId: campaignIdUnitsObservationsLocationsGET
- summary: Publish info about all data of units merged together within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/limitPerUnitParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/sortParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of telemetry data
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitsLocations'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoCampaignUnitsLocations'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}:
- get:
- operationId: campaignIdUnitIdGET
- summary: Publish info about the unit within its campaign's scope
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object containing info about the unit within its campaign' scope
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}/observations:
- get:
- operationId: campaignIdUnitIdObservationsGET
- summary: Publish info about all data of the unit within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of telemetry data
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitObservation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureCollectionUnit'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}/observations/locations:
- get:
- operationId: campaignIdUnitIdLocationsGET
- summary: Publish locations of the unit within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of locations
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitLocation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}/sensors:
- get:
- operationId: campaignIdUnitIdSensorsGET
- summary: Publish info about all sensors of the unit within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing information of sensors assigned to the unit within its campaign
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CampaignUnitBasicSensor'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}:
- get:
- operationId: campaignIdUnitIdSensorIdGET
- summary: Publish info about all sensors associated with the unit and the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/sensorIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object containing info about the sensor
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /campaigns/{campaignId}/units/{unitId}/sensors/{sensorId}/observations:
- get:
- operationId: campaignIdUnitIdSensorIdObservationsGET
- summary: Publish info about all data of the unit within the campaign
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/campaignIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/sensorIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of telemetry data
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CampaignUnitSensorObservation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureCollectionUnit'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /units:
- get:
- operationId: unitsGET
- summary: Publish info about all units
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON array of basic info of each unit
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/UnitBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /units/{unitId}:
- get:
- operationId: unitIdGET
- summary: Publish info about the unit
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of info of the unit
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnitDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /units/{unitId}/sensors:
- get:
- operationId: unitIdSensorsGET
- summary: Publish info about sensors assigned to the unit
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info of the sensors
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/UnitSensorBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /units/{unitId}/campaigns:
- get:
- operationId: unitIdCampaignsGET
- summary: Publish info about campaigns where the unit was/is assigned
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info about campaigns
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/UnitCampaignBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /units/{unitId}/drivers:
- get:
- operationId: unitIdDriversGET
- summary: Publish basic info about drivers who performed actions upon the unit
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of drivers
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/UnitDriverBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /sensors:
- get:
- operationId: sensorsGET
- summary: Publish info about all sensors
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info about sensors
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SensorBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /sensors/{sensorId}:
- get:
- operationId: sensorIdGET
- summary: Publish info about the sensor
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/sensorIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of info about the sensor
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SensorDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /sensors/{sensorId}/units:
- get:
- operationId: sensorIdUnitsGET
- summary: Publish info about units to whom the sensor is assigned
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/sensorIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info about the units
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SensorUnitBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /phenomenons:
- get:
- operationId: phenomenonsGET
- summary: Publish info about all phenomenons
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info about phenomenons
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/PhenomenonBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /phenomenons/{phenomenonId}:
- get:
- operationId: phenomenonIdGET
- summary: Publish info about the phenomenon
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/phenomenonIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of info about the phenomenon
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/PhenomenonDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /phenomenons/{phenomenonId}/sensors:
- get:
- operationId: phenomenonIdSensorsGET
- summary: Publish info about sensors of the phenomenon
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/phenomenonIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of info about sensors
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/PhenomenonSensorBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers:
- get:
- operationId: driversGET
- summary: Publish basic info about all drivers
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of basic info about drivers
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DriverBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}:
- get:
- operationId: driverIdGET
- summary: Publish detailed info about the driver
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of detailed info about the driver
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DriverDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/units:
- get:
- operationId: driverIdUnitsGET
- summary: Publish basic info about driver's units
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of basic info about units
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DriverUnitBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/units/{unitId}:
- get:
- operationId: driverIdUnitIdGET
- summary: Publish detailed info about driver's unit
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of detailed info about driver's unit
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DriverUnitDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/units/{unitId}/actions:
- get:
- operationId: driverIdUnitIdActionsGET
- summary: Publish basic info actions performed on the unit by the driver
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of actions
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DriverUnitActionBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/actions:
- get:
- operationId: driverIdActionsGET
- summary: Publish basic info about driver's actions
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of basic info about driver's actions'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DriverActionBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/actions/{actionId}:
- get:
- operationId: driverIdActionIdGET
- summary: Publish detailed info about the driver's action
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/actionIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of detailed info about the driver's action
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DriverActionDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/actions/{actionId}/units:
- get:
- operationId: driverIdActionIdUnitsGET
- summary: Publish basic info about units on which the driver performed its action
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/actionIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of units
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DriverActionUnitBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/actions/{actionId}/units/{unitId}:
- get:
- operationId: driverIdActionIdUnitIdGET
- summary: Publish detail info about the unit on which the driver performed the action
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/actionIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of the unit
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DriverActionUnitDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/units/{unitId}/actions/{actionId}:
- get:
- operationId: driverIdUnitIdActionIdGET
- summary: Publish detailed info about the action performed on the unit by the driver
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/actionIdParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of the action
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DriverUnitActionDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /drivers/{driverId}/units/{unitId}/actions/{actionId}/events:
- get:
- operationId: driverIdUnitIdActionIdEventsGET
- summary: Publish basic info about events that where performed on the unit byt the driver with the specific action
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/driverIdParam'
- - $ref: '#/components/parameters/unitIdParam'
- - $ref: '#/components/parameters/actionIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of events
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/EventBasicInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /events/{eventId}:
- get:
- operationId: eventIdGET
- summary: Publish basic info about events that where performed on the unit byt the driver with the specific action
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/eventIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Array of events
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/EventDetailInfo'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /events/{eventId}/observations:
- get:
- operationId: eventIdObservationsGET
- summary: Publish telemetry observations created by the driver while performing specific action on the unit at the time/event
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/eventIdParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON Object of telemetry observations
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ActionEventObservation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureCollectionUnit'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- /events/{eventId}/observations/locations:
- get:
- operationId: eventIdLocationsGET
- summary: Publish locations created by the driver while performing specific action on the unit at the time/event
- security:
- - hubJwtAuth: [ telemetry:read ]
- parameters:
- - $ref: '#/components/parameters/eventIdParam'
- - $ref: '#/components/parameters/fromParam'
- - $ref: '#/components/parameters/toParam'
- - $ref: '#/components/parameters/zoneParam'
- - $ref: '#/components/parameters/offsetParam'
- - $ref: '#/components/parameters/limitParam'
- - $ref: '#/components/parameters/formatParam'
- - $ref: '#/components/parameters/filterParam'
- - $ref: '#/components/parameters/navigationLinksParam'
- responses:
- 200:
- description: JSON containing stream of locations
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ActionEventLocation'
- application/geo+json:
- schema:
- $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
- default:
- description: unexpected error
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- components:
- securitySchemes:
- hubJwtAuth:
- type: http
- scheme: bearer
- bearerFormat: JWT
- parameters:
- campaignIdParam:
- in: path
- name: campaignId
- schema:
- type: integer
- format: int64
- required: true
- description: Numeric ID of the campaign to get
- unitIdParam:
- in: path
- name: unitId
- schema:
- type: integer
- required: true
- description: Numeric ID of the unit to get
- sensorIdParam:
- in: path
- name: sensorId
- schema:
- type: integer
- required: true
- description: Numeric ID of the sensor to get
- phenomenonIdParam:
- in: path
- name: phenomenonId
- schema:
- type: integer
- format: int64
- required: true
- description: Numeric ID of the phenomenon to get
- driverIdParam:
- in: path
- name: driverId
- schema:
- type: integer
- format: int64
- required: true
- description: Numeric ID of the driver to get
- actionIdParam:
- in: path
- name: actionId
- schema:
- type: integer
- format: int64
- required: true
- description: Numeric ID of the action to get
- eventIdParam:
- in: path
- name: eventId
- schema:
- type: integer
- format: int64
- required: true
- description: Numeric ID of the event to get
- zoneParam:
- in: query
- name: zone
- schema:
- type: string
- default: UTC
- required: false
- examples:
- UTC:
- value: UTC
- GMT:
- value: GMT
- navigationLinksParam:
- in: query
- name: navigationLinks
- schema:
- type: boolean
- default: true
- description: Option to disable @NavigationLinks in a response
- limitParam:
- in: query
- name: limit
- schema:
- type: integer
- format: int64
- required: false
- example: 100
- offsetParam:
- in: query
- name: offset
- schema:
- type: integer
- format: int64
- example: 100
- fromParam:
- in: query
- name: from
- schema:
- type: string
- format: date-time
- required: false
- example: 2017-07-21T17:32:28Z
- toParam:
- in: query
- name: to
- schema:
- type: string
- format: date-time
- required: false
- example: 2017-07-21T17:32:28Z
- limitPerUnitParam:
- in: query
- name: limitPerUnit
- required: true
- schema:
- type: integer
- default: 1
- examples:
- One locations:
- value: 1
- summary: One location of each unit
- sortParam:
- in: query
- name: sort
- schema:
- type: string
- enum: [ asc, desc ]
- default: asc
- examples:
- Descending Order:
- value: desc
- summary: Last location of the units. Last location is combination of sort=desc & limitPerUnit=1
- Ascending Order:
- value: asc
- filterParam:
- in: query
- name: filter
- description: Filter for results following the pattern
- <unit | sensor>(<numeric_float_id | speed | longitude | latitude | altitude>)<lt | le | eq | ne | ge | lt><float_value>, e.g,
- schema:
- type: string
- required: false
- examples:
- Units latitude:
- value: unit(latitude)lt50.1
- summary: Returns all units with its latitude coordination lower than (LT) 50.1
- Units speed:
- value: unit(speed)gt90.0
- summary: Returns all units with its speed greater than 90.0 Km/h
- Sensor ID value:
- value: sensor(105)gt10
- summary: Returns sensors having its value greater than 10
- formatParam:
- in: query
- name: format
- schema:
- type: string
- enum: [json, geojson]
- default: json
- required: false
- schemas:
- CampaignBasicInfo:
- type: object
- required:
- - id
- - fromTime
- - toTime
- x-NavigationLinks:
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- color: blue
- properties:
- Campaign@NavigationLink:
- $ref: '#/components/schemas/CampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
- id:
- type: integer
- format: int64
- description:
- type: string
- fromTime:
- type: string
- format: date-time
- toTime:
- type: string
- format: date-time
- example:
- Campaign@NavigationLink: "<domain>/campaigns/1"
- id: 1
- description: "Campaign 1"
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- CampaignDetailInfo:
- type: object
- required:
- - id
- - fromTime
- - toTime
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- Observations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitsObservationsGET
- Locations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitsObservationsLocationsGET
- Units@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/self@NavigationLink'
- Observations@NavigationLink:
- $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Observations@NavigationLink'
- Locations@NavigationLink:
- $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Locations@NavigationLink'
- Units@NavigationLink:
- $ref: '#/components/schemas/CampaignDetailInfo/x-NavigationLinks/Units@NavigationLink'
- id:
- description: Identifier of the campaign
- type: integer
- format: int64
- description:
- description: Text description of the campaign
- type: string
- fromTime:
- description: Time when the campaign starts
- type: string
- format: date-time
- toTime:
- description: Time when the campaign ends
- type: string
- format: date-time
- example:
- self@NavigationLink: "<domain>/campaigns/1"
- Observations@NavigationLink: "<domain>/campaigns/1/units/observations"
- Locations@NavigationLink: "<domain>/campaigns/1/units/observations/locations"
- Units@NavigationLink: "<domain>/campaigns/1/units"
- id: 1
- description: "Campaign example"
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- CampaignUnitBasicInfo:
- type: object
- required:
- - unitId
- - name
- - fromTime
- - toTime
- x-NavigationLinks:
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- CampaignUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdGET
- properties:
- Unit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
- CampaignUnit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitBasicInfo/x-NavigationLinks/CampaignUnit@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- fromTime:
- description: Time when the validity of the unit starts within the campaign
- type: string
- format: date-time
- toTime:
- description: Time when the validity of the unit ends within the campaign
- type: string
- format: date-time
- example:
- Unit@NavigationLink: "<domain>/units/25"
- CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
- unitId: 25
- name: "Unit name"
- description: "Purpose of the Unit 25"
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- CampaignUnitDetailInfo:
- type: object
- required:
- - unitId
- - imei
- - fromTime
- - toTime
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdGET
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- Sensors@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorsGET
- Observations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdObservationsGET
- Locations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdLocationsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
- Unit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
- Campaign@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Campaign@NavigationLink'
- Sensors@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
- Observations@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Observations@NavigationLink'
- Locations@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailInfo/x-NavigationLinks/Locations@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- imei:
- type: string
- description:
- type: string
- fromTime:
- description: Time when the validity of the unit starts within the campaign
- type: string
- format: date-time
- toTime:
- description: Time when the validity of the unit ends within the campaign
- type: string
- format: date-time
- example:
- self@NavigationLink: "<domain>/campaigns/1/units/25"
- Unit@NavigationLink: "<domain>/units/25"
- Campaign@NavigationLink: "<domain>/campaigns/1"
- Sensors@NavigationLink: "<domain>/campaigns/1/units/25/sensors"
- Observations@NavigationLink: "<domain>/campaigns/1/units/25/observations"
- Locations@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations"
- unitId: 25
- imei: "3434533453"
- description: "Purpose of the Unit 25"
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- CampaignUnitBasicSensor:
- type: object
- required:
- - sensorId
- - name
- - type
- x-NavigationLinks:
- CampaignSensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorIdGET
- properties:
- CampaignSensor@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitBasicSensor/x-NavigationLinks/CampaignSensor@NavigationLink'
- sensorId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- type:
- type: string
- example:
- CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
- sensorId: 105
- name: "Sensor 105"
- type: "X"
- CampaignUnitDetailedSensor:
- type: object
- required:
- - sensorId
- - name
- - phenomenon
- - type
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorIdGET
- Sensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdGET
- CampaignUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdGET
- Phenomenon@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdGET
- Observations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorIdObservationsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/self@NavigationLink'
- Sensor@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Sensor@NavigationLink'
- CampaignUnit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/CampaignUnit@NavigationLink'
- Phenomenon@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Phenomenon@NavigationLink'
- Observations@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitDetailedSensor/x-NavigationLinks/Observations@NavigationLink'
- sensorId:
- type: integer
- format: int64
- name:
- type: string
- phenomenon:
- type: string
- type:
- type: string
- description:
- type: string
- example:
- self@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
- Sensor@NavigationLink: "<domain>/sensors/105"
- CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
- Phenomenon@NavigationLink: "<domain>/phenomenons/15"
- Observations@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations"
- sensorId: 105
- name: "Sensor 105"
- description: "Description of the sensor 105"
- type: "type of sensor"
- phenomenon: "Temperature"
- CampaignObservation:
- type: object
- required:
- - params
- - hasNext
- - size
- - offset
- - data
- x-NavigationLinks:
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitsObservationsGET
- properties:
- Campaign@NavigationLink:
- $ref: '#/components/schemas/CampaignObservation/x-NavigationLinks/Campaign@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/CampaignObservation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- hasNext:
- type: boolean
- size:
- type: integer
- offset:
- type: integer
- data:
- type: array
- items:
- $ref: '#/components/schemas/CampaignDataObservation'
- example:
- Campaign@NavigationLink: "<domain>/campaigns/1"
- next@NavigationLink: "<domain>/campaigns/1/observations?offset=500"
- size: 500
- offset: 0
- data: []
- GeoFeatureCollectionUnit:
- type: object
- required:
- - type
- - features
- properties:
- type:
- type: string
- enum:
- - FeatureCollection
- metadata:
- type: object
- features:
- type: array
- minLength: 1
- items:
- $ref: '#/components/schemas/GeoFeatureUnitObservation'
- GeoFeatureUnitObservation:
- type: object
- required:
- - type
- - geometry
- - properties
- properties:
- type:
- type: string
- enum:
- - Feature
- geometry:
- $ref: '#/components/schemas/GeoPoint'
- properties:
- type: object
- required:
- - unitId
- - timestamp
- - speed
- properties:
- unitId:
- type: integer
- format: int64
- timestamp:
- type: string
- format: date-time
- speed:
- type: integer
- format: int64
- observedValues:
- type: object
- GeoPoint:
- type: object
- required:
- - type
- - coordinates
- properties:
- type:
- type: string
- enum:
- - Point
- coordinates:
- type: array
- items:
- type: number
- format: float
- minLength: 3
- maxLength: 3
- description: "[lon, lat, alt]"
- CampaignUnitObservation:
- type: object
- required:
- - params
- - hasNext
- - size
- - offset
- - data
- x-NavigationLinks:
- CampaignUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdObservationsGET
- properties:
- CampaignUnit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitObservation/x-NavigationLinks/CampaignUnit@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitObservation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- hasNext:
- type: boolean
- size:
- type: integer
- offset:
- type: integer
- data:
- type: array
- items:
- $ref: '#/components/schemas/UnitDataObservation'
- example:
- CampaignUnit@NavigationLink: "<domain>/campaigns/1/units/25"
- next@NavigationLink: "<domain>/campaigns/1/units/25/observations?offset=500"
- params: []
- size: 500
- hasNext: true
- offset: 0
- data: []
- CampaignUnitSensorObservation:
- type: object
- required:
- - params
- - size
- - offset
- - hasNext
- - data
- x-NavigationLinks:
- CampaignSensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdSensorIdObservationsGET
- properties:
- CampaignSensor@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitSensorObservation/x-NavigationLinks/CampaignSensor@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitSensorObservation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- size:
- type: integer
- offset:
- type: integer
- hasNext:
- type: boolean
- data:
- type: array
- items:
- $ref: '#/components/schemas/SensorDataObservation'
- example:
- CampaignSensor@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105"
- next@NavigationLink: "<domain>/campaigns/1/units/25/sensors/105/observations?offset=500"
- size: 500
- offset: 0
- data: []
- ActionEventObservation:
- type: object
- required:
- - params
- - hasNext
- - size
- - offset
- - data
- x-NavigationLinks:
- Event@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdObservationsGET
- properties:
- Event@NavigationLink:
- $ref: '#/components/schemas/ActionEventObservation/x-NavigationLinks/Event@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/ActionEventObservation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- hasNext:
- type: boolean
- size:
- type: integer
- offset:
- type: integer
- data:
- type: array
- items:
- $ref: '#/components/schemas/UnitDataObservation'
- example:
- Event@NavigationLink: "<domain>/events/999"
- next@NavigationLink: "<domain>/events/999/observations?offset=500"
- params: []
- size: 500
- hasNext: true
- offset: 0
- data: []
- CampaignDataObservation:
- type: object
- required:
- - unitId
- - timestamp
- - speed
- - location
- - observedValues
- properties:
- unitId:
- type: integer
- format: int64
- timestamp:
- type: string
- format: date-time
- speed:
- type: integer
- format: int64
- location:
- $ref: '#/components/schemas/Location'
- observedValues:
- type: object
- example:
- unitId: 25
- timestamp: "2023-01-25 15:35:32Z"
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- observedValues:
- 105: 1434
- UnitDataObservation:
- type: object
- required:
- - timestamp
- - speed
- - location
- - observedValues
- properties:
- timestamp:
- type: string
- format: date-time
- speed:
- type: integer
- format: int64
- location:
- $ref: '#/components/schemas/Location'
- observedValues:
- type: object
- example:
- timestamp: "2023-01-25 15:35:32Z"
- speed: 34
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- observedValues:
- 105: 1434
- SensorDataObservation:
- type: object
- required:
- - timestamp
- - value
- - speed
- - location
- properties:
- timestamp:
- type: string
- format: date-time
- observedValue:
- type: integer
- format: int64
- speed:
- type: integer
- format: int64
- location:
- $ref: '#/components/schemas/Location'
- example:
- timestamp: "2023-01-25 15:35:32Z"
- observedValue: 1434
- speed: 34
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- CampaignUnitLocation:
- type: object
- required:
- - params
- - hasNext
- - size
- - offset
- - data
- x-NavigationLinks:
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdUnitIdLocationsGET
- properties:
- Campaign@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/Campaign@NavigationLink'
- Unit@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/Unit@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitLocation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- hasNext:
- type: boolean
- size:
- type: integer
- offset:
- type: integer
- data:
- type: array
- items:
- type: object
- properties:
- timestamp:
- type: string
- format: date-time
- location:
- $ref: '#/components/schemas/Location'
- example:
- Campaign@NavigationLink: "<domain>/campaigns/1"
- Unit@NavigationLink: "<domain>/campaigns/1/units/25"
- next@NavigationLink: "<domain>/campaigns/1/units/25/observations/locations?offset=500"
- params:
- offset: 0
- limit: 500
- navigationLinks: true
- size: 500
- hasNext: true
- offset: 0
- data:
- - timestamp: "2023-01-25 15:35:32Z"
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- CampaignUnitsLocations:
- type: object
- required:
- - size
- - data
- x-NavigationLinks:
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- properties:
- Campaign@NavigationLink:
- $ref: '#/components/schemas/CampaignUnitsLocations/x-NavigationLinks/Campaign@NavigationLink'
- params:
- type: object
- description: Used params in URL
- size:
- type: integer
- data:
- type: array
- items:
- type: object
- required:
- - unitId
- - timestamp
- - location
- properties:
- unitId:
- type: integer
- format: int64
- timestamp:
- type: string
- format: date-time
- location:
- $ref: '#/components/schemas/Location'
- example:
- Campaign@NavigationLink: "<domain>/campaigns/1"
- params:
- from: "2023-01-25 15:35:32Z"
- to: "2023-01-25 15:35:32Z"
- navigationLinks: true
- size: 8
- data:
- - unitId: 25
- timestamp: "2023-01-25 15:35:32Z"
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- GeoCampaignUnitsLocations:
- type: object
- required:
- - type
- - features
- properties:
- type:
- type: string
- enum:
- - FeatureCollection
- metadata:
- type: object
- features:
- type: array
- minLength: 1
- items:
- $ref: '#/components/schemas/GeoFeatureUnitMultiLocation'
- GeoFeatureUnitMultiLocation:
- type: object
- required:
- - type
- - properties
- - geometry
- properties:
- type:
- type: string
- enum:
- - Feature
- properties:
- type: object
- required:
- - unitId
- properties:
- unitId:
- type: integer
- format: int64
- geometry:
- $ref: '#/components/schemas/GeoMultiPoint'
- GeoMultiPoint:
- type: object
- required:
- - type
- - coordinates
- properties:
- type:
- type: string
- enum:
- - MultiPoint
- coordinates:
- type: array
- minLength: 1
- items:
- type: array
- items:
- type: integer
- format: float
- minLength: 3
- maxLength: 3
- description: "[lon, lat, alt]"
- ActionEventLocation:
- type: object
- required:
- - params
- - hasNext
- - size
- - offset
- - data
- x-NavigationLinks:
- Event@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdGET
- next@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdLocationsGET
- properties:
- Event@NavigationLink:
- $ref: '#/components/schemas/ActionEventLocation/x-NavigationLinks/Event@NavigationLink'
- next@NavigationLink:
- $ref: '#/components/schemas/ActionEventLocation/x-NavigationLinks/next@NavigationLink'
- params:
- type: object
- description: Used params in URL
- hasNext:
- type: boolean
- size:
- type: integer
- offset:
- type: integer
- data:
- type: array
- items:
- type: object
- properties:
- timestamp:
- type: string
- format: date-time
- location:
- $ref: '#/components/schemas/Location'
- example:
- Event@NavigationLink: "<domain>/events/999"
- next@NavigationLink: "<domain>/events/999/observations/locations?offset=500"
- params:
- offset: 0
- limit: 500
- navigationLinks: true
- size: 500
- hasNext: true
- offset: 0
- data:
- - timestamp: "2023-01-25 15:35:32Z"
- location:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- Location:
- type: object
- properties:
- longitude:
- type: number
- format: float
- latitude:
- type: number
- format: float
- altitude:
- type: number
- format: float
- example:
- longitude: 49.7384
- latitude: 13.3736
- altitude: 350.3
- UnitBasicInfo:
- type: object
- required:
- - unitId
- - name
- x-NavigationLinks:
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- properties:
- Unit@NavigationLink:
- $ref: '#/components/schemas/UnitBasicInfo/x-NavigationLinks/Unit@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- Unit@NavigationLink: "<domain>/units/25"
- unitId: 25
- name: "Mobile Unit"
- description: "Mobile Unit 25"
- UnitDetailInfo:
- type: object
- required:
- - unitId
- - name
- - imei
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- Sensors@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdSensorsGET
- Campaigns@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdCampaignsGET
- Drivers@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdDriversGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/self@NavigationLink'
- Sensors@NavigationLink:
- $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
- Campaigns@NavigationLink:
- $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Campaigns@NavigationLink'
- Drivers@NavigationLink:
- $ref: '#/components/schemas/UnitDetailInfo/x-NavigationLinks/Drivers@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- imei:
- type: string
- description:
- type: string
- example:
- self@NavigationLink: "<domain>/units/25"
- Sensors@NavigationLink: "<domain>/units/25/sensors"
- Campaigns@NavigationLink: "<domain>/units/25/campaigns"
- Drivers@NavigationLink: "<domain>/units/25/drivers"
- unitId: 25
- name: "Mobile Unit"
- description: "Mobile Unit 25"
- imei: "3434535323345"
- UnitSensorBasicInfo:
- type: object
- required:
- - sensorId
- - name
- x-NavigationLinks:
- Sensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdGET
- properties:
- Sensor@NavigationLink:
- $ref: '#/components/schemas/UnitSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
- sensorId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- type:
- type: string
- example:
- Sensor@NavigationLink: "<domain>/sensors/105"
- sensorId: 105
- name: "Sensor 105"
- type: "temperature"
- UnitCampaignBasicInfo:
- type: object
- required:
- - id
- - fromTime
- - toTime
- x-NavigationLinks:
- Campaign@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: campaignIdGET
- properties:
- Campaign@NavigationLink:
- $ref: '#/components/schemas/UnitCampaignBasicInfo/x-NavigationLinks/Campaign@NavigationLink'
- id:
- type: integer
- format: int64
- description: Identifier of the campaign
- description:
- type: string
- description: Description of the campaign
- fromTime:
- type: string
- format: date-time
- description: Time from the unit was active in the campaign
- toTime:
- type: string
- format: date-time
- description: Time until the unit was active in the campaign
- example:
- Campaign@NavigationLink: "<domain>/campaigns/1"
- id: 1
- description: "Campaign 1"
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- UnitDriverBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- Driver@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- properties:
- Driver@NavigationLink:
- $ref: '#/components/schemas/UnitDriverBasicInfo/x-NavigationLinks/Driver@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- Driver@NavigationLink: "<domain>/drivers/42"
- id: 42
- name: "Steve Smith"
- DriverActionUnitBasicInfo:
- type: object
- required:
- - unitId
- - name
- x-NavigationLinks:
- DriverActionUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdUnitIdGET
- properties:
- DriverActionUnit@NavigationLink:
- $ref: '#/components/schemas/DriverActionUnitBasicInfo/x-NavigationLinks/DriverActionUnit@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- DriverActionUnit@NavigationLink: "<domain>/drivers/42/actions/258/units/25"
- unitId: 25
- name: "Unit name"
- description: "Purpose of the Unit 25"
- DriverActionUnitDetailInfo:
- type: object
- required:
- - unitId
- - name
- - imei
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdUnitIdGET
- DriverAction@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdGET
- Events@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdEventsGET
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
- DriverAction@NavigationLink:
- $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/DriverAction@NavigationLink'
- Unit@NavigationLink:
- $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
- Events@NavigationLink:
- $ref: '#/components/schemas/DriverActionUnitDetailInfo/x-NavigationLinks/Events@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- imei:
- type: string
- description:
- type: string
- example:
- self@NavigationLink: "<domain>/drivers/42/actions/258/units/25"
- DriverAction@NavigationLink: "<domain>/drivers/42/actions/258"
- Events@NavigationLink: "<domain>/drivers/42/units/25/actions/258/events"
- Unit@NavigationLink: "<domain>/units/25"
- unitId: 25
- name: "Mobile Unit"
- description: "Mobile Unit 25"
- imei: "3434535323345"
- SensorBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- Sensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdGET
- properties:
- Sensor@NavigationLink:
- $ref: '#/components/schemas/SensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- Sensor@NavigationLink: "<domain>/sensors/105"
- id: 105
- name: "Sensor 105"
- description: "Description of the sensor 105"
- SensorDetailInfo:
- type: object
- required:
- - sensorId
- - ioId
- - name
- - phenomenon
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdGET
- Units@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdUnitsGET
- Phenomenon@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/self@NavigationLink'
- Units@NavigationLink:
- $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Units@NavigationLink'
- Phenomenon@NavigationLink:
- $ref: '#/components/schemas/SensorDetailInfo/x-NavigationLinks/Phenomenon@NavigationLink'
- sensorId:
- type: integer
- format: int64
- ioId:
- type: integer
- format: int16
- name:
- type: string
- phenomenon:
- type: string
- type:
- type: string
- description:
- type: string
- example:
- self@NavigationLink: "<domain>/sensors/105"
- Phenomenon@NavigationLink: "<domain>/phenomenons/15"
- Units@NavigationLink: "<domain>/sensors/105/units"
- sensorId: 105
- name: "Sensor 105"
- description: "Description of the sensor 105"
- type: "type of sensor"
- phenomenon: "Temperature"
- SensorUnitBasicInfo:
- type: object
- required:
- - unitId
- - name
- properties:
- Unit@NavigationLink:
- type: string
- format: uri
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- Unit@NavigationLink: "<domain>/units/25"
- unitId: 25
- name: "Mobile Unit"
- description: "Mobile Unit 25"
- PhenomenonBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- Phenomenon@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdGET
- properties:
- Phenomenon@NavigationLink:
- $ref: '#/components/schemas/PhenomenonBasicInfo/x-NavigationLinks/Phenomenon@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- Phenomenon@NavigationLink: "<domain>/phenomenons/15"
- id: 15
- name: "Temperature"
- PhenomenonDetailInfo:
- type: object
- required:
- - id
- - name
- - uom
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdGET
- Sensors@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdSensorsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/self@NavigationLink'
- Sensors@NavigationLink:
- $ref: '#/components/schemas/PhenomenonDetailInfo/x-NavigationLinks/Sensors@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- uom:
- type: string
- maxLength: 30
- uomLink:
- type: string
- format: uri
- example:
- self@NavigationLink: "<domain>/phenomenons/15"
- Sensors@NavigationLink: "<domain>/phenomenons/15/sensors"
- id: 15
- name: "Temperature"
- uom: "uom"
- uomLink: "uom link"
- PhenomenonSensorBasicInfo:
- type: object
- required:
- - Phenomenon@NavigationLink
- - Sensor@NavigationLink
- - sensorId
- - name
- x-NavigationLinks:
- Phenomenon@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: phenomenonIdGET
- Sensor@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: sensorIdGET
- properties:
- Phenomenon@NavigationLink:
- $ref: '#/components/schemas/PhenomenonSensorBasicInfo/x-NavigationLinks/Phenomenon@NavigationLink'
- Sensor@NavigationLink:
- $ref: '#/components/schemas/PhenomenonSensorBasicInfo/x-NavigationLinks/Sensor@NavigationLink'
- sensorId:
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- Phenomenon@NavigationLink: "<domain>/phenomenons/15"
- Sensor@NavigationLink: "<domain>/sensors/105"
- sensorId: 105
- name: "Sensor 105"
- description: "Description of Sensor 105"
- DriverBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- Driver@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- properties:
- Driver@NavigationLink:
- $ref: '#/components/schemas/DriverBasicInfo/x-NavigationLinks/Driver@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- Driver@NavigationLink: "<domain>/drivers/42"
- id: 42
- name: "Steve Smith"
- DriverDetailInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- Units@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitsGET
- Actions@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/self@NavigationLink'
- Units@NavigationLink:
- $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/Units@NavigationLink'
- Actions@NavigationLink:
- $ref: '#/components/schemas/DriverDetailInfo/x-NavigationLinks/Actions@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- self@NavigationLink: "<domain>/drivers/42"
- Units@NavigationLink: "<domain>/drivers/42/units"
- Actions@NavigationLink: "<domain>/drivers/42/actions"
- id: 42
- name: "Steve Smith"
- DriverUnitBasicInfo:
- type: object
- required:
- - unitId
- - name
- x-NavigationLinks:
- DriverUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitsGET
- properties:
- DriverUnit@NavigationLink:
- $ref: '#/components/schemas/DriverUnitBasicInfo/x-NavigationLinks/DriverUnit@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- description:
- type: string
- example:
- DriverUnit@NavigationLink: "<domain>/drivers/42/units/25"
- unitId: 25
- name: "Unit name"
- description: "Purpose of the Unit 25"
- DriverUnitDetailInfo:
- type: object
- required:
- - unitId
- - imei
- - name
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdGET
- Unit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: unitIdGET
- Actions@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/self@NavigationLink'
- Unit@NavigationLink:
- $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
- Actions@NavigationLink:
- $ref: '#/components/schemas/DriverUnitDetailInfo/x-NavigationLinks/Unit@NavigationLink'
- unitId:
- description: Identifier of the unit
- type: integer
- format: int64
- name:
- type: string
- imei:
- type: string
- description:
- type: string
- example:
- self@NavigationLink: "<domain>/drivers/42/units/25"
- Unit@NavigationLink: "<domain>/units/25"
- Actions@NavigationLink: "<domain>/drivers/42/units/25/actions"
- unitId: 25
- name: "Mobile Unit"
- description: "Mobile Unit 25"
- imei: "3434535323345"
- DriverActionBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- DriverAction@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdGET
- properties:
- DriverAction@NavigationLink:
- $ref: '#/components/schemas/DriverActionBasicInfo/x-NavigationLinks/DriverAction@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- DriverAction@NavigationLink: "<domain>/drivers/42/actions/258"
- id: 258
- name: "Delivering"
- DriverUnitActionBasicInfo:
- type: object
- required:
- - id
- - name
- x-NavigationLinks:
- DriverUntAction@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdGET
- properties:
- DriverUntAction@NavigationLink:
- $ref: '#/components/schemas/DriverUnitActionBasicInfo/x-NavigationLinks/DriverUntAction@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- DriverUntAction@NavigationLink: "<domain>/drivers/42/units/{25}/actions/258"
- id: 258
- name: "Delivering"
- DriverActionDetailInfo:
- type: object
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdGET
- Driver@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- Units@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdUnitsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/self@NavigationLink'
- Driver@NavigationLink:
- $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/Driver@NavigationLink'
- Units@NavigationLink:
- $ref: '#/components/schemas/DriverActionDetailInfo/x-NavigationLinks/Units@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- self@NavigationLink: "<domain>/drivers/42/actions/258"
- Driver@NavigationLink: "<domain>/drivers/42"
- Units@NavigationLink: "<domain>/drivers/42/actions/258/units"
- id: 258
- name: "Delivering"
- DriverUnitActionDetailInfo:
- type: object
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdGET
- Driver@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- DriverUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdGET
- Events@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdEventsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/self@NavigationLink'
- Driver@NavigationLink:
- $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/Driver@NavigationLink'
- DriverUnit@NavigationLink:
- $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/DriverUnit@NavigationLink'
- Events@NavigationLink:
- $ref: '#/components/schemas/DriverUnitActionDetailInfo/x-NavigationLinks/Events@NavigationLink'
- id:
- type: integer
- format: int64
- name:
- type: string
- example:
- self@NavigationLink: "<domain>/drivers/42/units/25/actions/258"
- Driver@NavigationLink: "<domain>/drivers/42"
- DriverUnit@NavigationLink: "<domain>/drivers/42/units/25"
- Events@NavigationLink: "<domain>/drivers/42/units/25/actions/258/events"
- id: 258
- name: "Delivering"
- EventBasicInfo:
- type: object
- required:
- - id
- - fromTime
- - toTime
- x-NavigationLinks:
- Event@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdEventIdGET
- properties:
- Event@NavigationLink:
- $ref: '#/components/schemas/EventBasicInfo/x-NavigationLinks/Event@NavigationLink'
- id:
- type: integer
- format: int64
- fromTime:
- description: Time when the event starts
- type: string
- format: date-time
- toTime:
- description: Time when the end ends
- type: string
- format: date-time
- example:
- Event@NavigationLink: "<domain>/drivers/42/units/105/actions/258/events/999"
- id: 999
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- EventDetailInfo:
- type: object
- required:
- - id
- - driverId
- - actionId
- - unitId
- - fromTime
- - toTime
- x-NavigationLinks:
- self@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdActionIdEventIdGET
- Driver@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdGET
- DriverUnit@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdUnitIdGET
- Action@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: driverIdActionIdGET
- Observations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdObservationsGET
- Locations@NavigationLink:
- type: string
- format: uri
- x-graph-properties:
- linkTo: eventIdLocationsGET
- properties:
- self@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/self@NavigationLink'
- Driver@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Driver@NavigationLink'
- DriverUnit@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/DriverUnit@NavigationLink'
- Action@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Action@NavigationLink'
- Observations@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Observations@NavigationLink'
- Locations@NavigationLink:
- $ref: '#/components/schemas/EventDetailInfo/x-NavigationLinks/Locations@NavigationLink'
- id:
- type: integer
- format: int64
- driverId:
- type: integer
- format: int64
- actionId:
- type: integer
- format: int64
- unitId:
- type: integer
- format: int64
- fromTime:
- description: Time when the event starts
- type: string
- format: date-time
- toTime:
- description: Time when the end ends
- type: string
- format: date-time
- example:
- self@NavigationLink: "<domain>/drivers/42/units/105/actions/258/events/999"
- Driver@NavigationLink: "<domain>/drivers/42"
- DriverUnit@NavigationLink: "<domain>/drivers/42/units/105"
- Action@NavigationLink: "<domain>/actions/258"
- Observations@NavigationLink: "<domain>/events/999/observations"
- Locations@NavigationLink: "<domain>/events/999/observations/locations"
- id: 999
- driverId: 42
- actionId: 258
- unitId: 105
- fromTime: "2023-01-25 15:35:32Z"
- toTime: "2023-03-20 10:35:32Z"
- PostResponse:
- type: object
- required:
- - saved
- - errors
- properties:
- saved:
- type: integer
- minimum: 0
- errors:
- type: integer
- minimum: 0
- Info:
- required:
- - name
- - version
- - build
- - uptime
- - uptimeMillis
- properties:
- name:
- type: string
- version:
- type: string
- build:
- type: string
- uptimeMillis:
- type: integer
- format: int64
- uptime:
- type: string
- example:
- name: "senslog-telemetry"
- version: "1.1.0"
- build: "123456789"
- uptimeMillis: 1684862333
- uptime: "1:20:00"
- Error:
- required:
- - code
- - message
- properties:
- code:
- type: integer
- format: int32
- message:
- type: string
- example:
- code: 404
- message: "Not Found"
|