TM Forum serviceOrder 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 serviceOrder. 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.0.1, at version 5.0.0.
Requests are made against a single base URL, https://serverRoot/productCatalogManagement/v5/.
5 operations2 paths34 schemas1 DELETE2 GET1 PATCH1 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 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.
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.
ExternalReference
object
External reference of the individual or reference in other system
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
8 properties2 required
ServiceOrderJeopardyAlert
object
A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.
10 properties
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
ServiceOrderItemRef
object
7 properties1 required
ServiceOrderItemStateType
string
Possible values for the state of the order item
ServiceOrderItemErrorMessage
object
AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.
9 properties
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
ConstraintRef
object
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
8 properties1 required
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 properties1 required
ServiceStateType
string
Valid values for the lifecycle state of the service
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
FeatureRelationship
object
Configuration feature
4 properties2 required
ServiceOrder
object
27 properties
ServiceOrderMilestone
object
ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.
10 properties
CharacteristicRelationship
object
Another Characteristic that is related to the current Characteristic;
6 properties
ServiceRelationship
object
8 properties1 required
ServiceOrderRelationship
object
Linked service order to the one containing this attribute
7 properties2 required
Any
ServiceOrderItem
object
12 properties3 required
Feature
object
Configuration feature.
7 properties2 required
RelatedServiceOrderItem
object
RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
11 properties
Note
object
Extra information about a given entity
7 properties1 required
ServiceOrderItemRelationship
object
Linked service order item to the one containing this attribute
5 properties
Characteristic
object
Describes a given characteristic of an object or entity through a name/value pair.
8 properties2 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 properties1 required
OrderItemActionType
string
action to be performed on the product
AppointmentRef
object
Refers an appointment, such as a Customer presentation or internal meeting or site visit
7 properties1 required
RelatedParty
object
Related Party reference. A related party defines party or party role linked to a specific entity.
8 properties3 required
ServiceSpecificationRef
object
Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
