Tech-invite 3GPPspace IETFspace

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: 18.4.0

1… 5…

5.1 Introduction 5.2 UAE_C2OperationModeManagement Service 5.3 UAE_RealtimeUAVStatus Service 5.4 UAE_ChangeUSSManagement Service 5.5 UAE_DAASupport Service 5.6 UAE_UAVDynamicInfo 6.1 UAE_C2OperationModeManagement Service API 6.2 UAE_RealtimeUAVStatus Service API 6.3 UAE_ChangeUSSManagement Service API 6.4 UAE_DAASupport Service API 6.5 UAE_UAVDynamicInfo API

5 Services offered by the UAE Server p. 15

5.1 Introduction p. 15

5.2 UAE_C2OperationModeManagement Service p. 15

5.2.1 Service Description p. 15

5.2.2 Service Operations p. 16

5.2.2.1 Introduction p. 16

5.2.2.2 UAE_C2OperationModeManagement_Initiate p. 16

5.2.2.2.1 General p. 16

5.2.2.2.2 C2 Operation Mode Initiation p. 16

5.2.2.3 UAE_C2OperationModeManagement_Notify p. 17

5.2.2.3.1 General p. 17

5.2.2.3.2 C2 Operation Mode Management Completion Notification p. 18

5.2.2.3.3 Selected C2 Communication Mode Notification p. 18

5.2.2.3.4 C2 Communication Mode Switching Notification p. 19

5.3 UAE_RealtimeUAVStatus Service p. 21

5.3.1 Service Description p. 21

5.3.2 Service Operations p. 21

5.3.2.1 Introduction p. 21

5.3.2.2 UAE_RealtimeUAVStatus_Subscribe p. 21

5.3.2.2.1 General p. 21

5.3.2.2.2 Subscribe to real-time UAV status information reporting p. 21

5.3.2.2.3 Update an existing real-time UAV status information reporting subscription p. 22

5.3.2.3 UAE_RealtimeUAVStatus_Unsubscribe p. 23

5.3.2.3.1 General p. 23

5.3.2.3.2 Unsubscribe from real-time UAV status information reporting p. 23

5.3.2.4 UAE_RealtimeUAVStatus_Notify p. 24

5.3.2.4.1 General p. 24

5.3.2.4.2 Real-time UAV Status Notification p. 24

5.4 UAE_ChangeUSSManagement Service |R18| p. 25

5.4.1 Service Description p. 25

5.4.2 Service Operations p. 25

5.4.2.1 Introduction p. 25

5.4.2.2 UAE_ChangeUSSManagement_ManageUSS p. 25

5.4.2.2.1 General p. 25

5.4.2.2.2 USS Change Policy Creation p. 25

5.4.2.2.3 USS Change Policy Update p. 26

5.4.2.2.4 USS Change Policy Deletion p. 27

5.4.2.3 UAE_ChangeUSSManagement_RequestUSSChange p. 27

5.4.2.3.1 General p. 27

5.4.2.3.2 USS Change Request p. 27

5.4.2.4 UAE_ChangeUSSManagement_Notify p. 28

5.4.2.4.1 General p. 28

5.4.2.4.2 USS Change Notification p. 28

5.5 UAE_DAASupport Service |R18| p. 30

5.5.1 Service Description p. 30

5.5.2 Service Operations p. 30

5.5.2.1 Introduction p. 30

5.5.2.2 UAE_DAASupport_Manage p. 30

5.5.2.2.1 General p. 30

5.5.2.2.2 DAA Policy Creation p. 30

5.5.2.2.3 DAA Policy Update p. 31

5.5.2.2.4 DAA Policy Deletion p. 32

5.5.2.3 UAE_DAASupport_InformDAAEvents p. 32

5.5.2.3.1 General p. 32

5.5.2.3.2 DAA Events Information Request p. 32

5.5.2.4 UAE_DAASupport_Notify p. 33

5.5.2.4.1 General p. 33

5.5.2.4.2 DAA Policy Configuration Completion Status Notification p. 33

5.5.2.4.3 DAA Events Notification p. 34

5.6 UAE_UAVDynamicInfo |R18| p. 35

