Interface IProdStructWS

Services supporting this interface:
ENOVWSProdStructCpp

Namespace: urn:com:dassault_systemes:ENOVWSProdStructIntf:ENOVWSProdStructIntf_ws:IProdStructWS

Role: Interface for accessing Product Structures.

WSDL Interface Document Relative Path: \resources\wsdl\ENOVWSProdStructIntf\ENOVWSProdStructIntf_ws\IProdStructWS.wsdl

Operation Index

o AddChildPart(): Adds a list of children to a given parent.
o CreatePart(): Creates new Parts with the attribute values passed in and returns successfully created part objects and attributes.
o CutPartInstance(): Cuts an existing Part instance in the assembly.
o DeleteChildPart(): Deletes a list of child Parts passed in iChildIds under the one given Parent which may be a part instance or a product root class.
o DeletePart(): Allows deletion of a Part that is in a deleteable state.
o ExpandProductStructure(): Allows the user to navigate Product Structures that are either configured or unconfigured.
o MovePartInstance(): Allows a part instance to be moved in CATIA due to designed transformation matrix.
o ReplacePart(): Replaces the part reference of an existing part instance in the assembly with the part reference of an object that exists in Enovia.
o UpdatePart(): Updates the attribute values for each Part in iObjects and returns successfully updated parts.
o UpdatePartInstance(): Updates the attribute values for each Part Instance in iObjects.
o VersionPart(): Creates a new version of a Part.

Operations

o AddChildPart(): Adds a list of children to a given parent. The parent can either be Part Instance or ProductRootClass. The children are Part Versions. Any locking requirements will be handled by this service. Synchronization is not addressed.

Name	Type	Direction	Nillable	Description
iParentId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Part Instance or ProductRootClass identifier.
iChildIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	Child Part Version identifiers.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Return instance(s) objects.
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 CreatePart(): Creates new Parts with the attribute values passed in and returns successfully created part objects and attributes. If it is possible that the same web service user will be creating both configured and unconfigured parts the create configured part setting for the ENOVIA user session should be set to unconfigured. If iConfigurable is set to FALSE, and the user's session is setup to create configured parts, then the create(s) will fail. If multiple part versions are passed in iObjects, all will be created using the same iConfigurable value. If any create fails, all fail. A fault will be returned, and no creates will be committed.

Name	Type	Direction	Nillable	Description
iObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	List of Part Versions to be created.
iConfigurable	{http://www.w3.org/2001/XMLSchema}string	in	true	TRUE or FALSE (default of FALSE).
oObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	all the successfully created objects are returned.
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 CutPartInstance(): Cuts an existing Part instance in the assembly. This service will not delete the object. There will be unresolved operations which can be resolved by GetOperations WebService. Enovia equivalent: Cut Part.

Name	Type	Direction	Nillable	Description
iPIParentId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Part Instance or PRC identifier (UUID) of an existing Parent.
iPIChildIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	Part Instance Identifiers (UUID) of existing Children to be Cut.
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 DeleteChildPart(): Deletes a list of child Parts passed in iChildIds under the one given Parent which may be a part instance or a product root class. DeleteChildPart should basically perform a "Cut". In case of an unconfigured assembly, this will be equivalent to a physical delete. Any actions on configured product structure will be done using session effectivity, and will have to be resolved/applied manually via Product Editor and the operations panel. Any synchronization will also have to be done manually. Any locking requirements will be handled by this service. If any attempt to delete fails, a fault is returned and no deletes are committed.

Name	Type	Direction	Nillable	Description
iParentId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Parent part or product identifier.
iChildIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	Child part instance identifiers.
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 DeletePart(): Allows deletion of a Part that is in a deleteable state. Multiple Parts can be deleted in one call. Only parts that have not been instantiated will be deleted. Any locking requirements will be handled by this service. If a part has been instantiated, then all the instances should be deleted before the part can be deleted. If any attempt to delete fails, a fault is returned and no deletes are committed.

Name	Type	Direction	Nillable	Description
iObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	List of identifiers for parts 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 ExpandProductStructure(): Allows the user to navigate Product Structures that are either configured or unconfigured. User can specify a combination of attribute filters and a config handler. The results of this service can also include any document metadata if the user chooses to ask for it. The depth of the expand is defined by input int iDepth. If it is -1, the method will return all levels, a value of zero ( 0 ) will return only the parent identified by iObjectId, and optionally all attached documents per ATTACHMENT_TYPE in iSelect (see CAA Documentation on SelectExpression for details); and an iDepth value of one ( 1 ) will return first level children.

Name	Type	Direction	Nillable	Description
iObjectId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	It can be Product , Part Instance or a GCO.
iSelect	{urn:com:dassault_systemes:PPRGenericWS}SelectExpression	in	true	This SelectExpression is the query language used to communicate the criteria for the expand. Through this parameter, the user can communicate filters (attribute, config) and identify the values needed in result. The structure of SelectExpression is dictated through FilterXML.xsd.
iDepth	{http://www.w3.org/2001/XMLSchema}int	in	false	depth of the structure that needs to be returned (it is -1\|0\|1).
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Result of the expand. The resulting product structure is dictated by ENOVIA.xsd.
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 MovePartInstance(): Allows a part instance to be moved in CATIA due to designed transformation matrix. It updates the matrix in the Enovia. All twelve attributes must be passed in, even if only one is changed. Other Instance attributes will not be updated even if they are provided.

Name	Type	Direction	Nillable	Description
iInstances	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	Data structure with proposed Instance(s) position matrix updated.
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 ReplacePart(): Replaces the part reference of an existing part instance in the assembly with the part reference of an object that exists in Enovia. When replace part reference in an un-configured product, the reference will be replaced throughout the assembly as there are no effectivities on the part. When you replace a part reference with an existing part reference in a configured product, add and cut operations are created for the part and the product specification instance. These operations can be queried by GetOperations service and resolved by ResolveOperations service. The synchronization issue will not be addressed, a Web Service user needs to log on to native LCA to resolve any synchronization issues. Enovia equivalent: Replace Part.

Name	Type	Direction	Nillable	Description
iPIToReplaceId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Part identifier (UUID) in an existing Part Instance whose reference is to be replaced (cut).
iPIReplacementId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true
oReplica	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Output object containing metadata and identifier (uuid) of the part Instance that has the replaced part reference.
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 UpdatePart(): Updates the attribute values for each Part in iObjects and returns successfully updated parts. If any single update fails, a fault is returned and no updates are saved. Any locking requirements will be handled by this service.

Name	Type	Direction	Nillable	Description
iObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	List of Parts to be updated.
oObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing the updated objects.
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 UpdatePartInstance(): Updates the attribute values for each Part Instance in iObjects. Returns successfully updated part instances. If any single update fails, a fault is returned and no updates are saved. Any locking requirements will be handled by this service.

Name	Type	Direction	Nillable	Description
iSessionToken	{urn:com:dassault_systemes:CATJWSInfra}SessionToken	in	true	Active Enovia session Token that caller use for connection to the corresponding Enovia session.
iObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	List of Parts to be updated.
oObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing the updated objects.
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 VersionPart(): Creates a new version of a Part. Also makes them applicable from iApplicabilityDate. Any locking requirements will be handled by this service. Each part must be in a "versionable" state. When a part is versioned using this service - all the instances pointing to the older version will be "out of sync". If any attempt to version fails, a fault is returned and no updates are saved.