10 Engineering Work Order Web Service Reference

This chapter provides information about Oracle Communications MetaSolv Solution (MSS) Engineering Work Order Web Service.

About the Engineering Work Order Web Service

The Engineering Work Order Web Service enables an external system to create and update engineering work orders, and retrieve engineering work order details from MSS. You use the Engineering Work Order Web Service operation for the following actions:

Create Work Order
Update Work Order
Get Work Order
Create Work Order Note
Update Work Order Note
Process DD Supplement
Associate Connection to Work Order
Associate Equipment to Work Order

About the Engineering Work Order Web Service Packaging

The Engineering Work Order Web Service is packaged in the MSS_WebService.ear file, which contains the ewo.war file. When the installer deploys the EAR file, the Engineering Work Order Web Service is automatically deployed and ready to use.

Note:

The MSS_WebService.ear file also includes the other MSS web service operations. See Web Services Overview for information about these operations.

About the Engineering Work Order WSDL, WAR, and Schema Files

The Engineering Work Order Web Service is defined by the EWOAPI.wsdl file and is supported by numerous schema files. The WSDL file and supporting schema files are located in the ewo.war file.

See "Understanding How MSS Defines Web Services" in Web Services Overview for more information about WSDL and WAR files, and about their directory locations in the EAR file.

About Engineering Work Order Schema Files

Several schema files support the Engineering Work Order Web Service. Within ewo.war file, the schema files are located in the WEB-INF/wsdls directory. These schemas are API schemas.

API Schemas

The API schemas contain the high level, field level response and request type definitions and exception definitions.

The Engineering Work Order API schemas are defined in the following files:

EWOInventory.xsd
EWOWorkOrder.xsd
DataTypes.xsd

createWorkOrder Operation

The createWorkOrder operation enables external systems to create engineering work order.

The following are the request and response structures:

Request Structure: createWorkOrder

Response Structure: createWorkOrderResponse

createWorkOrder

The createWorkOrder element contains the input information for the operation. Each row in Table 10-1 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-1 Payload Information for the Request

Name	Defined As	Type Description	File Name
createWorkOrder	element	createWorkOrderRequest	EWOAPI.wsdl
createWorkOrderRequest	element	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

Table 10-2 describes the required fields for createWorkOrder.

Table 10-2 Required Fields

Field Name	Data Type	Field Description
documentNumber	int	A system-assigned identifier for the document number. Value should be zero for creating new order.
status	OrderStatusEnumType	Valid Enumeration values of Order Status Enumeration Type

createWorkOrderResponse

The createWorkOrderResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-3 describes the returned information in the response.

Table 10-3 Payload Information for the Response

Name	Defined As	Type Description	File Name
createWorkOrderResponse	element	createWorkOrderReqResponse	EWOAPI.wsdl
createWorkOrderReqResponse	element	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields^Foot 1	EWOWorkOrder.xsd

^Footnote 1

Refers to the elements, which will have definitions of their own XSD structure. See the schemas to understand the element flow.

associateConnectionToWorkOrder Operation

The associateConnectionToWorkOrder operation enables external systems to associate connection to the passed engineering work order.

The following are the request and response structures:

Request Structure: associateConnectionToWorkOrder

Response Structure: associateConnectionToWorkOrderResponse

associateConnectionToWorkOrder

The associateConnectionToWorkOrder element contains the input information for the operation. Each row in Table 10-4 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-4 Payload Information for the Response

Name	Defined As	Type Description	File Name
associateConnectionToWorkOrder	element	associateConnectionToWorkOrderRequest	EWOAPI.wsdl
associateConnectionToWorkOrderRequest	element	AssociateConnectionToWorkOrderPolicy	EWOInventory.xsd
AssociateConnectionToWorkOrderPolicy	element	AssociateConnectionToWorkOrderPolicy	EWOInventory.xsd
AssociateConnectionToWorkOrderPolicy	ComplexType	ComplexType with a list of fields	EWOInventory.xsd

Table 10-5 describes the required fields for associateConnectionToWorkOrder.

Table 10-5 Required Fields

Field Name	Data Type	Field Description
activityCode	ConnectionActivityCodeEnumType	Activity code for the connection on the work order. Valid Enumeration values of Activity Code Enumeration Type
connectionId	String	The identifier for the connection

associateConnectionToWorkOrderResponse

The associateConnectionToWorkOrderResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-6 describes the returned information in the response.

Table 10-6 Payload Information for the Response

Name	Defined As	Type Description	File Name
associateConnectionToWorkOrderResponse	element	associateConnectionToWorkOrderReqResponse	EWOAPI.wsdl
associateConnectionToWorkOrderReqResponse	element	associateConnectionToWorkOrderReqResponse	EWOInventory.xsd
associateConnectionToWorkOrderReqResponse	ComplexType	orderKey	EWOInventory.xsd

associateEquipmentToWorkOrder Operation

The associateEquipmentToWorkOrder operation enables external systems to associate equipment to the passed engineering work order.

The following are the request and response structures:

Request Structure: associateEquipmentToWorkOrder

Response Structure: associateEquipmentToWorkOrderResponse

associateEquipmentToWorkOrder

The associateEquipmentToWorkOrder element contains the input information for the operation. Each row in Table 10-7 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-7 Payload Information for the Response

Name	Defined As	Type Description	File Name
associateEquipmentToWorkOrder	element	associateEquipmentToWorkOrderRequest	EWOAPI.wsdl
associateEquipmentToWorkOrderRequest	element	AssociateEquipmentToWorkOrderPolicy	EWOInventory.xsd
AssociateEquipmentToWorkOrderPolicy	element	AssociateEquipmentToWorkOrderPolicy	EWOInventory.xsd
AssociateEquipmentToWorkOrderPolicy	ComplexType	ComplexType with a list of fields	EWOInventory.xsd

Table 10-8 describes the required fields for associateEquipmentToWorkOrder.

Table 10-8 Required Fields

Field Name	Data Type	Field Description
activityCode	EquipmentActivityCodeEnumType	Activity code for the equipment on the work order. Valid Enumeration values of Activity Code Enumeration Type
childEquipmentId	String	The equipment ID of the child that needs to be associated.
equipmentId	String	The equipment ID that needs to be associated.

associateEquipmentToWorkOrderResponse

The associateEquipmentToWorkOrderResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-9 describes the returned information in the response.

Table 10-9 Payload Information for the Response

Name	Defined As	Type Description	File Name
associateEquipmentToWorkOrderResponse	element	associateEquipmentToWorkOrderReqResponse	EWOAPI.wsdl
associateEquipmentToWorkOrderReqResponse	element	associateEquipmentToWorkOrderReqResponse	EWOInventory.xsd
associateEquipmentToWorkOrderReqResponse	ComplexType	orderKey	EWOInventory.xsd

createWorkOrderNote Operation

The createWorkOrderNote operation enables external systems to create engineering work order note.

The following are the request and response structures:

Request Structure: createWorkOrderNote

Response Structure: createWorkOrderNoteResponse

createWorkOrderNote

The createWorkOrderNote element contains the input information for the operation. Each row in Table 10-10 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-10 Payload Information for the Response

Name	Defined As	Type Description	File Name
createWorkOrderNote	element	createWorkOrderNoteRequest	EWOAPI.wsdl
createWorkOrderNoteRequest	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

createWorkOrderNoteResponse

The createWorkOrderNoteResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-11 describes the returned information in the response.

Table 10-11 Payload Information for the Response

Name	Defined As	Type Description	File Name
createWorkOrderNoteResponse	element	createWorkOrderNoteReqResponse	EWOAPI.wsdl
createWorkOrderNoteReqResponse	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

updateWorkOrderNote Operation

The updateWorkOrderNote operation enables external systems to update engineering work order note.

The following are the request and response structures:

Request Structure: updateWorkOrderNote

Response Structure: updateWorkOrderNoteResponse

updateWorkOrderNote

The updateWorkOrderNote element contains the input information for the operation. Each row in Table 10-12 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-12 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateWorkOrderNote	element	updateWorkOrderNoteRequest	EWOAPI.wsdl
updateWorkOrderNoteRequest	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

updateWorkOrderNoteResponse

The updateWorkOrderNoteResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-13 describes the returned information in the response.

Table 10-13 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateWorkOrderNoteResponse	element	updateWorkOrderNoteReqResponse	EWOAPI.wsdl
updateWorkOrderNoteReqResponse	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	element	workOrderNote	EWOWorkOrder.xsd
workOrderNote	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

processDDChangeSupplement Operation

The processDDChangeSupplement operation enables external systems to process DD change supplement for engineering work order.

