How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MTN TMF Resource Inventory Management - TMF639

TMF API Reference: TMF639 - Resource Inventory Release : 19.5 - December 2019 Resource Inventory API goal is to provide the ability to manage Resources. Operations Resource Inventory API performs the following operations on the resources : - Retrieve an entity or a collection of entities depending on filter criteria - Partial...

MTN TMF Resource Inventory Management - TMF639 is one of 119 APIs that MTN Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TM Forum, TMF639, Benin, Côte d’Ivoire, and South Sudan. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 11 operations across 8 paths, organized into 3 resource areas, and defines 44 schemas. It is described by OpenAPI 2.0, at version 4.0.0.

Requests are made against the base URL https://api.mtn.com/tmf-api/resourceInventoryManagement/v4.

11 operations 8 paths 44 schemas 2 DELETE2 GET1 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
4.0.0
Base URL
https://api.mtn.com/tmf-api/resourceInventoryManagement/v4
Resource Areas
3

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 2 DELETE, 2 GET, 1 PATCH, 6 POST. They span 3 resource areas: resource, events subscription, notification listeners (client side). Each is listed below with its method, path, parameters, and response codes.

resource 5
GET
/resource
List or find Resource objects
listResource 3 params → 200400401403404405409500
POST
/resource
Creates a Resource
createResource 1 param → 201400401403405409500
GET
/resource/{id}
Retrieves a Resource by ID
retrieveResource 2 params → 200400401403404405409500
PATCH
/resource/{id}
Updates partially a Resource
patchResource 2 params → 200400401403404405409500
DELETE
/resource/{id}
Deletes a Resource
deleteResource 1 param → 204400401403404405409500
events subscription 2
POST
/hub
Register a listener
registerListener 1 param → 201400401403404405409500
DELETE
/hub/{id}
Unregister a listener
unregisterListener 1 param → 204400401403404405500
notification listeners (client side) 4
POST
/listener/resourceCreateEvent
Client listener for entity ResourceCreateEvent
listenToResourceCreateEvent 1 param → 201400401403404405409500
POST
/listener/resourceAttributeValueChangeEvent
Client listener for entity ResourceAttributeValueChangeEvent
listenToResourceAttributeValueChangeEvent 1 param → 201400401403404405409500
POST
/listener/resourceStateChangeEvent
Client listener for entity ResourceStateChangeEvent
listenToResourceStateChangeEvent 1 param → 201400401403404405409500
POST
/listener/resourceDeleteEvent
Client listener for entity ResourceDeleteEvent
listenToResourceDeleteEvent 1 param → 201400401403404405409500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PhysicalResource (27 properties), LogicalResource (24 properties), ResourceRefOrValue (24 properties), Resource (23 properties). Each schema is shown below with its type and property counts.

Addressable
object
Base schema for adressable entities
2 properties
Any
Attachment
object
Complements the description of an element (for instance a product) through video, pictures...
13 properties
AttachmentRef
object
Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures
9 properties 1 required
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
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties 2 required
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties 1 required
Entity
object
Base entity schema for use in TMForum Open-APIs
5 properties
EntityRef
object
Entity reference schema to be use for all entityRef class.
7 properties 1 required
Extensible
object
Base Extensible schema for use in TMForum Open-APIs
3 properties
Feature
object
Configuration feature.
7 properties 2 required
FeatureRelationship
object
Configuration feature
4 properties 2 required
LogicalResource
object
Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in t…
24 properties 2 required
Note
object
Extra information about a given entity
8 properties
PhysicalResource
object
Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.
27 properties 2 required
Place
object
Place reference. Place defines the places where the products are sold or delivered.
6 properties
PlaceRef
object
Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
7 properties 1 required
Quantity
object
An amount in a given unit
2 properties
RelatedParty
object
Related Entity reference. A related party defines party or party role linked to a specific entity.
8 properties 2 required
RelatedPlaceRefOrValue
object
Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @sc…
8 properties 1 required
Resource
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.
23 properties 2 required
Resource_Create
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. Skipped pro…
21 properties 3 required
Resource_Update
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory. Skipped pro…
21 properties 2 required
ResourceAdministrativeStateType
string
ResourceAdministrativeStateType enumerations
ResourceOperationalStateType
string
ResourceOperationalStateType enumerations
ResourceRef
object
7 properties 1 required
ResourceRefOrValue
object
Resource is an abstract entity that describes the common set of attributes shared by all concrete resources. The polymorphic attributes @type, @schemaLocation…
24 properties 2 required
ResourceRelationship
object
Linked resources to the one instantiate, such as [bundled] if the resource is a bundle and you want to describe the bundled resources inside this bundle; [reli…
7 properties 2 required
ResourceSpecificationRef
object
Resources are physical or non-physical components (or some combination of these) within an enterprise's infrastructure or inventory. They are typically consume…
8 properties 1 required
ResourceStatusType
string
ResourceStatusType enumerations
ResourceUsageStateType
string
ResourceUsageStateType enumerations
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties 2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties 1 required
ResourceCreateEvent
object
The notification data structure
10 properties
ResourceCreateEventPayload
object
The event data structure
1 property
ResourceAttributeValueChangeEvent
object
The notification data structure
11 properties
ResourceAttributeValueChangeEventPayload
object
The event data structure
1 property
ResourceStateChangeEvent
object
The notification data structure
10 properties
ResourceStateChangeEventPayload
object
The event data structure
1 property
ResourceDeleteEvent
object
The notification data structure
10 properties
ResourceDeleteEventPayload
object
The event data structure
1 property
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mtn-group-tmf-resourceinventorymanagement-tmf639.yml Raw ↑

Other APIs MTN Group publishes across the network.

MTN Account Decisioning
MTN TMF Customer Bill Management - TMF678
MTN Loans
MTN Subscriber Details
MTN Subscriber Type
MTN Provisioning
MTN Unified Balance V1
MTN Sales Lead
MTN Service Activation and Configuration
MTN Service Ordering
MTN BSS TT OAuth V1
MTN Balance Management V1
Where this information came from

This is an independent, third-party profile of MTN TMF Resource Inventory Management - TMF639, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.