Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

TM Forum

TM Forum agreement API

The agreement API from TM Forum — 2 operation(s) for agreement.

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum agreement API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include agreement. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 5.0.0.

Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.

5 operations 2 paths 15 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
Resource Areas
1

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

agreement 5
GET
/agreement
List or find Agreement objects
listAgreement 3 params → 200400401403404405409500
POST
/agreement
Creates a Agreement
createAgreement 1 param → 201400401403405409500
GET
/agreement/{id}
Retrieves a Agreement by ID
retrieveAgreement 2 params → 200400401403404405409500
PATCH
/agreement/{id}
Updates partially a Agreement
patchAgreement 2 params → 200400401403404405409500
DELETE
/agreement/{id}
Deletes a Agreement
deleteAgreement 1 param → 204400401403404405409500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Agreement (21 properties), Agreement_Create (19 properties), Agreement_Update (18 properties), AgreementSpecificationRef (8 properties). Each schema is shown below with its type and property counts.

Agreement_Create
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
19 properties 4 required
ProductRef
object
7 properties 1 required
AgreementAuthorization
object
A business participant that is responsible for approving the agreement.
6 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
6 properties 2 required
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
Any
AgreementSpecificationRef
object
AgreementSpecification reference. An AgreementSpecification represents a template of an agreement that can be used when establishing partnerships.
8 properties 1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
ProductOfferingRef
object
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing informati…
7 properties 1 required
Agreement_Update
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
18 properties 4 required
AgreementRef
object
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agre…
7 properties 1 required
Agreement
object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer p…
21 properties 4 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required
AgreementTermOrCondition
object
Aspects of the agreement not formally specified elsewhere in the agreement and that cannot be captured elsewhere in a formal notation, or automatically monitor…
6 properties
AgreementItem
object
A part of the agreement expressed in terms of a product offering and possibly including specific terms and conditions.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-agreement-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreementSpecification API
AE Profile APIs.io
TM Forum billFormat API
AE Profile APIs.io
TM Forum billingAccount API
AE Profile APIs.io
TM Forum billingCycleSpecification API
AE Profile APIs.io
TM Forum billPresentationMedia API
AE Profile APIs.io
TM Forum cancelProductOrder API
AE Profile APIs.io
TM Forum cancelServiceOrder API
AE Profile APIs.io
TM Forum category API
AE Profile APIs.io
TM Forum customer API
AE Profile APIs.io
TM Forum events subscription API
AE Profile APIs.io
TM Forum exportJob API
AE Profile APIs.io
TM Forum financialAccount API
AE Profile APIs.io
#agreement
← Back to T APIs
API Details
ID
tm-forum:tm-forum-agreement-api
Server
https://serverRoot/productCatalogManagement/v5/
Docs
https://www.tmforum.org/resources/specification/tmf620-product-catalog-management-api-rest-specification-r17-5-0/
Provider
TM Forum
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network