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

TM Forum cancelServiceOrder API

The cancelServiceOrder API from TM Forum — 2 operation(s) for cancelserviceorder.

TM Forum cancelServiceOrder API is one of 38 APIs that TM Forum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 6 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.

3 operations 2 paths 6 schemas 2 GET1 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 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

cancelServiceOrder 3
GET
/cancelServiceOrder
List or find CancelServiceOrder objects
listCancelServiceOrder 3 params → 200400401403404405409500
POST
/cancelServiceOrder
Creates a CancelServiceOrder
createCancelServiceOrder body → 201400401403405409500
GET
/cancelServiceOrder/{id}
Retrieves a CancelServiceOrder by ID
retrieveCancelServiceOrder 2 params → 200400401403404405409500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CancelServiceOrder (12 properties), ErrorMessage (8 properties), Error (8 properties), ServiceOrderRef (7 properties). Each schema is shown below with its type and property counts.

Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties 2 required
CancelServiceOrder_Create
object
Request for cancellation an existing Service order Skipped properties: id,href,state,effectiveCancellationDate,completionMessage,errorMessage
6 properties 1 required
ServiceOrderRef
object
Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory
7 properties 1 required
ErrorMessage
object
represents an Error
8 properties
TaskStateType
string
Possible values for the state of a task
CancelServiceOrder
object
Request for cancellation an existing Service order
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tm-forum-cancelserviceorder-api-openapi.yml Raw ↑

Other APIs TM Forum publishes across the network.

TM Forum agreement API
TM Forum agreementSpecification API
TM Forum billFormat API
TM Forum billingAccount API
TM Forum billingCycleSpecification API
TM Forum billPresentationMedia API
TM Forum cancelProductOrder API
TM Forum category API
TM Forum customer API
TM Forum events subscription API
TM Forum exportJob API
TM Forum financialAccount API
Where this information came from

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