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 |
PreQualificationFailedReply GetOrderDetails SubmitOrder WithdrawOrder SuspendOrder CancelOrder BulkAction ActivateOrder FeasibilityReply AmendOrder Get Order State Machine XML GetOrderMessages Purge Order GetOrderExecutionPlan SubmitOrderExecutionPlan OpdErrorHandlerReply submitPlanErrorNotification GetOrderExecutionPlan PlanItemSuspendReply MilestoneNotify PlanItemExecuteReply PlanItemErrorHandlerReply PlanItemBulkErrorHandlerReply getplanfragment |
Data Service | plan |
getPlan setPlan |
planItems |
getPlanItems setPlanItems |
|
Catalog Service | Action model | Submit Single Action Model |
Get Bulk Action Model | ||
Submit Bulk Action Model | ||
Delete Bulk Action Model | ||
Get All Action Model | ||
Plan Fragment model | Submit Single PlanFragment Model | |
Get Bulk Plan Fragment Model | ||
Submit Bulk PlanFragment Model | ||
Delete Bulk PlanFragment Model | ||
Get All Plan Fragment Model | ||
Product model | Submit Single Product Model | |
Get Bulk Product Model | ||
Submit Bulk Product Model | ||
Delete Bulk Product Model | ||
Get All Product Model | ||
TM Forum Adapter Service | productOrder | Create, delete, and retrieve a product order |
Authorization Service | User | Create user |
Update user | ||
Get the user details | ||
Delete the user | ||
Tenant | Register tenant | |
Update tenant information | ||
Get tenant information | ||
Delete tenant | ||
Archival Service | Order | GetPlansByCriteria |
GetOrderSummary | ||
GetOrdersByCriteria | ||
getBulkAction | ||
getAllBulkAction | ||
purgeOrder | ||
GetAuditTrail | ||
submitAuditTrail | ||
GetPlanitemByCriteria | ||
GetPieChartDetailsByCriteria | ||
GetPlanDetails | ||
GetOrderDetails | ||
Searches | GetSavedSearches | |
UpdateSavedSearches | ||
SavedSearches | ||
DeleteSavedSearches | ||
Jeopardy Service | Plan |
Purge Plans
This API purges the plans in the final state. |
getPlanInJeopardy | ||
Plan Fragment | Plan Fragment Migration | |
Plan Timeline | Generate plan completion timeline | |
Broker Service | Notifications | Re-send pending notifications |
Re-send all pending notifications | ||
Get pending notifications |