TMF630 REST API Design Guidelines 4.2.0

  • Maturity level: Level 4 - Forum Approved
  • Created By: API Project

The “REST API Design Guidelines” document provides guidelines and design patterns used in developing TM Forum REST APIs. The document is organized in seven parts as follow:

  • Part One: Practical guidelines for RESTful APIs naming, CRUD, filtering, notifications
  • Part Two: Advanced guidelines for RESTful APIs polymorphism, extension patterns, depth and expand directive, entity RefOrValue
  • Part Three: Guidelines for extending TMF Open API’s with hypermedia support
  • Part Four: Advanced guidelines for RESTful APIs lifecycle management, common tasks
  • Part Five: JSON Patch extension to manage arrays
  • Part Six: JSON Path extension
  • Part Seven: JSON Schema patterns

General Information

Document series: TMF630
Document version: 4.2.0
Status: TM Forum Approved
Document type: Specifications
Team approved: 02-Apr-2021
IPR mode: RAND
TM Forum Approved: 24-May-2021
Date modified: 25-May-2021
Owner: Alan Pope
ODF Technical: Open APIs