REST API Reference for Oracle Communications Order and Service Management Cloud Native

All REST Endpoints

Client Listeners for Product Orders

Client listener for CancelProductOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/cancelProductOrderCreateEvent
Client listener for CancelProductOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/cancelProductOrderStateChangeEvent
Client listener for ProductOrderAttributeValueChangeEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/productOrderAttributeValueChangeEvent
Client listener for ProductOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/productOrderCreateEvent
Client listener for ProductOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/productOrderStateChangeEvent
Client listener for ReviseProductOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/reviseProductOrderCreateEvent
Client listener for ReviseProductOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/reviseProductOrderStateChangeEvent
Client listener for SuspendProductOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/suspendProductOrderCreateEvent
Client listener for SuspendProductOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/listener/suspendProductOrderStateChangeEvent

Client Listeners for Service Orders

Client listener for CancelServiceOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/cancelServiceOrderCreateEvent
Client listener for CancelServiceOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/cancelServiceOrderStateChangeEvent
Client listener for ReviseServiceOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/reviseServiceOrderCreateEvent
Client listener for ReviseServiceOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/reviseServiceOrderStateChangeEvent
Client listener for ServiceOrderAttributeValueChangeEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/serviceOrderAttributeValueChangeEvent
Client listener for ServiceOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/serviceOrderCreateEvent
Client listener for ServiceOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/serviceOrderStateChangeEvent
Client listener for SuspendServiceOrderCreateEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/suspendServiceOrderCreateEvent
Client listener for SuspendServiceOrderStateChangeEvent: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/listener/suspendServiceOrderStateChangeEvent

Manage Fallout Exception V2

The operations from the Manage Fallout Exception V2 category.

List or find falloutException objects: Method: get
Path: https://serverRoot/fallout/v2.0/falloutException
Retrieve a falloutException by ID: Method: get
Path: https://serverRoot/fallout/v2.0/falloutException/{id}
Submit a falloutAction on the Fallout Exception: Method: post
Path: https://serverRoot/fallout/v2.0/falloutException/{id}/submitFalloutAction
Submit a falloutAction on the Fallout Order: Method: post
Path: https://serverRoot/fallout/v2.0/falloutException/submitFalloutAction

Manage Fallout Exception v1 (Deprecated)

The operations from the Manage Fallout Exception v1 (Deprecated) category.

List or find falloutException objects (Deprecated): Method: get
Path: https://serverRoot/fallout/v1/falloutException
Retrieve a falloutException by ID (Deprecated): Method: get
Path: https://serverRoot/fallout/v1/falloutException/{id}

Manage Product Orders

Abort a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/abortProductOrder/{id}
Cancel a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/cancelProductOrder
Create a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/productOrder
List or find CancelProductOrder objects: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/cancelProductOrder
List or find ProductOrder objects: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/productOrder
List or find ReviseProductOrders objects: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/reviseProductOrder
List or find SuspendProductOrder objects: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/suspendProductOrder
Resume a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/resumeProductOrder/{id}
Retrieve a CancelProductOrder by ID: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/cancelProductOrder/{id}
Retrieve a ProductOrder by ID: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/productOrder/{id}
Retrieve a ReviseProductOrder by ID: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/reviseProductOrder/{id}
Retrieve a SuspendProductOrder by ID: Method: get
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/suspendProductOrder/{id}
Revise a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/reviseProductOrder
Suspend a Product Order: Method: post
Path: https://serverRoot/tmf-api/productOrderingManagement/v4.0.0.1.0/suspendProductOrder

Manage Service Orders

Abort a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/abortServiceOrder/{id}
Cancel a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/cancelServiceOrder
Create a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/serviceOrder
List or find CancelServiceOrder objects: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/cancelServiceOrder
List or find ReviseServiceOrder objects: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/reviseServiceOrder
List or find ServiceOrder objects: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/serviceOrder
List or find SuspendServiceOrder objects: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/suspendServiceOrder
Resume a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/resumeServiceOrder/{id}
Retrieve a CancelServiceOrder by ID: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/cancelServiceOrder/{id}
Retrieve a ReviseServiceOrder by ID: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/reviseServiceOrder/{id}
Retrieve a ServiceOrder by ID: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/serviceOrder/{id}
Retrieve a SuspendServiceOrder by ID: Method: get
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/suspendServiceOrder/{id}
Revise a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/reviseServiceOrder
Suspend a Service Order: Method: post
Path: https://serverRoot/tmf-api/serviceOrdering/v4.1.0.1.0/suspendServiceOrder

OSM Cartridge Assembler

List the CapabilitiesManifest: Method: get
Path: https://serverRoot/cartridgeAssembler/v1/capabilitiesManifest