REST over HTTP/HTTPS
REST over HTTP service calls use the standard web services message format. The integration pattern is as follows:
REST over HTTP/HTTPS Integration Pattern
In the REST over HTTP/HTTPS pattern, a service client makes a service call to the Order Management Services component. The service calls the appropriate operation and performs the required operation before sending a reply to the calling application.
The endpoint URLs for REST over HTTP/HTTPS have changed. The new endpoint URLs for respective components are as follows:
Service | EndPoint | Method | Description |
---|---|---|---|
Orchestrator | <protocol>://<host>:<port>/v1/order/preQualificationFailedReply | POST | PreQualificationFailedReply |
<protocol>://<host>:<port>/v1/order | GET | GetOrderDetails | |
<protocol>://<host>:<port>/v1/order | POST | SubmitOrder | |
<protocol>://<host>:<port>/v1/order | DELETE | WithdrawOrder | |
<protocol>://<host>:<port>/v1/order/ suspend | POST | SuspendOrder | |
<protocol>://<host>:<port>/v1/order/cancel | POST | CancelOrder | |
<protocol>://<host>:<port>/v1/order/bulkaction | POST | BulkAction | |
<protocol>://<host>:<port>/v1/order/activate | POST | ActivateOrder | |
<protocol>://<host>:<port>/v1/order/feasibilityReply | POST | FeasibilityReply | |
<protocol>://<host>:<port>/v1/order/amend | POST | AmendOrder | |
<protocol>://<host>:<port>/v1/order/scxml | GET | Get Order State Machine XML | |
<protocol>://<host>:<port>/v1/order/messages | GET | GetOrderMessages | |
<protocol>://<host>:<port>/v1/order/purgeOrder | DELETE | Purge Order | |
<protocol>://<host>:<port>/v1/plan | GET | GetOrderExecutionPlan | |
<protocol>://<host>:<port>/v1/plan | POST | SubmitOrderExecutionPlan | |
<protocol>://<host>:<port>/v1/plan/opd-error-handler-reply | POST | OpdErrorHandlerReply | |
<protocol>://<host>:<port>/v1/plan/error | POST | submitPlanErrorNotification | |
<protocol>://<host>:<port>/v1/plan | GET | GetOrderExecutionPlan | |
<protocol>://<host>:<port>/v1/planitem/suspendreply | POST | PlanItemSuspendReply | |
<protocol>://<host>:<port>/v1/planitem/milestonenotify | POST | MilestoneNotify | |
<protocol>://<host>:<port>/v1/planitem/executionreply | POST | PlanItemExecuteReply | |
<protocol>://<host>:<port>/v1/planitem/errorHandlerreply | POST | PlanItemErrorHandlerReply | |
<protocol>://<host>:<port>/v1/planitem/bulkErrorHandlerreply | POST | PlanItemBulkErrorHandlerReply | |
<protocol>://<host>:<port>/v1/planFragment | GET | getplanfragment | |
Data Service | <protocol>://<host>:<port>/v1/plan | GET | Operation getPlan |
<protocol>://<host>:<port>/v1/plan | POST | Operation setPlan | |
<protocol>://<host>:<port>/v1/planitems | POST | Operation setPlanItem | |
<protocol>://<host>:<port>/v1/planitems/get | POST | Operation getPlanItems | |
Catalog Service | <protocol>://<host>:<port>/v1/actionModel | POST | Operation SubmitActionModel |
<protocol>://<host>:<port>/v1/actionModel/all | GET | Operation gets all action models | |
<protocol>://<host>:<port>/v1/actionModel/bulk | POST | Operation SubmitActionModels | |
<protocol>://<host>:<port>/v1/actionModel/bulk | DELETE | Operation PurgeActionModels | |
<protocol>://<host>:<port>/v1/actionModel/bulk | GET | Operation gets bulk action models | |
<protocol>://<host>:<port>/v1/planfragmentmodel | POST | Operation SubmitPlanFragmentModel | |
<protocol>://<host>:<port>v1/planfragmentmodel/bulk | DELETE | Operation PurgePlanFragmentModels | |
<protocol>://<host>:<port>/v1/planfragmentmodel/all | GET | operation gets all planfragmentmodels | |
<protocol>://<host>:<port>/v1/planfragmentmodel/bulk | GET | operation get bulk planfragmentmodels | |
<protocol>://<host>:<port>/v1/planfragmentmodel/bulk | POST | Operation SubmitPlanFragmentModels | |
<protocol>://<host>:<port>/v1/productmodel | POST | Operation SubmitProductModel | |
<protocol>://<host>:<port>/v1/productmodel/bulk | DELETE | Operation PurgeProductModels | |
<protocol>://<host>:<port>/v1/productmodel/all | GET | operation gets all productmodels | |
<protocol>://<host>:<port>/v1/productmodel/bulk | GET | operation gets bulk productmodels | |
<protocol>://<host>:<port>/v1/productmodel/bulk | POST | Operation SubmitProductModels | |
TM Forum Adapter Service | <protocol>://<host>:<port>/tmf-api/productOrdering/v4/productOrder | POST | Create a product order |
<protocol>://<host>:<port>/tmf-api/productOrdering/v4/productOrder | GET | Retrieve a product order | |
<protocol>://<host>:<port>/tmf-api/productOrdering/v4/productOrder | DELETE | Delete a product order | |
Authorization Service | <protocol>://<host>:<port>/v1/user | GET | Get user |
<protocol>://<host>:<port>/v1/user | POST | Create user | |
<protocol>://<host>:<port>/v1/user | PUT | Update user | |
<protocol>://<host>:<port>/v1/user | DELETE | Delete user | |
<protocol>://<host>:<port>/v1/tenant | GET | Get tenant information | |
<protocol>://<host>:<port>/v1/tenant | POST | Register tenant | |
<protocol>://<host>:<port>/v1/tenant | PUT | Update tenant information | |
<protocol>://<host>:<port>/v1/tenant | DELETE | Delete tenant | |
Jeopardy Service | <protocol>://<host>:<port>/v1/plan | POST |
Purge Plans
This API purges the plans in the final state. |
<protocol>://<host>:<port>/v1/plan | GET | getPlanInJeopardy | |
<protocol>://<host>:<port>/v1/plan | GET | Enrich plan | |
<protocol>://<host>:<port>/v1/plan-fragment | POST | Plan Fragment Migration | |
<protocol>://<host>:<port>/v1/planTimeLine | DELETE | Generate plan completion timeline | |
Archival Service | <protocol>://<host>:<port>/v2/orders/summary | POST | GetOrderSummary |
<protocol>://<host>:<port>/v2/orders/criteria | POST | GetOrdersByCriteria | |
<protocol>://<host>:<port>/v1/orders/bulk-action-job | GET | getBulkAction | |
<protocol>://<host>:<port>/v1/orders/bulk-action-job/all | GET | getAllBulkAction | |
<protocol>://<host>:<port>/v1/orders/purge | DELETE | purgeOrder | |
<protocol>://<host>:<port>/v2/plans/criteria | POST | GetPlanByCriteria | |
<protocol>://<host>:<port>/v1/search | GET | GetSavedSearches | |
<protocol>://<host>:<port>/v1/search | PUT | UpdateSavedSearches | |
<protocol>://<host>:<port>/v1/search | POST | SavedSearches | |
<protocol>://<host>:<port>/v1/search | DELETE | DeleteSavedSearches | |
<protocol>://<host>:<port>/v1/orders/audit | GET | GetAuditTrail | |
<protocol>://<host>:<port>/orders/audit | POST | SubmitAuditTrail | |
<protocol>://<host>:<port>/v2/orders/planItems | GET | GetPlanItemByCriteria | |
<protocol>://<host>:<port>/v2/orders/pieChartDetails | GET | GetPieChartDetailsByCriteria | |
<protocol>://<host>:<port>/v1/plans/detail | GET | GetPlanDetails | |
<protocol>://<host>:<port>/v1/orders/detail | GET | GetOrderDetails | |
Broker Service | <protocol>://<host>:<port>/v1/notifications/re-send | POST | Re-send pending notifications |
<protocol>://<host>:<port>/v1/notifications/re-send/all | POST | Re-trigger all pending notifications | |
<protocol>://<host>:<port>/v1/notifications/pending | GET | Get pending notifications |