Services and Operations

The interfaces are organized into services that include related operations. The following interfaces are exposed to any client to invoke the services related to the framework. These services can be invoked over two different channels: SOAP over HTTP and SOAP over JMS.

Note: The supported encoding style in the web service request is UTF-8.

All Web Services support HTTP and JMS. Web Services endpoint URL has the following format:

http://<Hostname>:<Port>.

For example, http://localhost:9091/api/aopdService.

The naming convention for SOAP action is /api/<serviceName>.

The naming convention for JMS destination is tibco.aff.<shortnameformodule>.services.<servicenamelowercase>.

For example, tibco.aff.oms.ordersService.

If Automated Order Plan Development is running in collocated mode, the host name is omsServer. If Automated Order Plan Development is running in standalone mode, the hostname is aopd.

The operations specified in the table follow the naming conventions.

Services and Operations Summary
Module Service Operation
Order Management (OM) Order CancelOrder
GetOrderDetails
GetOrders
GetOrderExecutionPlan
GetEnrichedExecutionPlan
SubmitOrder
AmendOrder
SyncSubmitOrder
WithdrawOrder
FetchAuthenticationToken
PerformBulkOrderAction
ActivateOrder
SuspendOrder
HandlePlanItemInError
Purge purgeOrders
getPurgeStatus
getPurgeEstimate
Offline Catalog RequestOfflineCatalog
Purge
Automatic Order Plan Development (AOPD) Automated Order Plan Development generatePartialPlan
generatePlan
Note: For all the web services to work correctly, the data models must be available to Orchestrator and Automatic Order Plan Development components.