Content for TS 29.598 Word version: 18.6.0
5 Services offered by the UDSF
5.1 Introduction
5.2 Nudsf_DataRepository Service
5.3 Nudsf_Timer Service
6 API Definitions
6.1 Nudsf_DataRepository Service API
6.2 Nudsf_Timer Service API
A OpenAPI specification
B Search Examples
B.1 Example Search
B.2 Example AdvancedCounting
C HTTP Multipart Examples
$ Change history
5 Services offered by the UDSF p. 11
5.1 Introduction p. 11
5.2 Nudsf_DataRepository 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 Query p. 12
5.2.2.2.1 General p. 12
5.2.2.2.2 Record Retrieval p. 12
5.2.2.2.3 Meta Retrieval p. 13
5.2.2.2.4 Blocks Retrieval p. 13
5.2.2.2.5 Block Retrieval p. 14
5.2.2.2.6 Search p. 15
5.2.2.2.7 Subscriptions Retrieval p. 15
5.2.2.2.8 Individual Subscription Retrieval p. 16
5.2.2.2.9 Meta Schema Retrieval |R17| p. 16
5.2.2.3 Create p. 17
5.2.2.3.1 General p. 17
5.2.2.3.2 Record Create p. 17
5.2.2.3.3 Block Create p. 17
5.2.2.3.4 Meta Schema Create |R17| p. 18
5.2.2.4 Update p. 18
5.2.2.4.1 General p. 18
5.2.2.4.2 Record Update p. 19
5.2.2.4.3 Block Update p. 19
5.2.2.4.4 Meta Update p. 20
5.2.2.4.5 Subscription Notification Update p. 21
5.2.2.4.6 Subscription Notification Update using PUT p. 21
5.2.2.4.7 Meta Schema Update |R17| p. 22
5.2.2.4.8 Record Partial Update |R18| p. 23
5.2.2.5 Delete p. 23
5.2.2.5.1 General p. 23
5.2.2.5.2 Record Delete p. 24
5.2.2.5.3 Block Delete p. 24
5.2.2.5.4 Meta Schema Delete |R17| p. 25
5.2.2.5.5 Bulk Records Delete |R17| p. 26
5.2.2.6 Notify p. 26
5.2.2.6.1 General p. 26
5.2.2.6.2 Record Expiry Notify p. 26
5.2.2.6.3 Notification due to Data Change p. 27
5.2.2.6.4 Subscription Expiry Notification |R17| p. 27
5.2.2.7 Subscribe p. 28
5.2.2.8 Unsubscribe p. 28
5.3 Nudsf_Timer Service |R17| p. 29
5.3.1 Service Description p. 29
5.3.2 Service Operations p. 29
5.3.2.1 Introduction p. 29
5.3.2.2 Start p. 30
5.3.2.2.1 General p. 30
5.3.2.2.2 Timer Start p. 30
5.3.2.3 Update p. 30
5.3.2.3.1 General p. 30
5.3.2.3.2 Timer Update p. 30
5.3.2.4 Stop p. 31
5.3.2.5 Search p. 32
5.3.2.6 Notify p. 33
5.3.2.6.1 General p. 33
5.3.2.6.2 Timer Expiry Notify p. 33
6 API Definitions p. 34
6.1 Nudsf_DataRepository Service API p. 34
6.1.1 Introduction p. 34
6.1.2 Usage of HTTP p. 34
6.1.2.1 General p. 34
6.1.2.2 HTTP standard headers p. 35
6.1.2.2.1 General p. 35
6.1.2.2.2 Content type p. 35
6.1.2.2.3 Cache-Control p. 35
6.1.2.2.4 ETag p. 35
6.1.2.2.5 If-None-Match p. 35
6.1.2.2.6 If-Match p. 35
6.1.2.2.7 Last-Modified p. 35
6.1.2.2.8 If-Modified-Since p. 36
6.1.2.2.9 When to Use Entity-Tags and Last-Modified Dates p. 36
6.1.2.2.10 Content-Location p. 36
6.1.2.3 HTTP custom headers p. 36
6.1.2.4 HTTP multipart messages p. 36
6.1.2.4.1 General p. 36
6.1.2.4.2 Record p. 36
6.1.2.4.3 BlockCollection p. 37
6.1.2.4.4 RecordNotification p. 37
6.1.2.4.5 RecordPatch |R18| p. 37
6.1.3 Resources p. 38
6.1.3.1 Overview p. 38
6.1.3.2 Resource: RecordCollection (Collection) p. 39
6.1.3.2.1 Description p. 39
6.1.3.2.2 Resource Definition p. 40
6.1.3.2.3 Resource Standard Methods p. 40
6.1.3.3 Resource: Record (Document) p. 42
6.1.3.3.1 Description p. 42
6.1.3.3.2 Resource Definition p. 42
6.1.3.3.3 Resource Standard Methods p. 43
6.1.3.3.3.4 PATCH p. 46
6.1.3.4 Resource: Meta (Document) p. 47
6.1.3.4.1 Description p. 47
6.1.3.4.2 Resource Definition p. 47
6.1.3.4.3 Resource Standard Methods p. 47
6.1.3.5 Resource: BlockCollection (Collection) p. 49
6.1.3.5.1 Description p. 49
6.1.3.5.2 Resource Definition p. 49
6.1.3.5.3 Resource Standard Methods p. 49
6.1.3.6 Resource: Block (Document) p. 50
6.1.3.6.1 Description p. 50
6.1.3.6.2 Resource Definition p. 50
6.1.3.6.3 Resource Standard Methods p. 50
6.1.3.7 Resource: NotificationSubscriptions p. 53
6.1.3.8 Resource: IndividualNotificationSubscription p. 54
6.1.3.8.1 Description p. 54
6.1.3.8.2 Resource Definition p. 54
6.1.3.8.3 Resource Standard Methods p. 54
6.1.3.9 Resource: Meta Schema (Document) |R17| p. 57
6.1.4 Custom Operations without associated resources p. 60
6.1.5 Notifications p. 60
6.1.5.1 General p. 60
6.1.5.2 Timer Expiry Notification p. 60
6.1.5.3 Notification due to Data Change p. 61
6.1.5.4 Subscription Expiry Notification |R17| p. 61
6.1.6 Data Model p. 62
6.1.6.1 General p. 62
6.1.6.2 Structured data types p. 63
6.1.6.2.1 Introduction p. 63
6.1.6.2.2 Type: RecordSearchResult p. 64
6.1.6.2.3 Type: RecordMeta p. 65
6.1.6.2.4 Type: RecordBody p. 65
6.1.6.2.5 Type: Record p. 65
6.1.6.2.6 Type: BlockBody p. 65
6.1.6.2.7 Type: Block p. 65
6.1.6.2.8 Type: SearchCondition p. 66
6.1.6.2.9 SearchComparison p. 66
6.1.6.2.10 Type: NotificationSubscription p. 67
6.1.6.2.11 Type: RecordNotification p. 70
6.1.6.2.12 Type: NotificationDescription p. 70
6.1.6.2.13 Type: SubscriptionFilter p. 71
6.1.6.2.14 Type: ClientId p. 71
6.1.6.2.15 Type: MetaSchema |R17| p. 72
6.1.6.2.16 Type: TagType |R17| p. 72
6.1.6.2.17 Type: RecordIdList |R17| p. 72
6.1.6.2.18 Type: NotificationInfo |R17| p. 72
6.1.6.2.19 Type: CountExpression |R18| p. 73
6.1.6.2.20 Type: TagCount |R18| p. 74
6.1.6.2.21 Type: ValueCount |R18| p. 74
6.1.6.2.22 Type: RecordPatch |R18| p. 75
6.1.6.3 Simple data types and enumerations p. 75
6.1.6.3.1 Introduction p. 75
6.1.6.3.2 Simple data types p. 75
6.1.6.3.3 Enumeration: ComparisonOperator p. 75
6.1.6.3.4 Enumeration: ConditionOperator p. 76
6.1.6.3.5 Enumeration: RecordOperation p. 76
6.1.6.3.6 Enumeration: KeyType |R17| p. 76
6.1.6.3.7 Enumeration: RetrieveRecords |R17| p. 76
6.1.6.3.8 Enumeration: TagCountType |R18| p. 77
6.1.6.4 Data types describing alternative data types or combinations of data types p. 77
6.1.7 Error Handling p. 78
6.1.8 Feature negotiation p. 78
6.1.9 Security p. 79
6.2 Nudsf_Timer Service API |R17| p. 80
6.2.1 Introduction p. 80
6.2.2 Usage of HTTP p. 80
6.2.2.1 General p. 80
6.2.2.2 HTTP standard headers p. 80
6.2.2.2.1 General p. 80
6.2.2.2.2 Content type p. 81
6.2.2.3 HTTP custom headers p. 81
6.2.3 Resources p. 81
6.2.3.1 Overview p. 81
6.2.3.2 Resource: Timers (Store) p. 82
6.2.3.2.1 Description p. 82
6.2.3.2.2 Resource Definition p. 82
6.2.3.2.3 Resource Standard Methods p. 82
6.2.3.3 Resource: Individual Timer (Document) p. 84
6.2.4 Custom Operations without associated resources p. 86
6.2.5 Notifications p. 86
6.2.5.1 General p. 86
6.2.5.2 Timer Expiry Notification p. 87
6.2.6 Data Model p. 87
6.2.6.1 General p. 87
6.2.6.2 Structured data types p. 88
6.2.6.3 Simple data types and enumerations p. 89
6.2.6.3.1 Introduction p. 89
6.2.6.3.2 Simple data types p. 89
6.2.7 Error Handling p. 89
6.2.8 Feature negotiation p. 90
6.2.9 Security p. 90
A (Normative) OpenAPI specification p. 91
B Search Examples p. 136
B.1 Example Search |R18| p. 136
B.2 Example AdvancedCounting |R18| p. 137
C HTTP Multipart Examples p. 139
C.1 General p. 139
C.2 Example HTTP multipart Record p. 139
C.3 Example HTTP multipart BlockCollection p. 139
C.4 Example HTTP multipart RecordNotification p. 140
C.5 Example HTTP multipart RecordPatch |R18| p. 140
$ Change history p. 142
