Qodex.ai

API ServiceOrdering

Number of APIs: 20

TMF API Reference : TMF 641 - Service Ordering Management

Version 4.0

The Service Order API provides a standardized mechanism for managing Service Order, a type of order which can be used to place an order between internal Customer Order management system to service order management system or between a service provider and a partner and vice versa.

Service Order resource

A service order will describe a list of service order items. A service order item references an action on an existing or future service. By service we designed Customer Facing Service (CFS) as well as Resource Facing Service (RFS). From a component perspective, a service order should be available - from a Service Orchestration Component (and it could mix CFS and RFS) - from an Infrastructure Control & Management component (and it would have only RFS)

TMF641 performs the following operations on service order resource :

  • Retrieval of a service order or a collection of service orders depending on filter criteria
  • Partial update of a service order (including updating rules)
  • Creation of a service order (including default values and creation rules)
  • Deletion of service order (for administration purposes)
  • Notification of events on Service order

Cancel Service Order resource

This resource is used to request a service order cancellation.

TMF641 provides following operations on Cancel Service Order resource :

  • Retrieval of a cancel service order or a collection of cancel service orders
  • Creation of a cancel service order
  • Notification of events on cancel service order.

Copyright © TM Forum 2020. All Rights Reserved

  1. cancel Service Order - List or find CancelServiceOrder objects GET {{baseUrl}}/cancelServiceOrder?fields=deserunt incididunt enim non qui&offset=96994698&limit=96994698

  2. listener - Client listener for entity ServiceOrderJeopardyAlertEvent POST {{baseUrl}}/listener/serviceOrderJeopardyAlertEvent

  3. listener - Client listener for entity ServiceOrderInformationRequiredEvent POST {{baseUrl}}/listener/serviceOrderInformationRequiredEvent

  4. service Order-{id} - Retrieves a ServiceOrder by ID GET {{baseUrl}}/serviceOrder/:id?fields=deserunt incididunt enim non qui

  5. service Order-{id} - Updates partially a ServiceOrder PATCH {{baseUrl}}/serviceOrder/:id

  6. service Order-{id} - Deletes a ServiceOrder DELETE {{baseUrl}}/serviceOrder/:id

  7. service Order - List or find ServiceOrder objects GET {{baseUrl}}/serviceOrder?fields=deserunt incididunt enim non qui&offset=96994698&limit=96994698

  8. service Order - Creates a ServiceOrder POST {{baseUrl}}/serviceOrder

  9. cancel Service Order - Creates a CancelServiceOrder POST {{baseUrl}}/cancelServiceOrder

  10. cancel Service Order - Retrieves a CancelServiceOrder by ID GET {{baseUrl}}/cancelServiceOrder/:id?fields=deserunt incididunt enim non qui