UCIS AsyncAPI 2.2.0 documentation

UCIS AsyncAPI 2.2.0

Asynchronous APIs offered by the UCIS solution

Download AsyncAPI specification: Download

#Flight-planning
#Geoawareness
#Network-Identification

Servers

$UCIS_WS_URLwss 0.1.0development-wss
The project assigned Websocket UCIS URL. See UCIS Quickstart for more information.

Operations

SUB /dops
Channel used to receive notifications about Drone Operation Plans from UCIS.

Operation IDdroneOperationPlanNotificationSub
Available only on servers:
- development-wss
Additional security requirements:
OAuth2
Required scopes: notification.flight-planning.read
Flow:Password
Token URL:https://$AUTH_PATH/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
notification.flight-planning.read
notification.geoawareness.read
notification.dcm.read
network.identification.write
network.identification.read
method
GET
object
array<array<number>>
2 itemsuid: BoundingBox
2 geographical points to define specific rectangle. Each point is defined by one longitude and one latitude (in that order). If specified, only notifications located in this area will be notified.

array<number>
[ 2 .. 3 ] items
Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

Items:
number
bearer
string
Authorization token obtained during authentification (JWT format). Expected format: ^Bearer [\w-]+\.[\w-]+\.[\w-]+$.

Additional properties are allowed.
- #Flight-planning
Accepts the following message:
Drone Operation Plan Message
This message contains a notification when a Drone Operation Plan object is created or modified.

object
Object that describes a notification about the creation or modification of a Drone Operation Plan object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

notification_type
required
string
uid: NotificationType
Unique value representing the type of the notification.

Allowed values:
"activated"
"acknowledged"
"approved"
"cancelled"
"closed"
"filed"
"rejected"
"updated"
dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

