Tech-
invite
3GPP
space
IETF
RFCs
SIP
Quick
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TR 32.866
Word version: 15.0.0
0…
2…
2
References
3
Definitions, and abbreviations
4
IRP design principles
5
Overview of existing Solution Sets (SS)
6
Alternative Solution Sets (SS)
7
Common principles and design patterns for a RESTful HTTP-based Solution Set (SS)
8
Recommendations
A
About TM Forum REST API specifications
B
Bibliography
$
Change History
2
References
3
Definitions, and abbreviations
Word‑p. 7
3.1
Definitions
3.2
Abbreviations
4
IRP design principles
Word‑p. 8
5
Overview of existing Solution Sets (SS)
6
Alternative Solution Sets (SS)
6.1
RESTful HTTP-based Solution Set (SS)
6.1.1
REST API specification in ETSI NFV SOL 17 [5]
6.1.1.1
API patterns
6.1.1.2
Example specifications
6.1.2
RESTCONF Protocol in IETF RFC 8040 [20]
Word‑p. 9
6.1.3
Mobile Edge Service APIs in ETSI MEC 009 [7]
7
Common principles and design patterns for a RESTful HTTP-based Solution Set (SS)
7.1
Input material
7.2
Short review of REST
7.2.1
REST design principles
7.2.2
Richardson Maturity Model
Word‑p. 10
7.2.3
REST and HTTP
7.3
Short review of HTTP
7.3.1
Message Format
7.3.2
HTTP methods
Word‑p. 11
7.3.2.1
HTTP GET method
7.3.2.2
HTTP HEAD method
7.3.2.3
HTTP POST method
7.3.2.4
HTTP PUT method
7.3.2.5
HTTP DELETE method
7.3.2.6
HTTP CONNECT method
Word‑p. 12
7.3.2.7
HTTP OPTIONS method
7.3.2.8
HTTP TRACE method
7.3.2.9
HTTP PATCH method
7.3.3
HTTP resources
7.3.4
Uniform Resource Identifiers (URIs)
7.3.5
URI Templates
Word‑p. 13
7.4
Usage of HTTP
7.4.1
URI structure
7.4.2
Resource identification
Word‑p. 14
7.4.3
Metadata language for the message body
Word‑p. 15
7.4.3.1
Data transport language
7.4.3.2
Specification language
7.4.3.3
Support for Network Resource Models
Word‑p. 16
7.4.4
Usage of HTTP headers and media types
7.5
Design Patterns
Word‑p. 17
7.5.1
Information model for examples
7.5.2
Design pattern for READ operations (scope: one resource)
Word‑p. 18
7.5.3
Design pattern for READ operations (scope: multiple resource)
7.5.4
Design pattern for UPDATE operations (complete update)
Word‑p. 20
7.5.5
Design pattern for UPDATE operations (partial update)
7.5.6
Design pattern for CREATE operations (single resource)
Word‑p. 21
7.5.7
Design pattern for CREATE operations (multiple resources)
Word‑p. 22
7.5.8
Design pattern for DELETE operations (single resource)
7.5.9
Design pattern for DELETE operations (multiple resources)
Word‑p. 23
7.5.10
Design pattern for SUBSCRIBE/NOTIFY operations
7.5.11
Design pattern for TASK operations
Word‑p. 24
7.5.12
Design pattern for asynchronous operations
Word‑p. 25
7.5.13
Design pattern for scoping and filtering
Word‑p. 27
7.5.14
Design pattern for attribute selection
Word‑p. 28
7.5.15
Design pattern for links
7.5.16
Design pattern for iterations
Word‑p. 31
7.5.16.1
Iteration methods
7.5.16.2
Iteration using header
7.5.16.3
Iteration using query parameters
Word‑p. 32
7.6
Example mapping of IRPs
Word‑p. 33
7.6.1
Mapping of Network Resource Model (NRM) IRPs to resources
7.6.2
Basic CM IRP
7.6.3
Alarm IRP
Word‑p. 34
7.6.3.1
Introduction
7.6.3.2
Richardson Maturity Model Level 0 (The swamp of POX)
7.6.3.3
Richardson Maturity Model Level 1 (Resources)
Word‑p. 35
7.6.3.4
Richardson Maturity Model Level 2
Word‑p. 36
7.7
Example mapping of solution set
Word‑p. 37
7.7.1
Example of defining types
7.7.2
Example of defining managed objects
7.8
REST SS template
Word‑p. 39
8
Recommendations
A
About TM Forum REST API specifications
Word‑p. 40
A.1
REST API design guidelines
A.1.0
Introduction
A.1.1
General concepts
A.1.2
Operations
A.1.3
Media types
A.2
Example TM Forum REST APIs
Word‑p. 41
B
Bibliography
Word‑p. 42
$
Change History
Word‑p. 43