5.6.1 Service Description p. 35

5.6.2 Service Operations p. 35

5.6.2.1 Introduction p. 35

5.6.2.2 UAE_UAVDynamicInfo_Subscribe p. 35

5.6.2.2.1 General p. 35

5.6.2.2.2 UAV Dynamic Information Subscription Creation p. 35

5.6.2.2.3 UAV Dynamic Information Subscription Update p. 36

5.6.2.2.4 UAV Dynamic Information Subscription Deletion p. 36

5.6.2.3 UAE_UAVDynamicInfo_Notify p. 37

5.6.2.3.1 General p. 37

5.6.2.3.2 UAV Dynamic Information Notification p. 37

6 API Definitions p. 39

6.1 UAE_C2OperationModeManagement Service API p. 39

6.1.1 Introduction p. 39

6.1.2 Usage of HTTP p. 39

6.1.3 Resources p. 39

6.1.4 Custom Operations without associated resources p. 39

6.1.4.1 Overview p. 39

6.1.4.2 Operation: Initiate p. 40

6.1.4.2.1 Description p. 40

6.1.4.2.2 Operation Definition p. 40

6.1.5 Notifications p. 41

6.1.5.1 General p. 41

6.1.5.2 C2 Operation Mode Management Completion Notification p. 42

6.1.5.2.1 Description p. 42

6.1.5.2.2 Target URI p. 42

6.1.5.2.3 Standard Methods p. 42

6.1.5.2.3.1 POST p. 42

6.1.5.3 Selected C2 Communication Mode Notification p. 43

6.1.5.3.1 Description p. 43

6.1.5.3.2 Target URI p. 43

6.1.5.3.3 Standard Methods p. 44

6.1.5.3.3.1 POST p. 44

6.1.5.4 C2 Communication Mode Switching Notification p. 44

6.1.5.4.1 Description p. 44

6.1.5.4.2 Target URI p. 45

6.1.5.4.3 Standard Methods p. 45

6.1.5.4.3.1 POST p. 45

6.1.6 Data Model p. 46

6.1.6.1 General p. 46

6.1.6.2 Structured data types p. 47

6.1.6.2.1 Introduction p. 47

6.1.6.2.2 Type: ConfigureData p. 48

6.1.6.2.3 Type: SelectedC2CommModeNotif p. 50

6.1.6.2.4 Type: C2CommModeSwitchNotif p. 50

6.1.6.2.5 Type: C2Result p. 51

6.1.6.2.6 Type: UasId p. 51

6.1.6.2.7 Type: UavId p. 51

6.1.6.2.8 Type: C2ServiceArea p. 52

6.1.6.2.9 Type: C2OpModeMngtCompStatus p. 52

6.1.6.2.10 Type: C2SwitchPolicies p. 52

6.1.6.2.11 Type: C2LinkQualityThrlds p. 53

6.1.6.3 Simple data types and enumerations p. 53

6.1.6.3.1 Introduction p. 53

6.1.6.3.2 Simple data types p. 53

6.1.6.3.3 Enumeration: C2CommMode p. 53

6.1.6.3.4 Enumeration: C2CommModeSwitching p. 54

6.1.6.3.5 Enumeration: C2SwitchingCause p. 54

6.1.6.3.6 Enumeration: C2OpModeStatus p. 55

6.1.6.4 Data types describing alternative data types or combinations of data types p. 55

6.1.6.5 Binary data p. 55

6.1.6.5.1 Binary Data Types p. 55

6.1.7 Error Handling p. 56

6.1.7.1 General p. 56

6.1.7.2 Protocol Errors p. 56

6.1.7.3 Application Errors p. 56

6.1.8 Feature negotiation p. 56

6.1.9 Security p. 56

6.2 UAE_RealtimeUAVStatus Service API p. 57

6.2.1 Introduction p. 57

6.2.2 Usage of HTTP p. 57

6.2.3 Resources p. 57

6.2.3.1 Overview p. 57

6.2.3.2 Resource: Real-time UAV Status Subscriptions p. 58

6.2.3.2.1 Description p. 58

