Overview

• The TMF651 API provides a standardized mechanism for managing agreements, especially in the context of partnerships between partners.
• The TMF651 API allows the following operations.
  • Creating, updating, and querying of agreement instances.
  • Creating, updating, and querying of agreement specifications, that act as templates for agreement instances.
• Following block diagram provides a high-level overview of how the various components are involved in handling TMF651 API operations (GET, POST, PATCH, and DELETE).
• Using TMF651 API for agreement specification you can perform the following operations.
  • Retrieve the list of agreement specifications from the system
  • Get the agreement specification details
  • Create an agreement specification
  • Update an existing agreement specification
  • Delete an existing agreement specification
• Using TMF651 API for agreements you can perform the following operations.
  • Retrieve the list of agreement instances from the system
  • Get the agreement instance details
  • Create an agreement instance
  • Update an existing agreement instance
  • Delete an existing agreement instance

In general, we can consider the following use cases listed based on the operation you want to perform.

• Use Cases for Agreement Specification
• Use Cases for Agreement

It is assumed that you have completed the following.

• Enabling Access to Industry APIs
• Ensuring that the required licenses and data packs are installed. For more information.

Following block diagram provides a sequence of operations involved.

NOTE:

• For mandatory fields and resource mappings, refer TMF651 Resource Mappings.