logo

Overview

The REST API for Service Order Management provides a standardized mechanism for placing a service order with all the necessary order parameters. It allows users to create, update & retrieve Service Orders and manages related notifications.


Version history

v4.2.0

01 Aug 2024 v4.2.0 release The changes are made to reflect the updates done in service resource model to align with TMF638 v4.2 and TMF640 v4.2 updates and also the addition of optional modifyPath attribute in serviceOrderItem.


v4.1.0

20-Dec-2024: v4.1.0 Updates to CTK and RI released: Removed @type mandatory in RelatedParty for TMF641 Service Order. Note: in general v4.x APIs do not mandate @type

28-Nov-2024: Fix released for CTK. The payload within the test cases was adjusted so that the CTK now correctly passes when pointed to the associated RI. The CTK test cases were adjusted to remove the double-quotes (") around the orderDate filter and replaced with single-quotes ('). The URL is now /serviceOrder?orderDate='2024-11-12' to make things easier to read.

07-Nov-2024: TMF641 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.

TMF641

Stable version

v4.1

This Version

v4.1

Types

RESTful

DOMAIN

Service

IPR MODE

Apache 2.0 unless stated

Release Date

01 Jul 2021

API assets v4.1

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 leverage this API either as a Mandatory or Optional API.