6.2.3.2.2 Resource Definition p. 58

6.2.3.2.3 Resource Standard Methods p. 58

6.2.3.2.3.1 GET p. 58

6.2.3.2.3.2 POST p. 59

6.2.3.2.4 Resource Custom Operations p. 60

6.2.3.3 Resource: Individual Real-time UAV Status Subscription p. 60

6.2.3.3.1 Description p. 60

6.2.3.3.2 Resource Definition p. 60

6.2.3.3.3 Resource Standard Methods p. 60

6.2.3.3.3.1 GET p. 60

6.2.3.3.3.2 PUT p. 61

6.2.3.3.3.3 DELETE p. 62

6.2.3.3.4 Resource Custom Operations p. 63

6.2.4 Custom Operations without associated resources p. 63

6.2.5 Notifications p. 64

6.2.5.1 General p. 64

6.2.5.2 Real-time UAV Status Notification p. 64

6.2.5.2.1 Description p. 64

6.2.5.2.2 Target URI p. 64

6.2.5.2.3 Standard Methods p. 64

6.2.5.2.3.1 POST p. 64

6.2.6 Data Model p. 65

6.2.6.1 General p. 65

6.2.6.2 Structured data types p. 66

6.2.6.2.1 Introduction p. 66

6.2.6.2.2 Type: RTUavStatusSubsc p. 66

6.2.6.2.3 Type: RTUavStatusNotif p. 66

6.2.6.2.4 Type: RTUavStatus p. 67

6.2.6.2.5 Type: UavNetConnStatus p. 67

6.2.6.3 Simple data types and enumerations p. 67

6.2.6.3.1 Introduction p. 67

6.2.6.3.2 Simple data types p. 67

6.2.6.4 Data types describing alternative data types or combinations of data types p. 67

6.2.6.5 Binary data p. 68

6.2.6.5.1 Binary Data Types p. 68

6.2.7 Error Handling p. 68

6.2.7.1 General p. 68

6.2.7.2 Protocol Errors p. 68

6.2.7.3 Application Errors p. 68

6.2.8 Feature negotiation p. 68

6.2.9 Security p. 68

6.3 UAE_ChangeUSSManagement Service API |R18| p. 69

6.3.1 Introduction p. 69

6.3.2 Usage of HTTP p. 69

6.3.3 Resources p. 69

6.3.3.1 Overview p. 69

6.3.3.2 Resource: USS Change Policies p. 70

6.3.3.2.1 Description p. 70

6.3.3.2.2 Resource Definition p. 70

6.3.3.2.3 Resource Standard Methods p. 70

6.3.3.2.3.1 GET p. 70

6.3.3.2.3.2 POST p. 71

6.3.3.2.4 Resource Custom Operations p. 72

6.3.3.3 Resource: Individual USS Change Policy p. 72

6.3.3.3.1 Description p. 72

6.3.3.3.2 Resource Definition p. 72

6.3.3.3.3 Resource Standard Methods p. 72

6.3.3.3.3.1 GET p. 72

6.3.3.3.3.2 PUT p. 73

6.3.3.3.3.3 PATCH p. 74

6.3.3.3.3.4 DELETE p. 76

6.3.3.3.4 Resource Custom Operations p. 76

6.3.4 Custom Operations without associated resources p. 77

6.3.4.1 Overview p. 77

6.3.4.2 Operation: RequestUssChange p. 77

6.3.4.2.1 Description p. 77

6.3.4.2.2 Operation Definition p. 77

6.3.5 Notifications p. 78

6.3.5.1 General p. 78

6.3.5.2 USS Change Notification p. 78

6.3.5.2.1 Description p. 78

6.3.5.2.2 Target URI p. 79

6.3.5.2.3 Standard Methods p. 79

6.3.5.2.3.1 POST p. 79

6.3.6 Data Model p. 80

6.3.6.1 General p. 80

6.3.6.2 Structured data types p. 81

6.3.6.2.1 Introduction p. 81

6.3.6.2.2 Type: USSChangePolReq p. 81

6.3.6.2.3 Type: USSChangePolResp p. 81

6.3.6.2.4 Type: USSChangePolicy p. 82

