Services and Operations
The interfaces are organized into services that include related operations. The following interfaces are exposed for any client to invoke the services related to the framework. These services can be invoked on REST over HTTP channel.
REST Services endpoint URL has the following format:
http://localhost:port
For Example, http://localhost:port/v1/order.
The operations specified in the table follow the naming conventions.
| Module | Service | Operation |
|---|---|---|
| Orchestrator | Order | GetOrderDetails |
| GetOrderExecutionPlan | ||
| SubmitOrder | ||
| WithdrawOrder | ||
| AuditTrail | ||
| PlanItemExecuteResponse | ||
| AmendOrder | ||
| FeasibilityReply | ||
| ActivateOrderRequest | ||
| CancelOrder | ||
| SuspendOrderRequest | ||
| BulkAction | ||
| PlanItemBulkErrorHandler | ||
| PlanItemErrorHandler | ||
| MilestoneNotifyRequest | ||
| PlanItemSuspendResponse | ||
| PreQualificationFailedReply | ||
| Data Service | plan | getPlan |
| setPlan | ||
| planItems | getPlanItems | |
| setPlanItems | ||
| Catalog Service | productmodel | SubmitProductModel |
| productmodels | SubmitProductModels | |
| PurgeProductModels | ||
| planfragmentmodel | SubmitPlanFragmentModel | |
| planfragmentmodels | SubmitPlanFragmentModels | |
| PurgePlanFragmentModels | ||
| actionmodel | SubmitActionModel | |
| actionmodels | SubmitActionModels | |
| PurgeActionModels | ||
| TM Forum Adapter Service | productOrder | Create, delete, and retrieve a product order |
| Authorization Service | Create/Modify User | Create and Modify user |
| Get user | Get the user details | |
| Delete user | Delete the user | |
| Archival Service | Order | getAuditTrailDataForOrder |
| findOrderDetail | ||
| findOrdersByCriteria | ||
| GetOrderSummary | ||
| GetOrdersByCriteria | ||
| Plan | getAuditTrailDataForPlan | |
| getExecutionPlanbyQueryFilter |
Copyright © 2021. Cloud Software Group, Inc. All Rights Reserved.