newRelationship

Este método possibilita realizar nova associação dentre documentos:

Classe Java
Requisição	web/wwwroot/ws/java/document/NewRelationshipRequestType.java
Retorno	web/wwwroot/ws/java/document/NewRelationshipResponseType.java

Requisição:

Identificador	Requerido	Descrição
DocumentID	X	Identificador do documento.
RevisionID		Identificador da revisão. Caso não informado será utilizado a revisão vigente do documento.
CategoryID	X	Identificador da categoria.
ToAssociate_DocumentID	X	Identificador do documento associado.
ToAssociate_RevisionID		Identificador da revisão do documento associado. Caso não informado será utilizado a revisão vigente do documento.
ToAssociate_CategoryID	X	Identificador da categoria do documento associado.
RelationshipType	X	Tipo de relacionamento: 1 - Documentos relacionados; 2 - Composto de; 3 - Aditivo de contrato; 4 - Contrato do aditivo; 5 - Tradução de documento;
Translate_NotifyConfig		Configuração da notificação de revisão de tradução: 1 - Notificar ao criar revisão; 2 - Notificar ao encerrar revisão;
Contract_UpdateContractValidity		Informar o valor 1 para atualizar a validade do contrato com a validade do aditivo.
Contract_SaveCommonAttributes		Informar o valor 1 salvar atributos em comum do aditivo para o contrato.

Estrutura da requisição:

<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>

Retorno:

Identificador	Descrição
Status	SUCESSO: SUCCESS FALHA: FAILURE
Code	Código apresentado: • 0 - Nenhum erro (registro criado com sucesso); • 1 - Não foi possível encontrar o documento (identificador do documento); • 2 - Valor (valor inserido) inválido para o parâmetro (nome do campo); • 3 - Revisão em aprovação; • 4 - Documento em indexação; • 5 - Documento cancelado; • 6 - Registro já associado; • 7 - O documento relacionado não pode ser do mesmo idioma ou estar relacionado a uma tradução do documento atual; • 8 - O documento não é um aditivo de contrato; • 9 - O respectivo aditivo dessa associação já faz parte de outra estrutura de contrato; • 10 - Categoria não permite relacionamentos de documentos de tradução; • 11 - Campo (nome do campo) não preenchido; • 12 - Não é possível associar uma instância a ela mesma; • 99 - Retorno não esperado pelo sistema.
Detail	Mensagem detalhando o erro ou sucesso na execução do método.