TMF763 API Design Guidelines – Part 1 v5.0.0

The “REST API Design Guidelines” document provides guidelines and design patterns used in designing TM Forum REST APIs.

Part One, ‘Practical guidelines for RESTful APIs; naming, CRUD, filtering, notifications’ provides recommendations and guidelines for the design and implementation of Entity CRUD operations and Task operations. It also provides information on filtering and attribute selection. Finally, it provides information on supporting notification management in REST based systems. The uniform contract establishes a set of methods that are expected to be reused by services within a given collection or inventory.