6.3.6.2.5 Type: USSChangePolicyPatch p. 82

6.3.6.2.6 Type: MultiUssPol p. 82

6.3.6.2.7 Type: ServArea p. 83

6.3.6.2.8 Type: UasRoute p. 83

6.3.6.2.9 Type: UssInfo p. 83

6.3.6.2.10 Type: ServReq p. 83

6.3.6.2.11 Type: USSChangeReq p. 84

6.3.6.2.12 Type: TgtUssInfo p. 84

6.3.6.2.13 Type: USSChangeNotif p. 85

6.3.6.2.14 Type: UssChgInfo p. 85

6.3.6.3 Simple data types and enumerations p. 85

6.3.6.3.1 Introduction p. 85

6.3.6.3.2 Simple data types p. 85

6.3.6.3.3 Enumeration: UssChangeEvent p. 86

6.3.6.3.4 Enumeration: MobilityEvent p. 86

6.3.6.4 Data types describing alternative data types or combinations of data types p. 86

6.3.6.5 Binary data p. 86

6.3.6.5.1 Binary Data Types p. 86

6.3.7 Error Handling p. 86

6.3.7.1 General p. 86

6.3.7.2 Protocol Errors p. 87

6.3.7.3 Application Errors p. 87

6.3.8 Feature negotiation p. 87

6.3.9 Security p. 87

6.4 UAE_DAASupport Service API |R18| p. 88

6.4.1 Introduction p. 88

6.4.2 Usage of HTTP p. 88

6.4.3 Resources p. 88

6.4.3.1 Overview p. 88

6.4.3.2 Resource: DAA Policies p. 89

6.4.3.2.1 Description p. 89

6.4.3.2.2 Resource Definition p. 89

6.4.3.2.3 Resource Standard Methods p. 89

6.4.3.2.3.1 GET p. 89

6.4.3.2.3.2 POST p. 90

6.4.3.2.4 Resource Custom Operations p. 91

6.4.3.3 Resource: Individual DAA Policy p. 91

6.4.3.3.1 Description p. 91

6.4.3.3.2 Resource Definition p. 91

6.4.3.3.3 Resource Standard Methods p. 91

6.4.3.3.3.1 GET p. 91

6.4.3.3.3.2 PUT p. 92

6.4.3.3.3.3 PATCH p. 93

6.4.3.3.3.4 DELETE p. 94

6.4.3.3.4 Resource Custom Operations p. 95

6.4.4 Custom Operations without associated resources p. 95

6.4.4.1 Overview p. 95

6.4.4.2 Operation: InformDAAEvents p. 96

6.4.4.2.1 Description p. 96

6.4.4.2.2 Operation Definition p. 96

6.4.5 Notifications p. 97

6.4.5.1 General p. 97

6.4.5.2 DAA Policy Configuration Completion Status Notification p. 98

6.4.5.2.1 Description p. 98

6.4.5.2.2 Target URI p. 98

6.4.5.2.3 Standard Methods p. 98

6.4.5.2.3.1 POST p. 98

6.4.5.3 DAA Events Notification p. 99

6.4.5.3.1 Description p. 99

6.4.5.3.2 Target URI p. 99

6.4.5.3.3 Standard Methods p. 99

6.4.5.3.3.1 POST p. 99

6.4.6 Data Model p. 100

6.4.6.1 General p. 100

6.4.6.2 Structured data types p. 101

6.4.6.2.1 Introduction p. 101

6.4.6.2.2 Type: DAAPolReq p. 101

6.4.6.2.3 Type: DAAPolResp p. 102

6.4.6.2.4 Type: DAAPolicy p. 102

6.4.6.2.5 Type: DAAPolicyPatch p. 102

6.4.6.2.6 Type: DAAAppPolicy p. 102

6.4.6.2.7 Type: InformDAAEventsReq p. 103

6.4.6.2.8 Type: DAAPolConfigNotif p. 103

6.4.6.2.9 Type: DAAEventsInfo p. 103

6.4.6.2.10 Type: DAAEvent p. 104

6.4.6.3 Simple data types and enumerations p. 104

