Recommendation ITU-T X.785 (07/2021) Guidelines for defining REST-based managed objects and management interfaces
Summary
History
FOREWORD
Table of Contents
1 Scope
2 References
3 Definitions
     3.1 Terms defined elsewhere
     3.2 Terms defined in this Recommendation
4 Abbreviations and acronyms
5 Conventions
6 Overview of a REST-based management framework
     6.1 Overview
     6.2 Resources
     6.3 Definition languages of REST-based interface
7 Principles for REST-based interface design
8 Definition of a generic managed object using YAML schema
     8.1 REST role in management interfaces
     8.2 Definition of managed objects using JSON/YAML schema
          8.2.1 Definition of a generic managed object class
          8.2.2 Inheritance relationship of managed objects
          8.2.3 Common attributes and data types
          8.2.4 Containment relationship of managed objects
          8.2.5 Association relationship of managed objects
9 Accessing methods for managed objects
     9.1 Generic MO accessing methods
     9.2 Design guidelines for specific MO class accessing methods
          9.2.1 Creating a resource instance
          9.2.2 Reading a group of resource instances by a collection resource
          9.2.3 Reading a specific resource instance
          9.2.4 Updating a complete representation of a specific resource instance
          9.2.5 Updating partial information of a resource instance
          9.2.6 Deleting a resource instance
10 Information modelling guidelines for REST-based interfaces
     10.1 Resource Modeling
     10.2 Attribute
     10.3 Name conventions for MOCs, attributes and data types
     10.4 Other guidelines
11 Compliance and conformance
     11.1 Standards document compliance
     11.2 System conformance
     11.3 Conformance statement guidelines
Annex A  Common REST-based YAML/JSON schema definitions
     A.1 YAML schema definitions for the generic managed object and common data types
     A.2 YAML/JSON schema definitions for common object accessing methods
          A.2.1 createMO operation
          A.2.2 getMOAttributes operation
          A.2.3 setMOAttributes operation
          A.2.4 deleteMO operation
          A.2.5 Complete definitions of the MO access service
Appendix I  An example of REST-based interface definitions for resource
     I.1 An example showing the CRUD definitions for a specific resource
          I.1.1 Creating an "Equipment" resource instance
          I.1.2 Reading a group of "Equipment" resource instances by a collection resource
          I.1.3 Reading a specific "Equipment" resource instance
          I.1.4 Updating a complete representation of a specific "Equipment" resource instance
          I.1.5 Updating partial information of a specific "Equipment" resource
          I.1.6 Deleting an "Equipment" resource
Appendix II  Usage examples of the ContainmentRelationshipType and AssociationRelationType
Appendix III  Background for REST and HTTP technologies
     III.1 Background
     III.2 Short review of REST and HTTP
          III.2.1 REST design principles
          III.2.2 HTTP methods
     III.3 Benefits of introducing REST into network management domain
Bibliography
<\pre>