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.575 Word version: 18.6.0

1… 4…

4.1 Introduction 4.2 Nadrf_DataManagement Service 4.3 Nadrf_ MLModelManagement Service 5.1 Nadrf_DataManagement Service API 5.2 Nadrf_MLModelManagement Service API A.1 General A.2 Nadrf_DataManagement API A.3 Nadrf_MLModelManagement API

4 Services offered by the ADRF p. 11

4.1 Introduction p. 11

4.2 Nadrf_DataManagement Service p. 12

4.2.1 Service Description p. 12

4.2.1.1 Overview p. 12

4.2.1.2 Service Architecture p. 12

4.2.1.3 Network Functions p. 13

4.2.1.3.1 Analytics Data Repository Function (ADRF) p. 13

4.2.1.3.2 NF Service Consumers p. 13

4.2.2 Service Operations p. 13

4.2.2.1 Introduction p. 13

4.2.2.2 Nadrf_DataManagement_StorageRequest service operation p. 14

4.2.2.2.1 General p. 14

4.2.2.2.2 Request Storage of data or analytics p. 14

4.2.2.3 Nadrf_DataManagement_StorageSubscriptionRequest service operation p. 15

4.2.2.3.1 General p. 15

4.2.2.3.2 Requesting subscription and storage of data or analytics p. 15

4.2.2.4 Nadrf_DataManagement_StorageSubscriptionRemoval service operation p. 16

4.2.2.4.1 General p. 16

4.2.2.4.2 Requesting removal of subscription of data or analytics p. 17

4.2.2.5 Nadrf_DataManagement_RetrievalRequest service operation p. 17

4.2.2.5.1 General p. 17

4.2.2.5.2 Request and get stored data or analytics from ADRF Data Store p. 17

4.2.2.6 Nadrf_DataManagement_RetrievalSubscribe service operation p. 19

4.2.2.6.1 General p. 19

4.2.2.6.2 Requesting retrieval and subscription of data or analytics p. 19

4.2.2.7 Nadrf_DataManagement_RetrievalUnsubscribe service operation p. 20

4.2.2.7.1 General p. 20

4.2.2.7.2 Requesting removal of retrieval subscription for data or analytics p. 20

4.2.2.8 Nadrf_DataManagement_RetrievalNotify service operation p. 21

4.2.2.8.1 General p. 21

4.2.2.8.2 Notification about subscribed data or analytics p. 21

4.2.2.8.3 Notification about data or analytics that are about to be deleted |R18| p. 22

4.2.2.9 Nadrf_DataManagement_Delete service operation p. 23

4.2.2.9.1 General p. 23

4.2.2.9.2 Requesting removal of stored data or analytics p. 23

4.2.2.9.3 Requesting removal of stored data or analytics using data or analytics specification p. 23

4.3 Nadrf_ MLModelManagement Service |R18| p. 24

4.3.1 Service Description p. 24

4.3.1.1 Overview p. 24

4.3.1.2 Service Architecture p. 25

4.3.1.3 Network Functions p. 25

4.3.1.3.1 Analytics Data Repository Function (ADRF) p. 25

4.3.1.3.2 NF Service Consumers p. 25

4.3.2 Service Operations p. 26

4.3.2.1 Introduction p. 26

4.3.2.2 Nadrf_MLModelManagement_StorageRequest service operation p. 26

4.3.2.2.1 General p. 26

4.3.2.2.2 Request Storage of ML model(s) p. 26

4.3.2.2.3 Update Storage of ML model(s) p. 27

4.3.2.3 Nadrf_MLModelManagement_RetrievalRequest service operation p. 28

4.3.2.3.1 General p. 28

4.3.2.3.2 Request and get stored ML model(s) from ADRF ML Model Store p. 28

4.3.2.4 Nadrf_MLModelManagement_Delete service operation p. 29

4.3.2.4.1 General p. 29

4.3.2.4.2 Requesting removal of stored ML model(s) p. 29

4.3.2.4.3 Requesting removal of stored ML model(s) using unique ML model identifier p. 30

5 API Definitions p. 31

5.1 Nadrf_DataManagement Service API p. 31

5.1.1 Introduction p. 31

5.1.2 Usage of HTTP p. 31

5.1.2.1 General p. 31

5.1.2.2 HTTP standard headers p. 31

5.1.2.2.1 General p. 31

5.1.2.2.2 Content type p. 31

5.1.2.3 HTTP custom headers p. 31

5.1.3 Resources p. 32

5.1.3.1 Overview p. 32

5.1.3.2 Resource: ADRF Data Store Records p. 32

5.1.3.2.1 Description p. 32

5.1.3.2.2 Resource Definition p. 32

5.1.3.2.3 Resource Standard Methods p. 33

5.1.3.2.3.1 POST p. 33

5.1.3.2.3.2 GET p. 33

5.1.3.2.4 Resource Custom Operations p. 35

5.1.3.3 Resource: Individual ADRF Data Store Record p. 35

5.1.3.3.1 Description p. 35

5.1.3.3.2 Resource Definition p. 35

5.1.3.3.3 Resource Standard Methods p. 35

5.1.3.3.3.1 DELETE p. 35

5.1.3.3.4 Resource Custom Operations p. 36

5.1.3.4 Resource: ADRF Data Retrieval Subscriptions p. 36

5.1.3.4.1 Description p. 36

5.1.3.4.2 Resource Definition p. 36

5.1.3.4.3 Resource Standard Methods p. 37

5.1.3.4.3.1 POST p. 37

5.1.3.4.4 Resource Custom Operations p. 37

5.1.3.5 Resource: Individual ADRF Data Retrieval Subscription p. 38

