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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
TM Forum

TM Forum Service Order API

The Service Order API from TM Forum — 2 operation(s) for service order.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 5 operations across 2 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 4.1.0.

Requests are made against a single base URL, https://serverRoot/tmf-api/serviceOrdering/v4.

5 operations 2 paths 34 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.1.0
Server
https://serverRoot/tmf-api/serviceOrdering/v4
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.

Service Order 5
GET
/serviceOrder
List or find ServiceOrder objects
listServiceOrder 3 params → 200400401403404405409500
POST
/serviceOrder
Creates a ServiceOrder
createServiceOrder body → 201400401403405409500
GET
/serviceOrder/{id}
Retrieves a ServiceOrder by ID
retrieveServiceOrder 2 params → 200400401403404405409500
PATCH
/serviceOrder/{id}
Updates partially a ServiceOrder
patchServiceOrder 1 param body → 200400401403404405409500
DELETE
/serviceOrder/{id}
Deletes a ServiceOrder
deleteServiceOrder 1 param → 204400401403404405409500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ServiceRefOrValue (30 properties), ServiceOrder (27 properties), ServiceOrder_Create (17 properties), ServiceOrder_Update (13 properties). Each schema is shown below with its type and property counts.

OrderItemActionType
string
action to be performed on the product
ServiceOrderItemRef
object
7 properties 1 required
ServiceRefOrValue
object
A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the…
30 properties
ServiceOrder
object
27 properties
Note
object
Extra information about a given entity
7 properties 1 required
ServiceOrderRelationship
object
Linked service order to the one containing this attribute
7 properties 2 required
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties 2 required
RelatedEntityRefOrValue
object
A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to…
8 properties 1 required
Feature
object
Configuration feature.
7 properties 2 required
RelatedParty
object
Related Party reference. A related party defines party or party role linked to a specific entity.
8 properties 3 required
ServiceOrder_Update
object
Skipped properties: id,href,orderDate,jeopardyAlert,errorMessage,milestone,@baseType,@schemaLocation,@type,cancellationDate,cancellationReason,category,complet…
13 properties
ServiceOrderItem
object
12 properties 3 required
ServiceOrder_Create
object
Skipped properties: id,href,orderDate,completionDate,expectedCompletionDate,startDate,state,jeopardyAlert,errorMessage,milestone
17 properties 1 required
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
ResourceRef
object
7 properties 1 required
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
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
ServiceStateType
string
Valid values for the lifecycle state of the service
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
8 properties 1 required
AppointmentRef
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
7 properties 1 required
ServiceOrderItemRelationship
object
Linked service order item to the one containing this attribute
5 properties
FeatureRelationship
object
Configuration feature
4 properties 2 required
ServiceOrderItemErrorMessage
object
AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
9 properties
ServiceOrderMilestone
object
ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.
10 properties
ServiceOrderJeopardyAlert
object
A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
10 properties
ExternalReference
object
External reference of the individual or reference in other system
7 properties 1 required
RelatedServiceOrderItem
object
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
11 properties
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties 1 required
ServiceOrderItemStateType
string
Possible values for the state of the order item
ServiceOrderStateType
string
Possible values for the state of the order
ServiceOrderErrorMessage
object
A ServiceOrderErrorMessage represents an error that causes a status change in a service order.
10 properties
ServiceRelationship
object
8 properties 1 required
Any

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-service-order-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum Agreement API
AE Profile APIs.io
TM Forum Agreement Specification API
AE Profile APIs.io
TM Forum Bill Format API
AE Profile APIs.io
TM Forum Billing Cycle Specification API
AE Profile APIs.io
TM Forum Bill Presentation Media API
AE Profile APIs.io
TM Forum Cancel Product Order API
AE Profile APIs.io
TM Forum Cancel Service Order 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 Individual API
AE Profile APIs.io
TM Forum notification listener API
AE Profile APIs.io
#Service Order
← Back to T APIs
API Details
ID
tm-forum:tm-forum-service-order-api
Server
https://serverRoot/tmf-api/serviceOrdering/v4
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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=tm-forum-service-order-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/tm-forum-service-order-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of TM Forum Service Order API, 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.