Resource Order Management API

REST API

Overview

The REST API for Resource Order Management. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Resource Orders (including filtering). A Resource Order API provides a standard mechanism for placing a Resource Order with all necessary order parameters.


Version history

v5.0.0

04-Jun-2026 – TMF652 v5.0.0 RC3 Preview release: Open API Specification (OAS), User Guide, Conformance Profile, and Postman Collection. This updated preview includes minor improvements: the @referredType field is now mandatory in the ResourceRef schema to improve interoperability, and outdated references to non-existent fields have been removed from the rules and conformance files to ensure consistency across assets.

20-May-2026 TMF652 v5.0.0 RC1 Preview release: Updated to reflect that fields marked as required in schemas should also be included in response payloads to provide a meaningful representation of the resource for validation and integrations. Be aware that some formerly optional fields are now correctly marked as required in this release.

10-Apr-2026 – TMF652 v5.0.0 RC1 Preview release: Open API Specification (OAS), User Guide, Conformance Profile and Postman collection.

v4.0.0

15 May 2026 – CTK updated date query parameters previously required values to be enclosed in double quotes. This has been corrected — dates are now passed unquoted. 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.

12-Mar-2026 – TMF652 v4.0.0 release: This update includes fixes and minor improvements to the CTK and Reference Implementation. The update corrects the use of a string for a datetime filter parameter, which has now been aligned to the proper ISO 8601 date-time format. README files have also been improved with clearer guidance, including suggested proxy configuration for Docker images to support testing vendor implementations across different networks. The Docker image tag has been incremented from v1.0.0 to v1.0.1 to reflect this patch update.

API No.

TMF652

Stable version

v4.0

This Version

v4.0

Types

RESTful

DOMAIN

Resource

IPR MODE

Apache 2.0 unless stated

Release Date

15 May 2026

API assets v4.0

Swagger

OPEN API SPECIFICATION

Postman collection

Postman collection

API user guide / specification

API USER GUIDE (RAND)

Sample implementation code

Sample implementation code

CTK

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.