5.1.3.5.1 Description p. 38

5.1.3.5.2 Resource Definition p. 38

5.1.3.5.3 Resource Standard Methods p. 38

5.1.3.5.3.1 DELETE p. 38

5.1.3.5.4 Resource Custom Operations p. 39

5.1.4 Custom Operations without associated resources p. 39

5.1.4.1 Overview p. 39

5.1.4.2 Operation: request-storage-sub p. 40

5.1.4.2.1 Description p. 40

5.1.4.2.2 Operation Definition p. 40

5.1.4.3 Operation: request-storage-sub-removal p. 41

5.1.4.3.1 Description p. 41

5.1.4.3.2 Operation Definition p. 41

5.1.4.4 Operation: remove-stored-data-analytics p. 42

5.1.4.4.1 Description p. 42

5.1.4.4.2 Operation Definition p. 42

5.1.5 Notifications p. 43

5.1.5.1 General p. 43

5.1.5.2 Retrieval Notification p. 44

5.1.5.2.1 Description p. 44

5.1.5.2.2 Target URI p. 44

5.1.5.2.3 Standard Methods p. 44

5.1.5.2.3.1 POST p. 44

5.1.5.3 ADRF Alert Notification |R18| p. 45

5.1.5.3.1 Description p. 45

5.1.5.3.2 Target URI p. 45

5.1.5.3.3 Standard Methods p. 45

5.1.6 Data Model p. 46

5.1.6.1 General p. 46

5.1.6.2 Structured data types p. 50

5.1.6.2.1 Introduction p. 50

5.1.6.2.2 Type: NadrfDataStoreRecord p. 50

5.1.6.2.3 Type: NadrfDataStoreSubscription p. 51

5.1.6.2.4 Type: NadrfDataRetrievalSubscription p. 52

5.1.6.2.5 Type: NadrfDataRetrievalNotification p. 53

5.1.6.2.6 Type: NadrfDataStoreSubscriptionRef p. 53

5.1.6.2.7 Type: NadrfStoredDataSpec p. 54

5.1.6.2.8 Type: DataSubscription p. 54

5.1.6.2.9 Type: DataNotification p. 55

5.1.6.2.10 Type: StorageHandlingInfo |R18| p. 55

5.1.6.2.11 Type: NadrfAlertNotification |R18| p. 56

5.1.6.2.12 Type: NadrfAlertNotificationResponse |R18| p. 56

5.1.6.2.13 Type: DataSetTag |R18| p. 56

5.1.6.3 Simple data types and enumerations p. 56

5.1.6.4 Data types describing alternative data types or combinations of data types p. 56

5.1.7 Error Handling p. 56

5.1.7.1 General p. 56

5.1.7.2 Protocol Errors p. 57

5.1.7.3 Application Errors p. 57

5.1.8 Feature negotiation p. 57

5.1.9 Security p. 57

5.2 Nadrf_MLModelManagement Service API |R18| p. 58

5.2.1 Introduction p. 58

5.2.2 Usage of HTTP p. 58

5.2.2.1 General p. 58

5.2.2.2 HTTP standard headers p. 58

5.2.2.2.1 General p. 58

5.2.2.2.2 Content type p. 58

5.2.2.3 HTTP custom headers p. 58

5.2.3 Resources p. 59

5.2.3.1 Overview p. 59

5.2.3.2 Resource: ADRF ML Model Store Records p. 59

5.2.3.2.1 Description p. 59

5.2.3.2.2 Resource Definition p. 59

5.2.3.2.3 Resource Standard Methods p. 60

5.2.3.2.3.1 POST p. 60

5.2.3.2.3.2 GET p. 60

5.2.3.2.4 Resource Custom Operations p. 62

5.2.3.3 Resource: Individual ADRF ML Model Store Record p. 62

5.2.3.3.1 Description p. 62

5.2.3.3.2 Resource Definition p. 62

5.2.3.3.3 Resource Standard Methods p. 62

5.2.3.3.3.1 DELETE p. 62

5.2.3.3.3.2 PUT p. 63

5.2.3.3.4 Resource Custom Operations p. 64

5.2.4 Custom Operations without associated resources p. 64

5.2.4.1 Overview p. 64

5.2.4.4 Operation: remove-stored-mlmodel p. 65

5.2.4.4.1 Description p. 65

5.2.4.4.2 Operation Definition p. 65

5.2.5 Notifications p. 66

5.2.6 Data Model p. 67

5.2.6.1 General p. 67

5.2.6.2 Structured data types p. 67

5.2.6.2.1 Introduction p. 67

5.2.6.2.2 Type: NadrfMLModelStoreRecord p. 68

5.2.6.2.3 Type: MLModelInfo p. 68

5.2.6.2.4 Type: MLModel p. 68

5.2.6.2.5 Type: MLModelDelResult p. 69

5.2.6.2.6 Type: AllowedConsumer p. 69

5.2.6.2.7 Type: ModelStoreResult p. 69

5.2.6.3 Simple data types and enumerations p. 69

5.2.6.3.2 Enumeration: StoreResult p. 69

5.2.6.4 Data types describing alternative data types or combinations of data types p. 70

5.2.7 Error Handling p. 70

5.2.7.1 General p. 70

5.2.7.2 Protocol Errors p. 70

5.2.7.3 Application Errors p. 70

5.2.8 Feature negotiation p. 70

5.2.9 Security p. 70

A (Normative) OpenAPI specification p. 72

A.1 General p. 72

A.2 Nadrf_DataManagement API p. 72

A.3 Nadrf_MLModelManagement API |R18| p. 84

$ Change history p. 91