Skip to main content
Version: Next

newRelationship

This method enables new document associations.

Java class
Requestweb/wwwroot/ws/java/document/NewRelationshipRequestType.java
Returnweb/wwwroot/ws/java/document/NewRelationshipResponseType.java

Request:

IDRequiredDescription
DocumentIDXDocument ID #.
RevisionIDRevision ID #.
If not informed, the current revision of the document will be used.
CategoryIDXCategory ID #.
ToAssociate_DocumentIDXID # of the associated document.
ToAssociate_RevisionIDID # of the revision referring to the associated document.
If not informed, the current revision of the document will be used.
ToAssociate_CategoryIDXID # of the category referring to the associated document.
RelationshipTypeXRelationship type:
1 - Related documents;
2 - Composed of;
3 - Contract addendum;
4 - Addendum contract;
5 - Document translation.
Translate_NotifyConfigTranslation revision notification configuration:
1 - Notify when creating the revision;
2 - Notify when closing the revision.
Contract_UpdateContractValidityInsert value 1 to update the validity of the contract with the validity of the addendum contract.
Contract_SaveCommonAttributesInsert value 1 to save attributes in common from the addendum contract to the contract.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newRelationship>
         <!--You may enter the following 10 items in any order-->
         <urn:DocumentID>?</urn:DocumentID>
         <urn:RevisionID>?</urn:RevisionID>
         <urn:CategoryID>?</urn:CategoryID>
         <urn:ToAssociate_DocumentID>?</urn:ToAssociate_DocumentID>
         <urn:ToAssociate_RevisionID>?</urn:ToAssociate_RevisionID>
         <urn:ToAssociate_CategoryID>?</urn:ToAssociate_CategoryID>
         <urn:RelationshipType>?</urn:RelationshipType>
         <urn:Translate_NotifyConfig>?</urn:Translate_NotifyConfig>
         <urn:Contract_UpdateContractValidity>?</urn:Contract_UpdateContractValidity>
         <urn:Contract_SaveCommonAttributes>?</urn:Contract_SaveCommonAttributes>
      </urn:newRelationship>
   </soapenv:Body>
</soapenv:Envelope>

Return:

IDDescription
StatusSUCCESS: SUCCESS
FAILURE: FAILURE
CodeDisplayed code:
• 0 - No error (record created successfully);
• 1 - Document could not be found (document ID #);
• 2 - Value (inserted value) is not valid for the parameter (field name);
• 3 - Revision under approval;
• 4 - Document being indexed;
• 5 - Cancelled document;
• 6 - Record already associated;
• 7 - The related document cannot be in the same language as, or be related to a translation of, the current document;
• 8 - The document is not a contract addendum;
• 9 - The respective addendum of this association is already part of another contract structure;
• 10 - Category does not allow relationships involving translation documents;
• 11 - Field (field name) not inserted;
• 12 - An instance cannot be associated with itself;
• 99 - Return not expected by the system.
DetailMessage detailing the error or success in the execution of the method.
Last updated on