Pular para o conteúdo principal
Versão: 2.2.1

newDocument2

Este método possibilita criar um documento. Para utilizá-lo, é necessário seguir o padrão abaixo documentado.

Classe Java
Requisiçãoweb/wwwroot/ws/java/document/NewDocument2RequestType.java
Retornoweb/wwwroot/ws/java/document/NewDocument2ResponseType.java

Requisição:

IdentificadorRequeridoDescrição
CategoryIdXIdentificador da categoria.
DocumentIDIdentificador do documento.
TitleX¹Título do documento.
SummaryResumo do documento.
DateData do documento. O formato deve ser Y-M-D (Ano-Mês-Dia).
AttributesAtributos do documento:
▪ ID: Identificador do atributo;
▪ Value: Array de valores do atributo:
• Item: Valor do atributo
Obs.: Para atributos com valor numérico, o separador de casas decimais deve ser o "."
Para atributos data, o valor deve ter o formato "Y-M-D" (Ano-Mês-Dia).
ResponsibleUserIDMatrícula do usuário responsável pelo documento.
RevisionMembersParticipantes de revisão:
MemberType: Tipo de participante:
▪ 1 - Usuário;
▪ 2 - Área;
▪ 3 - Função;
▪ 4 - Área/Função;
▪ 5 - Equipe.
MemberID: Identificador do participante. Ex.: Matrícula do usuário para controle por usuário.
STEP: Etapa. Ex.:1,2,3,4
▪ 1 - Elaboração;
▪ 2 - Consenso;
▪ 3 - Aprovação;
▪ 4 - Homologação.

Sequence: Sequência. Ex.:2,2,2,2
Deadline: Prazo em dias. Ex.: 5
TemplateIDIdentificador do arquivo modelo.
▪ 1- Para o arquivo modelo padrão da categoria.
FilesArray de arquivos:
▪ Name: String; Nome do arquivo.
▪ Content: Stream; Binário do arquivo eletrônico².
▪ Container: identificador do Item da estrutura do container.
KeywordsArray de palavra-chave:
▪ KeywordID : String; Identificador da palavra-chave.
LanguageIDIdioma do documento:
1 - Inglês (EUA)
2 - Português (Brasil)
3 - Espanhol
4 - Português (Portugal)
5 - Alemão
6 - Francês (França)
7 - Romeno *
8 - Chinês *
9 - Italiano
10 - Eslovaco *
11 - Inglês (Reino Unido)
12 - Turco *
13 - Francês (Canadá)
14 - Russo *
15 - Polonês *
16 - Catalão
17 - Dinamarquês
18 - Finlandês
19 - Japonês *
RevisionIDIdentificador da revisão
info
  • ¹ - O título será obrigatório se não houver máscara para título na categoria do documento.
  • ² - Conteúdo do arquivo eletrônico convertido em Base64. Se estiver testando a utilização através da fonte de dados web service sugerimos que seja convertido um pequeno texto utilizando algum site de sua preferência.

* Idiomas marcados com asterisco estão disponíveis apenas em base de dados com encoding UTF-8.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newDocument2>
         <!--You may enter the following 13 items in any order-->
         <urn:CategoryID>?</urn:CategoryID>
         <urn:DocumentID>?</urn:DocumentID>
         <urn:Title>?</urn:Title>
         <urn:Summary>?</urn:Summary>
         <urn:Date>?</urn:Date>
         <urn:Attributes>
            <!--0 to 1000 repetitions:-->
            <urn:item>
               <!--You may enter the following 2 items in any order-->
               <urn:ID>?</urn:ID>
               <urn:Values>
                  <!--0 to 1000 repetitions:-->
                  <urn:item>
                     <urn:Value>?</urn:Value>
                  </urn:item>
               </urn:Values>
            </urn:item>
         </urn:Attributes>
         <urn:ResponsibleUserID>?</urn:ResponsibleUserID>
         <urn:RevisionMembers>
            <!--0 to 1000 repetitions:-->
            <urn:item>
               <!--You may enter the following 5 items in any order-->
               <urn:MemberType>?</urn:MemberType>
               <urn:MemberID>?</urn:MemberID>
               <urn:Step>?</urn:Step>
               <urn:Sequence>?</urn:Sequence>
               <urn:Deadline>?</urn:Deadline>
            </urn:item>
         </urn:RevisionMembers>
         <urn:TemplateID>?</urn:TemplateID>
         <urn:Files>
            <!--0 to 1000 repetitions:-->
            <urn:item>
               <!--You may enter the following 3 items in any order-->
               <urn:Name>?</urn:Name>
               <urn:Content>cid:1120385475645</urn:Content>
               <urn:Container>?</urn:Container>
            </urn:item>
         </urn:Files>
         <urn:Keywords>
            <!--0 to 1000 repetitions:-->
            <urn:item>
               <urn:KeywordID>?</urn:KeywordID>
            </urn:item>
         </urn:Keywords>
         <urn:LanguageID>?</urn:LanguageID>
         <urn:RevisionID>?</urn:RevisionID>
      </urn:newDocument2>
   </soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
StatusSUCESSO: SUCCESS
FALHA: FAILURE
CodeCódigo apresentado:
▪ 0 - Nenhum erro (registro criado com sucesso);
▪ 1 - Faltam dados obrigatórios;
▪ 2 - Categoria inexistente;
▪ 3 - Categoria inativa;
▪ 4 - Usuário não tem permissão para incluir na categoria;
▪ 5 - Usuário inexistente;
▪ 6 - A categoria não permite alterar o usuário responsável;
▪ 7 - Atributo requerido não foi preenchido;
▪ 8 - Atributo inexistente;
▪ 9 - Problemas com os valores dos atributos;
▪ 10 - Data inválida;
▪ 11 - Data posterior à data atual;
▪ 12 - Arquivo modelo inválido;
▪ 13 - Categoria não permite múltiplos arquivos;
▪ 14 - Extensão inválida;
▪ 15 - Extensão bloqueada;
▪ 16 - Problemas com o arquivo;
▪ 17 - Palavra-chave inexistente;
▪ 18 - Identificador já existente;
▪ 19 - Categoria não permite incluir documento homologado;
▪ 20 - Problemas ao instanciar workflow;
▪ 21 - Idioma inexistente;
▪ 23 - Erro ao buscar dados da categoria;
▪ 24 - Para salvar o identificador da revisão, o processo da revisão precisa ser ISO9000;
▪ 25 - Não é permitido alterar o identificador de revisões em emissão nessa categoria;
▪ 26 - Revisão deve conter um valor numérico inteiro;
▪ 27 - Revisão deve conter apenas letras;
▪ 28 - A categoria não permite informar ou alterar o identificador;
▪ 29 - A categoria não permite informar ou alterar o título;
▪ 30 - Não é possível informar participantes, pois a categoria está configurada com roteiro fixo;
▪ 99 - Retorno não esperado pelo sistema.
DetailMensagem detalhando o erro ou sucesso na execução do método.
RecordIDSUCESSO: Identificador do documento criado.
FALHA: Vazio.
Última atualização em