{"openapi":"3.0.1","info":{"title":"5g Campus Positioning API.","description":"This is the 5g Campus Positioning API reference documentation.","termsOfService":"https://www.t-systems.com/us/en/terms-and-conditions","contact":{"name":"Positioning","url":"https://t-systems.com/","email":"tbd@t-systems.com"},"license":{"name":"© 2020 T-Systems International GmbH. All rights reserved.","url":"https://www.t-systems.com/de/en"},"version":"0.0.1-SNAPSHOT"},"servers":[{"url":"http://positioning-api.t-systems.com:8090/v1","description":"Production API URL"},{"url":"http://dev-5gcampus.eastus.cloudapp.azure.com:30006/v1","description":"Development API URL"},{"url":"http://localhost:8090/v1","description":"Local development API URL"}],"tags":[{"name":"Fence","description":"An area enclosed in geographically defined borders (polygon or circle). It is to detect events when trackables enter or leave this area."},{"name":"Asset","description":"A physical object (e.g. a pallet) that should be tracked accordingly. Note: One or more 'tags' can be assigned/attached to an asset."},{"name":"AreaOfInterest","description":"A specific and defined area within a zone. An AOI can overlap each other but do not have to. A zone can therefore have \"n\" Area of Interests. "},{"name":"UserSettings","description":"Contains a mapping between a User and a Positioning object which is to be either added/removed as a favorite for the respective user."},{"name":"Positioning websocket API","description":"Positioning Web Socket API endpoints"}],"paths":{"/user-settings":{"get":{"tags":["UserSettings"],"summary":"Get user settings for authorized user","description":"Get user settings for authorized user","operationId":"getUserSettings","parameters":[{"name":"UserName","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSettings"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["UserSettings"],"summary":"Set user settings for authorized user","description":"Set user settings for authorized user","operationId":"setUserSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSettings"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/areas-of-interest":{"get":{"tags":["AreaOfInterest"],"summary":"Get a list of all AreaOfInterest","description":"Get a list of all AreaOfInterest","operationId":"getAllAreaOfInterest","parameters":[{"name":"page_size","in":"query","description":"Indicates how many entries of the collection should be returned. The upper limit for one page is currently 2000, any larger requested page size is trimmed to the upper limit.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":2000}},{"name":"offset","in":"query","description":"Shift the result collection by provided value","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"with_total","in":"query","description":"To include totalAreasOfInterest in the result, add the query parameter 'with_total=true'","required":false,"schema":{"type":"boolean","default":false}},{"name":"order_by","in":"query","description":"Sort criteria for displaying the results","required":false,"schema":{"type":"string","default":"id","enum":["id","displayName"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterestPage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["AreaOfInterest"],"summary":"Create an AreaOfInterest","description":"Create an AreaOfInterest","operationId":"createAreaOfInterest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"The Path to the newly created AreaOfInterest","required":true,"style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Already Exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/areas-of-interest/{id}":{"get":{"tags":["AreaOfInterest"],"summary":"Get an AreaOfInterest","description":"Get an AreaOfInterest","operationId":"getAreaOfInterest","parameters":[{"name":"id","in":"path","description":"the areaOfInterest Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["AreaOfInterest"],"summary":"Update an existing AreaOfInterest","description":"Update an existing AreaOfInterest","operationId":"updateAreaOfInterest","parameters":[{"name":"id","in":"path","description":"the areaOfInterest Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Already Exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["AreaOfInterest"],"summary":"Delete an AreaOfInterest","description":"Delete an AreaOfInterest","operationId":"removeAreaOfInterest","parameters":[{"name":"id","in":"path","description":"the areaOfInterest Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AreaOfInterest"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/web/socket":{"put":{"tags":["Positioning websocket API"],"summary":"subscribe for positioning events over websocket","description":"subscribe for positioning events over websocket","operationId":"subscribeForNotifications","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositioningWSSubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositioningWSSubscriptionResponse"}}}}}}},"/fences/{id}":{"get":{"tags":["Fence"],"summary":"Get a particular fence details","description":"Get fence by id","operationId":"getFence","parameters":[{"name":"id","in":"path","description":"the fence Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fence"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/fences":{"get":{"tags":["Fence"],"summary":"Get the fence objects","description":"Get all fence objects","operationId":"getAllFence","parameters":[{"name":"page_size","in":"query","description":"Indicates how many entries of the collection should be returned. The upper limit for one page is currently 2000, any larger requested page size is trimmed to the upper limit.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":20}},{"name":"offset","in":"query","description":"Shift the result collection by provided value","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"with_total","in":"query","description":"To include totalFence in the result, add the query parameter 'with_total=true'","required":false,"schema":{"type":"boolean","default":false}},{"name":"order_by","in":"query","description":"Sort criteria for displaying the results","required":false,"schema":{"type":"string","default":"name","enum":["name"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FencePage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/assets":{"get":{"tags":["Asset"],"summary":"Get a list of all Assets","description":"Get a list of all Assets","operationId":"getAllAssets","parameters":[{"name":"trackable_id","in":"query","description":"Get assets for trackables","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page_size","in":"query","description":"Indicates how many entries of the collection should be returned. The upper limit for one page is currently 2000, any larger requested page size is trimmed to the upper limit.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":2000}},{"name":"offset","in":"query","description":"Shift the result collection by provided value","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"with_total","in":"query","description":"To include totalAssets in the result, add the query parameter 'with_total=true'","required":false,"schema":{"type":"boolean","default":false}},{"name":"order_by","in":"query","description":"Sort criteria for displaying the results","required":false,"schema":{"type":"string","default":"id","enum":["id","displayName"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetPage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Asset"],"summary":"Create an Asset","description":"Create an Asset","operationId":"createAsset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetDto"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"The Path to the newly created Asset","required":true,"style":"simple","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackableAssetDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Already Exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/assets/{id}":{"get":{"tags":["Asset"],"summary":"Get an Asset by id","description":"Get an Asset by id","operationId":"getAsset","parameters":[{"name":"id","in":"path","description":"the asset Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackableAssetDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["Asset"],"summary":"Update an existing Asset","description":"Update an existing Asset","operationId":"updateAsset","parameters":[{"name":"id","in":"path","description":"the asset Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackableAssetDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Already Exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Asset"],"summary":"Delete an Asset","description":"Delete an Asset","operationId":"removeAsset","parameters":[{"name":"id","in":"path","description":"the asset Id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Request fulfilled. No Content"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/trackables":{"get":{"tags":["Trackables"],"summary":"Get last state of trackables by optional filter","description":"Last known reach state of trackables including position, area, etc. The result set can be limited by providing an optional filter by the id","operationId":"getLastStateOfTrackables","parameters":[{"name":"fence_id","in":"query","description":"Get trackables in fence","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"page_size","in":"query","description":"Indicates how many entries of the collection should be returned. The upper limit for one page is currently 2000, any larger requested page size is trimmed to the upper limit.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":20}},{"name":"offset","in":"query","description":"Shift the result collection by provided value","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"with_total","in":"query","description":"To include total Trackables in the result, add the query parameter 'with_total=true'","required":false,"schema":{"type":"boolean","default":false}},{"name":"order_by","in":"query","description":"Sort criteria for displaying the results","required":false,"schema":{"type":"string","default":"id","enum":["id","displayName"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackableStatePage"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/trackables/{id}":{"get":{"tags":["Trackables"],"summary":"Get last state of trackable","description":"Last known state of trackable including position, fence, etc","operationId":"getLastStateOfTrackable","parameters":[{"name":"id","in":"path","description":"trackable Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackableState"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"required":["code","message","type"],"type":"object","properties":{"type":{"type":"string","description":"A textual representation of error type. Can be any default HttpStatus reason phrases or positioning's business specific phrases like 'Already Exists'","example":"Not Found","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"code":{"type":"integer","description":"Default or business specific HTTPStatus codes","format":"int32","example":404},"message":{"type":"string","description":"Business defined error message","example":"AreaOfInterest with id: '1' could not be found in the system"},"errors":{"type":"array","items":{"type":"string","description":"A list of technical error messages. Provides more details on the failure's root cause","example":"[\"No handler found for DELETE /area-of-interest/2\"]"}}}},"UserSettings":{"required":["favoriteAOIs","favoriteAssets","username"],"type":"object","properties":{"id":{"type":"string","description":"Must be a unique identifier. A unique id will be generated when creating a settings for a user","readOnly":true,"example":"5f6d8decbb34bc13ccc7b1de"},"username":{"type":"string","description":"The username of the user.","example":"5g.positioning"},"favoriteAssets":{"uniqueItems":true,"type":"array","description":"A unique identifiers(id) of the asset being marked as a favorite for the user.","example":["5fabe4359d5fc9423c811605"],"items":{"type":"string"}},"favoriteAOIs":{"uniqueItems":true,"type":"array","description":"A unique identifiers(id) of the areas of interest being marked as a favorite for the user.","example":["4fabe4359d5fc9423c811605"],"items":{"type":"string"}}}},"AreaOfInterest":{"required":["class","description","displayName","fences","id","properties","type"],"type":"object","properties":{"id":{"type":"string","description":"Must be a unique identifier. A unique id will be generated when creating a new area of interest","example":"5f6d8decbb34bc13ccc7b1de"},"modifiedBy":{"type":"string","description":"The author of the last modification","example":"j.smith"},"modifiedAt":{"type":"string","description":"The last modification time","format":"date-time"},"displayName":{"type":"string","description":"The name of the area of interest","example":"T-Systems International - AOI"},"description":{"maxLength":100,"minLength":0,"type":"string","description":"An optional description provided as additional information about the area of interest","example":"This area of interest deals with tracking device movements in the TSI production campus"},"fences":{"type":"array","items":{"type":"string","description":"An arraying containing fence ids belonging to a particular area of interest","example":"[\"3f4b5468-d900-4642-bc62-2ada8b81da04\",\"4676b455-c9e7-441a-9dba-78168b16a035\",\"56ed3918-0041-430f-9ff8-c753fd68313d\"]"}},"type":{"type":"string","description":"A type attribute defining an AreaOfInterest","example":"loading"},"threatTo":{"type":"array","readOnly":true,"items":{"type":"string","description":"An optional read-only attribute 'threat-to' which is an aggregation of 'threat-to' attributes of underlying FencesAttribute, that describes a list of threats a particular area of interest may pose to other assets","readOnly":true,"example":"[\"human\",\"forklift\"]"}},"properties":{"type":"object","description":"Additional properties in the form of key-value pairs to be sent to the server. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed."},"class":{"type":"string","description":"A class attribute defining an AreaOfInterest","example":"production"}}},"AreaOfInterestPage":{"required":["areasOfInterest","pageInfo"],"type":"object","properties":{"areasOfInterest":{"type":"array","items":{"$ref":"#/components/schemas/AreaOfInterest"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}},"PageInfo":{"required":["offset","pageSize"],"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"totalInCollection":{"type":"integer","format":"int32"}}},"PositioningWSSubscriptionRequest":{"required":["event","properties","topic"],"type":"object","properties":{"event":{"type":"string","description":"Event type of the websocket subscription request. Client subscribing to a topic should send 'subscribe' as a value.","enum":["subscribe"]},"topic":{"type":"string","description":"Topic to subscribe.","enum":["notification_updates","position_updates"]},"properties":{"type":"object","description":"Additional properties in the form of key-value pairs to be sent to the server. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed."}}},"PositioningWSSubscriptionResponse":{"type":"object","properties":{"event":{"type":"string","description":"Event type for the websocket subscription response. Must be 'subscribed' to notify a subscriber about a successful subscription.","enum":["subscribed"]},"topic":{"type":"string","description":"Topic for which subscription is created.","enum":["notification_updates","position_updates"]},"subscriptionId":{"type":"string","description":"Subscription id","example":"1"}}},"Fence":{"required":["fence","id"],"type":"object","properties":{"fence":{"$ref":"#/components/schemas/FencePolygon"},"id":{"type":"string","description":"Must be a unique identifier (e.g. a UUID). A unique id will be generated when creating a new fence","format":"uuid","example":"f2a6fc5a-ddbd-4523-b06c-0fa675a3787c"},"name":{"type":"string","description":"A textual representation of the fence","example":"string"},"floor":{"type":"number","description":"The canonical representation of the floor level, where floor 0 is the ground floor","example":4},"threatTo":{"type":"array","items":{"type":"string","description":"Attribute describing a list of threats a particular area of interest may pose to other assets","example":"human"}}}},"FenceCircle":{"type":"object","properties":{"point":{"$ref":"#/components/schemas/GeoCoordinate"},"radius":{"type":"integer","format":"int64"}}},"FencePolygon":{"type":"object","properties":{"border":{"type":"array","items":{"$ref":"#/components/schemas/GeoCoordinate"}},"hole":{"type":"array","items":{"$ref":"#/components/schemas/GeoCoordinate"}}},"description":"Geographically defined borders (polygon or circle) enclosing this fence object","oneOf":[{"$ref":"#/components/schemas/FencePolygon"},{"$ref":"#/components/schemas/FenceCircle"}]},"GeoCoordinate":{"type":"object","properties":{"lat":{"type":"number"},"lon":{"type":"number"},"elevation":{"type":"number"}},"description":"Geo location, lat/long"},"FencePage":{"required":["fences","pageInfo"],"type":"object","properties":{"fences":{"type":"array","items":{"$ref":"#/components/schemas/Fence"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}},"CreateAssetDto":{"required":["class","description","displayName","properties","type"],"type":"object","properties":{"displayName":{"type":"string","description":"The name of the asset. It must always be unique.","example":"UWB asset - welding"},"description":{"maxLength":100,"minLength":0,"type":"string","description":"A description provided as additional information about the asset.","example":"This asset is currently allocated with a uwb & lte tag. Currently in use for welding area tracking"},"type":{"type":"string","description":"A type attribute defining an Asset","example":"forklift"},"threatTo":{"type":"array","items":{"type":"string","description":"An optional read-only attribute 'threat-to', that describes a list of threats a particular asset may pose to other assets","example":"[\"human\",\"forklift\"]"}},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Additional properties in the form of key-value pairs. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed. It contains the attribute 'properties.invalidTrackable' set to trackableId,  if trackableId associated with this asset is no longer present in Omlox System."},"description":"Additional properties in the form of key-value pairs. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed. It contains the attribute 'properties.invalidTrackable' set to trackableId,  if trackableId associated with this asset is no longer present in Omlox System."},"trackableId":{"type":"string","description":"An optional trackable id that is associated with a particular asset","example":"3f4b5468-d900-4642-bc62-2ada8b81da04"},"class":{"type":"string","description":"A class attribute defining an Asset","example":"actor"}}},"Position":{"required":["x","y","z"],"type":"object","properties":{"x":{"type":"number","description":"X-coordinate in meters","format":"double","example":5},"y":{"type":"number","description":"Y-coordinate in meters","format":"double","example":-3.1},"z":{"type":"number","description":"Z-coordinate in meters","format":"double","example":2.2},"description":{"type":"string","description":"Position description","example":"Meeting point"}},"description":"Position in cartesian 3D coordinate system"},"TrackableAssetDto":{"required":["class","description","displayName","id","modifiedAt","modifiedBy","properties","type"],"type":"object","properties":{"displayName":{"type":"string","description":"The name of the asset. It must always be unique.","example":"UWB asset - welding"},"description":{"maxLength":100,"minLength":0,"type":"string","description":"A description provided as additional information about the asset.","example":"This asset is currently allocated with a uwb & lte tag. Currently in use for welding area tracking"},"type":{"type":"string","description":"A type attribute defining an Asset","example":"forklift"},"threatTo":{"type":"array","items":{"type":"string","description":"An optional read-only attribute 'threat-to', that describes a list of threats a particular asset may pose to other assets","example":"[\"human\",\"forklift\"]"}},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Additional properties in the form of key-value pairs. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed. It contains the attribute 'properties.invalidTrackable' set to trackableId,  if trackableId associated with this asset is no longer present in Omlox System."},"description":"Additional properties in the form of key-value pairs. Used when a specific metadata information is to be passed. It can be empty if nothing is to be passed. It contains the attribute 'properties.invalidTrackable' set to trackableId,  if trackableId associated with this asset is no longer present in Omlox System."},"id":{"type":"string","description":"Must be a unique identifier. A unique id will be generated when creating a new Asset","example":"5f6d8decbb34bc13ccc7b1de"},"trackable":{"$ref":"#/components/schemas/TrackableState"},"aoiId":{"type":"string","description":"AoI identifier","example":"5f6d8decbb34bc13ccc7b1de"},"modifiedBy":{"type":"string","description":"The author of the last modification","example":"j.smith"},"modifiedAt":{"type":"string","description":"The last modification time","format":"date-time"},"class":{"type":"string","description":"A class attribute defining an Asset","example":"actor"}}},"TrackableState":{"required":["id","timestamp"],"type":"object","properties":{"id":{"type":"string","description":"Trackable UUID","format":"uuid","example":"f2a6fc5a-ddbd-4523-b06c-0fa675a3787c"},"name":{"type":"string","description":"Trackable name","example":"UWB Tag"},"timestamp":{"type":"integer","description":"State timestamp. Number of milliseconds since Epoche. Timestamp is generated by system.","format":"int64","example":1607363025000},"location":{"$ref":"#/components/schemas/GeoCoordinate"},"position":{"$ref":"#/components/schemas/Position"},"accuracy":{"type":"number","description":"The horizontal accuracy of the location update in meters.","example":1},"floor":{"type":"number","description":"A logical and non-localized representation for a building floor. Floor 0 represents the floor designated as 'ground'. Negative numbers designate floors below the ground floor and positive to indicate floors above the ground floor. When implemented the floor value MUST match described logical numbering scheme, which can be different from any numbering used within a building. Values can be expressed as an integer value, or as a float as required for mezzanine floor levels. If no value for the floor level is provided 0 MUST be assumed.","example":1},"providerId":{"type":"string","description":"The location provider unique identifier, e.g. the mac address of a UWB location provider.","example":"77:4f:34:69:27:40"},"providerType":{"type":"string","description":"The location provider type which triggered this location update.","example":"uwb"},"fenceId":{"type":"string","description":"Fence UUID","format":"uuid","example":"f2a6fc5a-ddbd-4523-b06c-0fa675a3787c"}}},"AssetPage":{"required":["assets","pageInfo"],"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/TrackableAssetDto"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}},"TrackableStatePage":{"required":["pageInfo","trackables"],"type":"object","properties":{"trackables":{"type":"array","items":{"$ref":"#/components/schemas/TrackableState"}},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}}}}}