Additional properties are allowed.
#Flight-planning
Examples
{ "notification_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "notify_at": "2017-07-21T17:32:28Z", "notification_type": "activated", "dop_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092" }

This example has been generated automatically.
SUB /geoawareness
Channel used to receive notifications about UAS Zones from UCIS.

Operation IDuasZoneNotificationSub
Available only on servers:
- development-wss
Additional security requirements:
OAuth2
Required scopes: notification.geoawareness.read
Flow:Password
Token URL:https://$AUTH_PATH/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
notification.flight-planning.read
notification.geoawareness.read
notification.dcm.read
network.identification.write
network.identification.read
method
GET
object
array<array<number>>
2 itemsuid: BoundingBox
2 geographical points to define specific rectangle. Each point is defined by one longitude and one latitude (in that order). If specified, only notifications located in this area will be notified.

array<number>
[ 2 .. 3 ] items
Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

Items:
number
bearer
string
Authorization token obtained during authentification (JWT format). Expected format: ^Bearer [\w-]+\.[\w-]+\.[\w-]+$.

Additional properties are allowed.
- #Geoawareness
Accepts the following message:
UASZone Message
This message contains a notification when an UASZone object is created or modified.

object
Object that describes a notification about the creation or modification of an UASZone object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

notification_type
required
string
uid: NotificationType
Unique value representing the type of the notification.

Allowed values:
"activated"
"acknowledged"
"approved"
"cancelled"
"closed"
"filed"
"rejected"
"updated"
uaszone_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the UAS Zone stored in UCIS. See this API.

Additional properties are allowed.
#Geoawareness
Examples
{ "notification_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "notify_at": "2017-07-21T17:32:28Z", "notification_type": "activated", "uaszone_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092" }

This example has been generated automatically.
SUB /dcm
Channel used to receive notifications about Dynamic Capacity Management from UCIS.

Operation IDdcmHotspotNotificationSub
Available only on servers:
- development-wss
Additional security requirements:
OAuth2
Required scopes: notification.dcm.read
Flow:Password
Token URL:https://$AUTH_PATH/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
notification.flight-planning.read
notification.geoawareness.read
notification.dcm.read
network.identification.write
network.identification.read
method
GET
object
array<array<number>>
2 itemsuid: BoundingBox
2 geographical points to define specific rectangle. Each point is defined by one longitude and one latitude (in that order). If specified, only notifications located in this area will be notified.

array<number>
[ 2 .. 3 ] items
Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

Items:
number
bearer
string
Authorization token obtained during authentification (JWT format). Expected format: ^Bearer [\w-]+\.[\w-]+\.[\w-]+$.

Additional properties are allowed.
- #Dynamic-Capacity-Management
Accepts the following message:
Dynamic Capacity Management Message
This message contains a notification when the Dynamic Capacity Management (noise and visual impact) computation is finished for a Drone Operation Plan.

object
Object that describes a notification about the computation of a Dynamic Capacity Management object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan which involved hotspots calculations. See this API.

hotspots_count
read-only
integer
The number of hotspots generated by the linked Drone Operation Plan.

Additional properties are allowed.
#Dynamic-Capacity-Management
Examples
{ "notification_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "notify_at": "2017-07-21T17:32:28Z", "dop_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "hotspots_count": "4" }

This example has been generated automatically.
PUB /nis/publish
Channel used to send Network Identification Data to UCIS

Operation IDnetworkIdentificationPub
Available only on servers:
- development-wss
Additional security requirements:
OAuth2
Required scopes: network.identification.write
Flow:Password
Token URL:https://$AUTH_PATH/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
notification.flight-planning.read
notification.geoawareness.read
notification.dcm.read
network.identification.write
network.identification.read
method
POST
object
Authorization
string
Authorization token obtained during authentification (JWT format). Expected format: ^Bearer [\w-]+\.[\w-]+\.[\w-]+$.

Additional properties are allowed.
- #Network-Identification
Accepts the following message:
Network Identification Message
A message that carries Network Identification data.

object
Object that represents an Unmanned Aircraft System (UAS) Network Identification Data

dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

measurement_timestamp
required
string
format: date-time
The timestamp when the measurement was made. It must comply with the date-time notation as defined by RFC 3339.

required
object
Object that represents the coordinates of an Unmanned Aircraft System (UAS).

longitude
required
number
[ -180 .. 180 ]
The longitude of the UAS

latitude
required
number
[ -90 .. 90 ]
The latitude of the UAS

altitude
required
number
The altitude of the UAS, i.e its height in meters above sea level.

height
required
number
The height of the UAS, i.e its height in meters above the surface or take-off point.

Additional properties are allowed.
required
object
Object that represents the speed of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal speed (North/South speed and East/West speed)

north_south_speed
required
number
>= 0
The speed projected on north-south axis

east_west_speed
required
number
>= 0
The speed projected on east-west axis

vertical_speed
required
number
>= 0
The speed projected on vertical axis

Additional properties are allowed.
object
Object that represents the acceleration of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal acceleration (North/South acceleration and East/West acceleration)

north_south_acceleration
required
number
The acceleration projected on north-south axis

east_west_acceleration
required
number
The acceleration projected on east-west axis

vertical_acceleration
required
number
The acceleration projected on vertical axis

Additional properties are allowed.
route_course
required
integer
[ 0 .. 360 ]
The cardinal direction in which the UAS is to be steered.

array<number>
[ 2 .. 3 ] items
Displacement in meters x (east/west), y (north/south), z (altitude) coordinates (see WGS84 standard). The value for each axis is applied in both directions of this one.

Items:
number
>= 0
read-only
object
The metadata of the Network Identification Data.

created_with
required
string
Unique name of the data provider referenced in UCIS that has been used to create the associated object.

created_at
required
string
format: date-time
When the associated object has been created in UCIS.

last_modified_with
string
Unique name of the data provider referenced in UCIS that has been used to do the last modification of the associated object.

last_modified_at
string
format: date-time
When the associated object has been last updated.

Additional properties are allowed.
operator_registration_number
required
string
The UAS operator registration number, identifying the operator not the drone itself.

uas_serial_number
required
string
The unique serial number of the unmanned aircraft or, if the unmanned aircraft is privately built, the unique serial number of the add-on.

required
array<number>
[ 2 .. 3 ] items
The geographical position of the remote pilot or, if not available, the take-off point.

Items:
number
emergency_status
required
string
The UAS emergency status.

Allowed values:
"NOMINAL"
"EMERGENCY_1"
"EMERGENCY_2"
notification_timestamp
required
string
format: date-time
The datetime on which the notification is sent by UCIS

Additional properties are allowed.
#Network-Identification
Examples
{ "dop_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "measurement_timestamp": "1990-12-31T15:30:00.000Z", "uas_coordinates": { "longitude": -180, "latitude": -90, "altitude": 0, "height": 0 }, "speed": { "north_south_speed": 0, "east_west_speed": 0, "vertical_speed": 0 }, "acceleration": { "north_south_acceleration": 0, "east_west_acceleration": 0, "vertical_acceleration": 0 }, "route_course": 360, "uncertainty": [ 0, 0 ], "metadata": { "created_with": "string", "created_at": "2019-08-24T14:15:22Z", "last_modified_with": "string", "last_modified_at": "2019-08-24T14:15:22Z" }, "operator_registration_number": "string", "uas_serial_number": "string", "remote_pilot_coordinates": [ 0, 0 ], "emergency_status": "NOMINAL", "notification_timestamp": "1990-12-31T15:30:00.000Z" }

This example has been generated automatically.
SUB /nis/subscribe
Channel used to consume Network Identification Data from UCIS. Network Identification notifications of a DOP are only notified to its owner (i.e. the user that created the DOP in UCIS), the Air Navigation Service Providers (ANSPs) and the U-Space Service Providers (USSPs).

Operation IDnetworkIdentificationSub
Available only on servers:
- development-wss
Additional security requirements:
OAuth2
Required scopes: network.identification.read
Flow:Password
Token URL:https://$AUTH_PATH/auth/realms/UCIS/protocol/openid-connect/token
Scopes:
notification.flight-planning.read
notification.geoawareness.read
notification.dcm.read
network.identification.write
network.identification.read
method
GET
object
Contains the filters to be applied on the query. If the filtering by DOP is set, the other filters are ignored.

array<array<number>>
2 itemsuid: BoundingBox
2 geographical points to define specific rectangle. Each point is defined by one longitude and one latitude (in that order). If specified, only notifications located in this area will be notified.

array<number>
[ 2 .. 3 ] items
Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

Items:
number
dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan (DOP) stored in UCIS (see this API). If specified, only Network Identification notifications of this DOP will be notified.

bearer
string
Authorization token obtained during authentification (JWT format). Expected format: ^Bearer [\w-]+\.[\w-]+\.[\w-]+$.

Additional properties are allowed.
- #Network-Identification
Accepts the following message:
Network Identification Message
A message that carries Network Identification data.

object
Object that represents an Unmanned Aircraft System (UAS) Network Identification Data

dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

measurement_timestamp
required
string
format: date-time
The timestamp when the measurement was made. It must comply with the date-time notation as defined by RFC 3339.

required
object
Object that represents the coordinates of an Unmanned Aircraft System (UAS).

longitude
required
number
[ -180 .. 180 ]
The longitude of the UAS

latitude
required
number
[ -90 .. 90 ]
The latitude of the UAS

altitude
required
number
The altitude of the UAS, i.e its height in meters above sea level.

height
required
number
The height of the UAS, i.e its height in meters above the surface or take-off point.

Additional properties are allowed.
required
object
Object that represents the speed of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal speed (North/South speed and East/West speed)

north_south_speed
required
number
>= 0
The speed projected on north-south axis

east_west_speed
required
number
>= 0
The speed projected on east-west axis

vertical_speed
required
number
>= 0
The speed projected on vertical axis

Additional properties are allowed.
object
Object that represents the acceleration of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal acceleration (North/South acceleration and East/West acceleration)

north_south_acceleration
required
number
The acceleration projected on north-south axis

east_west_acceleration
required
number
The acceleration projected on east-west axis

vertical_acceleration
required
number
The acceleration projected on vertical axis

Additional properties are allowed.
route_course
required
integer
[ 0 .. 360 ]
The cardinal direction in which the UAS is to be steered.

array<number>
[ 2 .. 3 ] items
Displacement in meters x (east/west), y (north/south), z (altitude) coordinates (see WGS84 standard). The value for each axis is applied in both directions of this one.

Items:
number
>= 0
read-only
object
The metadata of the Network Identification Data.

created_with
required
string
Unique name of the data provider referenced in UCIS that has been used to create the associated object.

created_at
required
string
format: date-time
When the associated object has been created in UCIS.

last_modified_with
string
Unique name of the data provider referenced in UCIS that has been used to do the last modification of the associated object.

last_modified_at
string
format: date-time
When the associated object has been last updated.

Additional properties are allowed.
operator_registration_number
required
string
The UAS operator registration number, identifying the operator not the drone itself.

uas_serial_number
required
string
The unique serial number of the unmanned aircraft or, if the unmanned aircraft is privately built, the unique serial number of the add-on.

required
array<number>
[ 2 .. 3 ] items
The geographical position of the remote pilot or, if not available, the take-off point.

Items:
number
emergency_status
required
string
The UAS emergency status.

Allowed values:
"NOMINAL"
"EMERGENCY_1"
"EMERGENCY_2"
notification_timestamp
required
string
format: date-time
The datetime on which the notification is sent by UCIS

Additional properties are allowed.
#Network-Identification
Examples
{ "dop_uuid": "678c5ba8-fc46-4f99-92e3-4ceaf5d48092", "measurement_timestamp": "1990-12-31T15:30:00.000Z", "uas_coordinates": { "longitude": -180, "latitude": -90, "altitude": 0, "height": 0 }, "speed": { "north_south_speed": 0, "east_west_speed": 0, "vertical_speed": 0 }, "acceleration": { "north_south_acceleration": 0, "east_west_acceleration": 0, "vertical_acceleration": 0 }, "route_course": 360, "uncertainty": [ 0, 0 ], "metadata": { "created_with": "string", "created_at": "2019-08-24T14:15:22Z", "last_modified_with": "string", "last_modified_at": "2019-08-24T14:15:22Z" }, "operator_registration_number": "string", "uas_serial_number": "string", "remote_pilot_coordinates": [ 0, 0 ], "emergency_status": "NOMINAL", "notification_timestamp": "1990-12-31T15:30:00.000Z" }

This example has been generated automatically.

Messages

#1Drone Operation Plan Message
This message contains a notification when a Drone Operation Plan object is created or modified.
object
Object that describes a notification about the creation or modification of a Drone Operation Plan object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

notification_type
required
string
uid: NotificationType
Unique value representing the type of the notification.

Allowed values:
"activated"
"acknowledged"
"approved"
"cancelled"
"closed"
"filed"
"rejected"
"updated"
dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

Additional properties are allowed.
#Flight-planning
#2UASZone Message
This message contains a notification when an UASZone object is created or modified.
object
Object that describes a notification about the creation or modification of an UASZone object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

notification_type
required
string
uid: NotificationType
Unique value representing the type of the notification.

Allowed values:
"activated"
"acknowledged"
"approved"
"cancelled"
"closed"
"filed"
"rejected"
"updated"
uaszone_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the UAS Zone stored in UCIS. See this API.

Additional properties are allowed.
#Geoawareness
#3Dynamic Capacity Management Message
This message contains a notification when the Dynamic Capacity Management (noise and visual impact) computation is finished for a Drone Operation Plan.

object
Object that describes a notification about the computation of a Dynamic Capacity Management object in UCIS.

notification_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the notification. It is auto-generated in UCIS.

notify_at
read-only
string
format: date-time
The emission datetime of the notification. It must comply with the date-time notation as defined by RFC 3339.

dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan which involved hotspots calculations. See this API.

hotspots_count
read-only
integer
The number of hotspots generated by the linked Drone Operation Plan.

Additional properties are allowed.
#Dynamic-Capacity-Management
#4Network Identification Message
A message that carries Network Identification data.
object
Object that represents an Unmanned Aircraft System (UAS) Network Identification Data

dop_uuid
read-only
string
format: uuid
Universally unique identifier (version 4) of the Drone Operation Plan stored in UCIS. See this API.

measurement_timestamp
required
string
format: date-time
The timestamp when the measurement was made. It must comply with the date-time notation as defined by RFC 3339.

required
object
Object that represents the coordinates of an Unmanned Aircraft System (UAS).

longitude
required
number
[ -180 .. 180 ]
The longitude of the UAS

latitude
required
number
[ -90 .. 90 ]
The latitude of the UAS

altitude
required
number
The altitude of the UAS, i.e its height in meters above sea level.

height
required
number
The height of the UAS, i.e its height in meters above the surface or take-off point.

Additional properties are allowed.
required
object
Object that represents the speed of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal speed (North/South speed and East/West speed)

north_south_speed
required
number
>= 0
The speed projected on north-south axis

east_west_speed
required
number
>= 0
The speed projected on east-west axis

vertical_speed
required
number
>= 0
The speed projected on vertical axis

Additional properties are allowed.
object
Object that represents the acceleration of an Unmanned Aircraft System (UAS), which is represented by his vertical and horizontal acceleration (North/South acceleration and East/West acceleration)

north_south_acceleration
required
number
The acceleration projected on north-south axis

east_west_acceleration
required
number
The acceleration projected on east-west axis

vertical_acceleration
required
number
The acceleration projected on vertical axis

Additional properties are allowed.
route_course
required
integer
[ 0 .. 360 ]
The cardinal direction in which the UAS is to be steered.

array<number>
[ 2 .. 3 ] items
Displacement in meters x (east/west), y (north/south), z (altitude) coordinates (see WGS84 standard). The value for each axis is applied in both directions of this one.

Items:
number
>= 0
read-only
object
The metadata of the Network Identification Data.

created_with
required
string
Unique name of the data provider referenced in UCIS that has been used to create the associated object.

created_at
required
string
format: date-time
When the associated object has been created in UCIS.

last_modified_with
string
Unique name of the data provider referenced in UCIS that has been used to do the last modification of the associated object.

last_modified_at
string
format: date-time
When the associated object has been last updated.

Additional properties are allowed.
operator_registration_number
required
string
The UAS operator registration number, identifying the operator not the drone itself.

uas_serial_number
required
string
The unique serial number of the unmanned aircraft or, if the unmanned aircraft is privately built, the unique serial number of the add-on.

required
array<number>
[ 2 .. 3 ] items
The geographical position of the remote pilot or, if not available, the take-off point.

Items:
number
emergency_status
required
string
The UAS emergency status.

Allowed values:
"NOMINAL"
"EMERGENCY_1"
"EMERGENCY_2"
notification_timestamp
required
string
format: date-time
The datetime on which the notification is sent by UCIS

Additional properties are allowed.
#Network-Identification

Schemas

NotificationType
string
uid: NotificationType
Unique value representing the type of the notification.

Allowed values:
"activated"
"acknowledged"
"approved"
"cancelled"
"closed"
"filed"
"rejected"
"updated"
array<array<number>>
2 itemsuid: BoundingBox
2 geographical points to define specific rectangle. Each point is defined by one longitude and one latitude (in that order). If specified, only notifications located in this area will be notified.

array<number>
[ 2 .. 3 ] items
Longitude/Latitude/(Altitude) pair (in that order) used for specifying geographical vertex. Specified as an array. Altitude is optional and it is expressed in meters above the WGS84 elipsoide (see https://tools.ietf.org/html/rfc7946#page-12).

Items:
number

Servers

Operations

SUB /dops

Additional security requirements:

Examples

This example has been generated automatically.

SUB /geoawareness

Additional security requirements:

Examples

This example has been generated automatically.

SUB /dcm

Additional security requirements:

Examples

This example has been generated automatically.

PUB /nis/publish

Additional security requirements:

Examples

This example has been generated automatically.

SUB /nis/subscribe

Additional security requirements:

Examples

This example has been generated automatically.

Messages

Schemas