Interface IChgMgmtWS

Services supporting this interface:
ENOVWSChgMgmtCpp

Namespace: urn:com:dassault_systemes:ENOVWSChgMgmtIntf:ENOVWSChgMgmtIntf_ws:IChgMgmtWS

Role: Interface for change management.

WSDL Interface Document Relative Path: \resources\wsdl\ENOVWSChgMgmtIntf\ENOVWSChgMgmtIntf_ws\IChgMgmtWS.wsdl

Operation Index

o AddActionLink(): Adds objects as links to the given action.
o AddAffectedObject(): Adds objects manually under a given action.
o AddAssociatedObject(): Associates an Enovia object like Documents, Part version, etc to a given action object and existing Enovia Modification.
o CreateAction(): Creates the specified action(s) and returns the created action(s) Attributes-Values.
o DeleteAction(): Allows deletion of an Action that is in a deleteable state.
o GetActionLinks(): Get Objects linked to the Action by specified link type.
o GetAffectedObjects(): Returns a list of objects that are affected by an Engineering Change/Action.
o GetAssociatedObjects(): Returns a list of configured objects with their attributes-values and uuid of the Enovia object like Documents, Part version etc, that are associated to an Action.
o RemoveAffectedObject(): Removes the links to the objects that are controlled by Action as affected objects.
o RemoveAssociatedObject(): Removes the association of configured objects or Enovia Parts , Documents etc , from a given input action.

Operations

o AddActionLink(): Adds objects as links to the given action. Link types are as defined in Change Management, such as Parent Link, Peer Link, etc.

Name	Type	Direction	Nillable	Description
iSessionToken	{urn:com:dassault_systemes:CATJWSInfra}SessionToken	in	true	The Session Token used to re-establish a server (stateless) session.
iActionId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Identifier of an existing Action
iLinkType	{http://www.w3.org/2001/XMLSchema}string	in	true	The type of link, such as Parent Link or Peer Link.
iObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of identifiers of objects to be linked, by a link of the given type, to the Action.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o AddAffectedObject(): Adds objects manually under a given action. The objects can be attached either as input or as output objects. ECOs are not supported.

Name	Type	Direction	Nillable	Description
iActionId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The identifier of the target action object.
iInputObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of object identifiers of object types ( Documents, Part Version) to be attached as Input Objects.
iOutputObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of object identifiers of object types ( Documents, Part Version) to be attached as Output Objects.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o AddAssociatedObject(): Associates an Enovia object like Documents, Part version, etc to a given action object and existing Enovia Modification. The input object should be configured. This object can be associated with an existing action and modification(s) whose configurable view(s) is/are attached to the input object. Common conditions not supported.

Name	Type	Direction	Nillable	Description
iActionId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Identifier of an existing Action
iObjectId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Identifier of the object to associate
iModIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	Identifiers of the modification with which to associated the object.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation.

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o CreateAction(): Creates the specified action(s) and returns the created action(s) Attributes-Values. The action creation in web services will have similar behaviour as native LCA for e.g.: - An Action ID would be automatically generated.

Name	Type	Direction	Nillable	Description
iActionToBeCreated	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	The action(s) with attributes and values.
oCreatedAction	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	The created action(s).
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o DeleteAction(): Allows deletion of an Action that is in a deleteable state. Multiple Actions can be deleted in one call.

Name	Type	Direction	Nillable	Description
iSessionToken	{urn:com:dassault_systemes:CATJWSInfra}SessionToken	in	true	The Session Token used to re-establish a server
iObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of identifiers for Actions to be deleted.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation.

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o GetActionLinks(): Get Objects linked to the Action by specified link type.

Name	Type	Direction	Nillable	Description
iSessionToken	{urn:com:dassault_systemes:CATJWSInfra}SessionToken	in	true	The Session Token used to re-establish a server
iObjectId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The identifier of the existing Action object.
iSelect	{urn:com:dassault_systemes:PPRGenericWS}SelectExpression	in	true	The select expression can be used to restrict attributes and output objects.
iLinkType	{urn:com:dassault_systemes:CATJWSInfra}stringArrayType	in	true	The type of link, such as Parent Link or Peer Link.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	The list of linked objects.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o GetAffectedObjects(): Returns a list of objects that are affected by an Engineering Change/Action. Manually added objects to an Engineering Change using Enovia or any other external system are also returned. The returned objects are Affected Objects and not the Enovia objects like Parts or Documents. The returned objects will have Attributes-Values of affected objects and the uuid of the Enovia objects like Parts and Documents. The output objects on an Action will be identifiable as Input or Output affected objects.

Name	Type	Direction	Nillable	Description
iObjectId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The identifier of the target EC/Action object.
iSelect	{urn:com:dassault_systemes:PPRGenericWS}SelectExpression	in	true	The select expression can be used to restrict attributes and output objects.
iObjTypes	{urn:com:dassault_systemes:CATJWSInfra}stringArrayType	in	true	Not used -- all affected objects will be returned.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	The list of affected objects.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o GetAssociatedObjects(): Returns a list of configured objects with their attributes-values and uuid of the Enovia object like Documents, Part version etc, that are associated to an Action.

Name	Type	Direction	Nillable	Description
iActionId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Action from which we are to retrieve associated Objects.
iSelect	{urn:com:dassault_systemes:PPRGenericWS}SelectExpression	in	true	Select Expression can restrict object attributes on result.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	The associated objects.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o RemoveAffectedObject(): Removes the links to the objects that are controlled by Action as affected objects. ECOs are not supported.

Name	Type	Direction	Nillable	Description
iActionId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The identifier of the target Action object.
iObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of identifiers of object types (eg., Documents, Part Instance, Part Version, Product) to be removed.
retval	{urn:com:dassault_systemes:PPRGenericWS}Status	out	true	Status of the operation (success or failure).

Name	Type	Description
error	{urn:com:dassault_systemes:CATJWSInfra}CATServiceExceptionType	Raised if an error occurs while processing the request

o RemoveAssociatedObject(): Removes the association of configured objects or Enovia Parts , Documents etc , from a given input action. The actual object is not deleted but the links between the associated object and Action is removed.