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.
Tagged areas include cancelServiceOrder. 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.0.1, at version 5.0.0.
Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.
3 operations2 paths6 schemas2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.1
API Version
5.0.0
Server
https://serverRoot/productCatalogManagement/v5/
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.
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CancelServiceOrder (12 properties), Error (8 properties), ErrorMessage (8 properties), ServiceOrderRef (7 properties). Each schema is shown below with its type and property counts.
ErrorMessage
object
represents an Error
8 properties
Error
object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
CancelServiceOrder
object
Request for cancellation an existing Service order
12 properties
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 properties1 required
CancelServiceOrder_Create
object
Request for cancellation an existing Service order Skipped properties: id,href,state,effectiveCancellationDate,completionMessage,errorMessage
6 properties1 required
TaskStateType
string
Possible values for the state of a task
Specification
The full machine-readable OpenAPI contract behind this narrative.
