Interface ICntMgmtWS

Services supporting this interface:
ENOVWSCntMgmtCpp

Namespace: urn:com:dassault_systemes:ENOVWSCntMgmtIntf:ENOVWSCntMgmtIntf_ws:ICntMgmtWS

Role: Interface for content management.

WSDL Interface Document Relative Path: \resources\wsdl\ENOVWSCntMgmtIntf\ENOVWSCntMgmtIntf_ws\ICntMgmtWS.wsdl

Operation Index

o AttachDocument(): Attaches existing Document to a Part Version or Instance.
o CheckIn(): Puts the given file into the vault, as the primary format of the target Document object.
o CheckOut(): Checks out the document file from the vault.
o CreateDocument(): Creates document revision objects and attribute values based on the incoming data.
o DeleteDocument(): Allows deletion of document revisions that are in a deleteable state.
o ExtractDocument(): Returns the contents of the specified file that is part of the identified Document.
o UpdateDocument(): Updates existing Document objects.
o VersionDocument(): Creates a new version from each Document Revision identified in iObjectIds.

o AttachDocument(): Attaches existing Document to a Part Version or Instance. 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	Parent object identifier.
iDocumentIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	Document Identifier(s).
iAttachType	{http://www.w3.org/2001/XMLSchema}string	in	true	"Representation" or "Documentation".
iDocRole	{http://www.w3.org/2001/XMLSchema}string	in	true	"Primary" or "Secondary".
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 CheckIn(): Puts the given file into the vault, as the primary format of the target Document object. The document file can be a new format, or replace a previously checked-out file.

Name	Type	Direction	Nillable	Description
iDocumentId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The Document revision identifier.
iFileName	{http://www.w3.org/2001/XMLSchema}string	in	true	The desired doc filename.
iVaultName	{http://www.w3.org/2001/XMLSchema}string	in	true	The target vault name (optional, uses default).
iData	{http://www.w3.org/2001/XMLSchema}base64Binary	in	true	Binary document file contents.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing the modified Document file object and attributes.
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 CheckOut(): Checks out the document file from the vault. The returned file can be modified and put back in the vault.

Name	Type	Direction	Nillable	Description
iDocumentId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	Identifier of the Document Revision.
oData	{http://www.w3.org/2001/XMLSchema}base64Binary	in, out	true	Binary document file contents.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing the checked-out document file object and attributes.
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 CreateDocument(): Creates document revision objects and attribute values based on the incoming data. Successfully created documents will be returned in the output. If any attempt to create fails, a fault is returned and no creates are committed.

Name	Type	Direction	Nillable	Description
iObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	Document information to be created (required).
oObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing newly created Document objects and attributes.
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 DeleteDocument(): Allows deletion of document revisions that are in a deleteable state. Multiple documents can be deleted in one call. If the revision is the only revision, the Doc Master will also be deleted. If the document is instantiated, then it cannot be deleted.

Name	Type	Direction	Nillable	Description
iObjectIds	{urn:com:dassault_systemes:PPRGenericWS}IdentifierArrayType	in	true	The identifiers of the document revisions to delete.
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 ExtractDocument(): Returns the contents of the specified file that is part of the identified Document.

Name	Type	Direction	Nillable	Description
iObjectId	{urn:com:dassault_systemes:PPRGenericWS}Identifier	in	true	The identifier of the root Document object (required).
iFormat	{http://www.w3.org/2001/XMLSchema}string	in	true	The mimetype/format of the desired file (required).
iSubFormat	{http://www.w3.org/2001/XMLSchema}string	in	true	The secondary mimetype/format of the desired file (optional).
oData	{http://www.w3.org/2001/XMLSchema}base64Binary	in, out	true	Returned document file binary data.
oResult	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing Document/DocFile business object and attributes.
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 UpdateDocument(): Updates existing Document objects. Updates each document with values passed in the input data structure and returns successfully updated document object attributes in the output. The document does not have to be locked, the web service implementation will handle locking requirements. If any attempt to update fails, a fault is returned and no updates are committed.

Name	Type	Direction	Nillable	Description
iObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in	true	Document information to be updated (required).
oObjects	{urn:com:dassault_systemes:plmdataset:ENOVIA}ENOVIA	in, out	true	Data structure containing updated document objects and attributes.
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 VersionDocument(): Creates a new version from each Document Revision identified in iObjectIds. In the output data structure, all the new version objects are returned. The document does not have to be locked, the web service implementation will handle locking requirements. If any attempt to version fails, a fault is returned and no changes are committed.