6.4.6.3.1 Introduction p. 104

6.4.6.3.2 Simple data types p. 104

6.4.6.3.3 Enumeration: DAAPolConfigStatus p. 104

6.4.6.4 Data types describing alternative data types or combinations of data types p. 104

6.4.6.5 Binary data p. 105

6.4.6.5.1 Binary Data Types p. 105

6.4.7 Error Handling p. 105

6.4.7.1 General p. 105

6.4.7.2 Protocol Errors p. 105

6.4.7.3 Application Errors p. 105

6.4.8 Feature negotiation p. 105

6.4.9 Security p. 105

6.5 UAE_UAVDynamicInfo API |R18| p. 106

6.5.1 Introduction p. 106

6.5.2 Usage of HTTP p. 106

6.5.3 Resources p. 106

6.5.3.1 Overview p. 106

6.5.3.2 Resource: UAV Dynamic Information Subscriptions p. 107

6.5.3.2.1 Description p. 107

6.5.3.2.2 Resource Definition p. 107

6.5.3.2.3 Resource Standard Methods p. 107

6.5.3.2.3.1 GET p. 107

6.5.3.2.3.2 POST p. 108

6.5.3.2.4 Resource Custom Operations p. 109

6.5.3.3 Resource: Individual UAV Dynamic Information Subscription p. 109

6.5.3.3.1 Description p. 109

6.5.3.3.2 Resource Definition p. 109

6.5.3.3.3 Resource Standard Methods p. 110

6.5.3.3.3.1 GET p. 110

6.5.3.3.3.2 PUT p. 111

6.5.3.3.3.3 PATCH p. 112

6.5.3.3.3.4 DELETE p. 113

6.5.3.3.4 Resource Custom Operations p. 114

6.5.4 Custom Operations without associated resources p. 114

6.5.5 Notifications p. 114

6.5.5.1 General p. 114

6.5.5.2 UAV Dynamic Information Notification p. 114

6.5.5.2.1 Description p. 114

6.5.5.2.2 Target URI p. 114

6.5.5.2.3 Standard Methods p. 115

6.5.5.2.3.1 POST p. 115

6.5.6 Data Model p. 115

6.5.6.1 General p. 115

6.5.6.2 Structured data types p. 116

6.5.6.2.1 Introduction p. 116

6.5.6.2.2 Type: UAVDynInfoSubsc p. 116

6.5.6.2.3 Type: UAVDynInfoSubscPatch p. 117

6.5.6.2.4 Type: UAVDynInfoNotif p. 117

6.5.6.2.5 Type: ProxRangInfo p. 117

6.5.6.2.6 Type: UavInfo p. 117

6.5.6.3 Simple data types and enumerations p. 118

6.5.6.3.1 Introduction p. 118

6.5.6.3.2 Simple data types p. 118

6.5.6.4 Data types describing alternative data types or combinations of data types p. 118

6.5.6.5 Binary data p. 118

6.5.6.5.1 Binary Data Types p. 118

6.5.7 Error Handling p. 118

6.5.7.1 General p. 118

6.5.7.2 Protocol Errors p. 118

6.5.7.3 Application Errors p. 118

6.5.8 Feature negotiation p. 119

6.5.9 Security p. 119

7 Using Common API Framework p. 120

7.1 General p. 120

7.2 Security p. 120

A (Normative) OpenAPI specification p. 121

A.1 General p. 121

A.2 UAE_C2OperationModeManagement API p. 122

A.3 UAE_RealtimeUAVStatus API p. 129

A.4 UAE_ChangeUSSManagement API |R18| p. 134

A.5 UAE_DAASupport API |R18| p. 143

A.6 UAE_UAVDynamicInfo API |R18| p. 151

B Withdrawn API versions p. 157

B.1 General p. 157

B.2 UAE_C2OperationModeManagement API p. 157

B.3 UAE_RealtimeUAVStatus API p. 157

B.4 UAE_ChangeUSSManagement API |R18| p. 157

B.5 UAE_DAASupport API |R18| p. 157

B.6 UAE_UAVDynamicInfo API |R18| p. 158

$ Change history p. 159