The following are the request and response structures:

Request Structure: processDDChangeSupplement

Response Structure: processDDChangeSupplementResponse

processDDChangeSupplement

The processDDChangeSupplement element contains the input information for the operation. Each row in Table 10-14 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-14 Payload Information for the Response

Name	Defined As	Type Description	File Name
processDDChangeSupplement	element	processDDChangeSupplementRequest	EWOAPI.wsdl
processDDChangeSupplementRequest	ComplexType	workOrder, SuppNote	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd
suppNote	String	Supplement note	EWOWorkOrder.xsd

Table 10-15 describes the required fields for processDDChangeSupplement.

Table 10-15 Required Fields

File Name	Data Type	Field Description
documentNumber	int	A system-assigned identifier for the document number. Value should be zero for creating new order.
status	OrderStatusEnumType	Valid Enumeration values of Order Status Enumeration Type

processDDChangeSupplementResponse

The processDDChangeSupplementResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-16 describes the returned information in the response.

Table 10-16 Payload Information for the Response

Name	Defined As	Type Description	File Name
processDDChangeSupplementResponse	element	processDDChangeSupplementReqResponse	EWOAPI.wsdl
processDDChangeSupplementReqResponse	element	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields^Foot 2	EWOWorkOrder.xsd

^Footnote 2

Refers to the elements, which will have definitions of their own XSD structure. See the schemas to understand the element flow.

updateWorkOrder Operation

The updateWorkOrder operation enables external systems to update engineering work orders.

The following are the request and response structures:

Request Structure: updateWorkOrder

Response Structure: updateWorkOrderResponse

updateWorkOrder

The updateWorkOrder element contains the input information for the operation. Each row in Table 10-17 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-17 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateWorkOrder	element	updateWorkOrderRequest	EWOAPI.wsdl
updateWorkOrderRequest	ComplexType	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields	EWOWorkOrder.xsd

Table 10-18 describes the required fields for updateWorkOrder.

Table 10-18 Required Fields

File Name	Data Type	Field Description
documentNumber	int	A system-assigned identifier for the document number. Value should be zero for creating new order.
status	OrderStatusEnumType	Valid Enumeration values of Order Status Enumeration Type

updateWorkOrderResponse

The updateWorkOrderResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-19 describes the returned information in the response.

Table 10-19 Payload Information for the Response

Name	Defined As	Type Description	File Name
updateWorkOrderResponse	element	updateWorkOrderReqResponse	EWOAPI.wsdl
updateWorkOrderReqResponse	element	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields^Foot 3	EWOWorkOrder.xsd

^Footnote 3

Refers to the elements, which will have definitions of their own XSD structure. See the schemas to understand the element flow.

getWorkOrder Operation

The getWorkOrder operation enables external systems to retrieve engineering work order details.

The following are the request and response structures:

Request Structure: getWorkOrder

Response Structure: getWorkOrderResponse

getWorkOrder

The getWorkOrder element contains the input information for the operation. Each row in Table 10-20 describes the element or type name, the XSD declaration, the type description, and the file name that contains the item's definition.

Table 10-20 Payload Information for the Response

Name	Defined As	Type Description	File Name
getWorkOrder	element	getWorkOrderRequest	EWOAPI.wsdl
getWorkOrderRequest	ComplexType	ComplexType with documentNumber	EWOWorkOrder.xsd

Table 10-21 describes the required fields for getWorkOrder.

Table 10-21 Required Fields

File Name	Data Type	Field Description
Field Name	Data Type	Field Description
documentNumber	int	The document number of the engineering work order that needs to be exported.

getWorkOrderResponse

The getWorkOrderResponse element contains the output information for the operation. The information returned in the response indicates if the operation is successful. Table 10-22 describes the returned information in the response.

Table 10-22 Payload Information for the Response

Name	Defined As	Type Description	File Name
getWorkOrderResponse	element	getWorkOrderReqResponse	EWOAPI.wsdl
getWorkOrderReqResponse	element	workOrder	EWOWorkOrder.xsd
workOrder	element	WorkOrder	EWOWorkOrder.xsd
WorkOrder	ComplexType	ComplexType with a list of fields^Foot 4	EWOWorkOrder.xsd

^Footnote 4

Refers to the elements, which will have definitions of their own XSD structure. See the schemas to understand the element flow.