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 agreementSpecification API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

TM Forum agreementSpecification 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 agreementSpecification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 13 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 13 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.

agreementSpecification 5
GET
/agreementSpecification
List or find AgreementSpecification objects
listAgreementSpecification 3 params → 200400401403404405409500
POST
/agreementSpecification
Creates a AgreementSpecification
createAgreementSpecification 1 param → 201400401403405409500
GET
/agreementSpecification/{id}
Retrieves a AgreementSpecification by ID
retrieveAgreementSpecification 2 params → 200400401403404405409500
PATCH
/agreementSpecification/{id}
Updates partially a AgreementSpecification
patchAgreementSpecification 2 params → 200400401403404405409500
DELETE
/agreementSpecification/{id}
Deletes a AgreementSpecification
deleteAgreementSpecification 1 param → 204400401403404405409500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AgreementSpecification (17 properties), AgreementSpecification_Update (15 properties), AgreementSpecification_Create (15 properties), AttachmentRefOrValue (14 properties). Each schema is shown below with its type and property counts.

AgreementSpecification
object
A template of an agreement that can be used when establishing partnerships
17 properties 2 required
AgreementSpecificationRelationship
object
A relationship between agreement specifications. Typical relationships are substitution and dependency.
9 properties
AttachmentRefOrValue
object
An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.
14 properties
AgreementSpecCharacteristic
object
A characteristic quality or distinctive feature of an agreement.
9 properties
AgreementSpecCharacteristicValue
object
A number or text that can be assigned to an agreement specification characteristic.
10 properties
CategoryRef
object
The category for grouping recommendations
8 properties 1 required
Any
Quantity
object
An amount in a given unit
2 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
AgreementSpecification_Update
object
A template of an agreement that can be used when establishing partnerships Skipped properties: id,href
15 properties 2 required
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required
AgreementSpecification_Create
object
A template of an agreement that can be used when establishing partnerships Skipped properties: id,href
15 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs TM Forum publishes across the network.

TM Forum agreement 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
#agreementSpecification
← Back to T APIs
API Details
ID
tm-forum:tm-forum-agreementspecification-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