Tech-
invite
3GPP
space
IETF
RFCs
SIP
index
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 29.257
Word version: 17.1.0
1…
5…
5
Services offered by the UAE Server
5.1
Introduction
5.2
UAE_C2OperationModeManagement Service
5.3
UAE_RealtimeUAVStatus Service
6
API Definitions
6.1
UAE_C2OperationModeManagement Service API
6.2
UAE_RealtimeUAVStatus Service API
7
Using Common API Framework
A
OpenAPI specification
B
Withdrawn API versions
$
Change history
5
Services offered by the UAE Server
p. 10
5.1
Introduction
p. 10
5.2
UAE_C2OperationModeManagement Service
p. 11
5.2.1
Service Description
p. 11
5.2.2
Service Operations
p. 11
5.2.2.1
Introduction
p. 11
5.2.2.2
UAE_C2OperationModeManagement_Initiate
p. 11
5.2.2.2.1
General
p. 11
5.2.2.2.2
C2 Operation Mode Initiation
p. 11
5.2.2.3
UAE_C2OperationModeManagement_Notify
p. 12
5.2.2.3.1
General
p. 12
5.2.2.3.2
C2 Operation Mode Management Completion Notification
p. 13
5.2.2.3.3
Selected C2 Communication Mode Notification
p. 13
5.2.2.3.4
C2 Communication Mode Switching Notification
p. 14
5.3
UAE_RealtimeUAVStatus Service
p. 15
5.3.1
Service Description
p. 15
5.3.2
Service Operations
p. 15
5.3.2.1
Introduction
p. 15
5.3.2.2
UAE_RealtimeUAVStatus_Subscribe
p. 16
5.3.2.2.1
General
p. 16
5.3.2.2.2
Subscribe to real-time UAV status information reporting
p. 16
5.3.2.2.3
Update an existing real-time UAV status information reporting subscription
p. 17
5.3.2.3
UAE_RealtimeUAVStatus_Unsubscribe
p. 17
5.3.2.3.1
General
p. 17
5.3.2.3.2
Unsubscribe from real-time UAV status information reporting
p. 18
5.3.2.4
UAE_RealtimeUAVStatus_Notify
p. 18
5.3.2.4.1
General
p. 18
5.3.2.4.2
Real-time UAV Status Notification
p. 18
6
API Definitions
p. 19
6.1
UAE_C2OperationModeManagement Service API
p. 19
6.1.1
Introduction
p. 19
6.1.2
Usage of HTTP
p. 19
6.1.3
Resources
p. 19
6.1.4
Custom Operations without associated resources
p. 20
6.1.4.1
Overview
p. 20
6.1.4.2
Operation: Initiate
p. 20
6.1.4.2.1
Description
p. 20
6.1.4.2.2
Operation Definition
p. 20
6.1.5
Notifications
p. 21
6.1.5.1
General
p. 21
6.1.5.2
C2 Operation Mode Management Completion Notification
p. 22
6.1.5.2.1
Description
p. 22
6.1.5.2.2
Target URI
p. 22
6.1.5.2.3
Standard Methods
p. 22
6.1.5.2.3.1
POST
p. 22
6.1.5.3
Selected C2 Communication Mode Notification
p. 23
6.1.5.3.1
Description
p. 23
6.1.5.3.2
Target URI
p. 23
6.1.5.3.3
Standard Methods
p. 23
6.1.5.3.3.1
POST
p. 23
6.1.5.4
C2 Communication Mode Switching Notification
p. 24
6.1.5.4.1
Description
p. 24
6.1.5.4.2
Target URI
p. 24
6.1.5.4.3
Standard Methods
p. 25
6.1.5.4.3.1
POST
p. 25
6.1.6
Data Model
p. 26
6.1.6.1
General
p. 26
6.1.6.2
Structured data types
p. 27
6.1.6.2.1
Introduction
p. 27
6.1.6.2.2
Type: ConfigureData
p. 28
6.1.6.2.3
Type: SelectedC2CommModeNotif
p. 30
6.1.6.2.4
Type: C2CommModeSwitchNotif
p. 30
6.1.6.2.5
Type: C2Result
p. 31
6.1.6.2.6
Type: UasId
p. 31
6.1.6.2.7
Type: UavId
p. 31
6.1.6.2.8
Type: C2ServiceArea
p. 32
6.1.6.2.9
Type: C2OpModeMngtCompStatus
p. 32
6.1.6.2.10
Type: C2SwitchPolicies
p. 32
6.1.6.2.11
Type: C2LinkQualityThrlds
p. 33
6.1.6.3
Simple data types and enumerations
p. 33
6.1.6.3.1
Introduction
p. 33
6.1.6.3.2
Simple data types
p. 33
6.1.6.3.3
Enumeration: C2CommMode
p. 33
6.1.6.3.4
Enumeration: C2CommModeSwitching
p. 34
6.1.6.3.5
Enumeration: C2SwitchingCause
p. 34
6.1.6.3.6
Enumeration: C2OpModeStatus
p. 35
6.1.6.4
Data types describing alternative data types or combinations of data types
p. 35
6.1.6.5
Binary data
p. 35
6.1.6.5.1
Binary Data Types
p. 35
6.1.7
Error Handling
p. 36
6.1.7.1
General
p. 36
6.1.7.2
Protocol Errors
p. 36
6.1.7.3
Application Errors
p. 36
6.1.8
Feature negotiation
p. 36
6.1.9
Security
p. 36
6.2
UAE_RealtimeUAVStatus Service API
p. 36
6.2.1
Introduction
p. 36
6.2.2
Usage of HTTP
p. 37
6.2.3
Resources
p. 37
6.2.3.1
Overview
p. 37
6.2.3.2
Resource: Real-time UAV Status Subscriptions
p. 38
6.2.3.2.1
Description
p. 38
6.2.3.2.2
Resource Definition
p. 38
6.2.3.2.3
Resource Standard Methods
p. 38
6.2.3.2.3.1
GET
p. 38
6.2.3.2.3.2
POST
p. 39
6.2.3.2.4
Resource Custom Operations
p. 40
6.2.3.3
Resource: Individual Real-time UAV Status Subscription
p. 40
6.2.3.3.1
Description
p. 40
6.2.3.3.2
Resource Definition
p. 40
6.2.3.3.3
Resource Standard Methods
p. 40
6.2.3.3.3.1
GET
p. 40
6.2.3.3.3.2
PUT
p. 41
6.2.3.3.3.3
DELETE
p. 42
6.2.3.3.4
Resource Custom Operations
p. 43
6.2.4
Custom Operations without associated resources
p. 43
6.2.5
Notifications
p. 43
6.2.5.1
General
p. 43
6.2.5.2
Real-time UAV Status Notification
p. 44
6.2.5.2.1
Description
p. 44
6.2.5.2.2
Target URI
p. 44
6.2.5.2.3
Standard Methods
p. 44
6.2.5.2.3.1
POST
p. 44
6.2.6
Data Model
p. 45
6.2.6.1
General
p. 45
6.2.6.2
Structured data types
p. 45
6.2.6.2.1
Introduction
p. 45
6.2.6.2.2
Type: RTUavStatusSubsc
p. 46
6.2.6.2.3
Type: RTUavStatusNotif
p. 46
6.2.6.2.4
Type: RTUavStatus
p. 46
6.2.6.2.5
Type: UavNetConnStatus
p. 47
6.2.6.3
Simple data types and enumerations
p. 47
6.2.6.3.1
Introduction
p. 47
6.2.6.3.2
Simple data types
p. 47
6.2.6.4
Data types describing alternative data types or combinations of data types
p. 47
6.2.6.5
Binary data
p. 47
6.2.6.5.1
Binary Data Types
p. 47
6.2.7
Error Handling
p. 47
6.2.7.1
General
p. 47
6.2.7.2
Protocol Errors
p. 48
6.2.7.3
Application Errors
p. 48
6.2.8
Feature negotiation
p. 48
6.2.9
Security
p. 48
7
Using Common API Framework
p. 48
7.1
General
p. 48
7.2
Security
p. 48
A
(Normative) OpenAPI specification
p. 50
A.1
General
p. 50
A.2
UAE_C2OperationModeManagement API
p. 50
A.3
UAE_RealtimeUAVStatus API
p. 56
B
Withdrawn API versions
p. 62
B.1
General
p. 62
B.2
UAE_C2OperationModeManagement API
p. 62
B.3
UAE_RealtimeUAVStatus API
p. 62
$
Change history
p. 63