Service Inventory Management API

REST API

Overview

The intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.


Version history

v5.1.0

30-Sept-2025 v5.1.0 Preview release: Fixed enum mismatch in examples, added operatingStatusContextUpdate, aligned for RI validation. Open API Specification (OAS), User Guide, Conformance Profile


v5.0.0

08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.

21-Jan-2026 The CTK and RI have been re-released in a dockerized format, this may require different set up requirements and any automation platforms will need to be updated. Click here for more information.

30-Aug-2024 v5.0.0 CTK fixes released


v4.0.0

15-May-2026 – CTK updated docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.

07-Nov-2024 TMF638 v4.0.0 CTK file fix Mac-Linux-RUNCTK.sh modified to remove syntax errors. No impact to awarded Open API Conformance certifications.

API No.

TMF638

Stable version

v5.0

This Version

v5.0

Types

RESTful, Asynchronous

DOMAIN

Service

IPR MODE

Apache 2.0 unless stated

Release Date

08 May 2026

API assets v5.0

Swagger

OPEN API SPECIFICATION

Postman collection

Postman collection

API user guide / specification

API USER GUIDE (RAND)

Sample implementation codeNew

Sample implementation code

CTKNew

CTK

Conformance profile

Conformance Profile (RAND)

Components

ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.