newDocument
Este método possibilita criar um documento. Para utilizá-lo, é necessário seguir o padrão abaixo documentado.
Classe Java | |
---|---|
Requisição | web/wwwroot/ws/java/document/NewDocumentRequestType.java |
Retorno | web/wwwroot/ws/java/document/NewDocumentResponseType.java |
Requisição:
Identificador | Requerido | Descrição |
---|---|---|
IDCATEGORY | X | Identificador da categoria. |
IDDOCUMENT | Identificador do documento. | |
TITLE | X | Título do documento. |
DSRESUME | X | Resumo do documento. |
DTDOCUMENT | Data do documento. O formato deve ser Y-M-D (Ano-Mês-Dia) | |
ATTRIBUTES | Atributos do documento. Exemplo: identificador_do_atributo1=valor_do_atributo1; identificador_do_atributo2=valor_do_atributo2; identificador_do_atributo3=valor_do_atributo3. Exemplo com atributo multivalorado: identificador_do_atributo1=valor1_do_atributo1,valor2* do_atributo1,valor3_do_atributo1. Obs.: Para atributos com valor numérico, o separador de casas decimais deve ser o ’.’. Para campos data, o valor deve ter o formato "Y-M-D" (Ano-Mês-Dia). | |
IDUSER | Usuário responsável pelo documento . | |
PARTICIPANTS | Participantes de revisão:CONTROL : Tipo de controle▪1 - Usuário; ▪ 2 - Área; ▪ 3 - Função; ▪ 4 - Área/Função; ▪ 5 - Equipe. ENTCONTROL : Identificador. Ex.: Matrícula do usuáriopara 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,2QTDEADLINE : Prazo em dias. Ex.: 5 | |
FGMODEL | Identificador do arquivo modelo. ▪ 1- Para o arquivo modelo padrão da categoria | |
FILE | Array de arquivos: ▪ NMFILE : String; Nome do arquivo.▪ BINFILE : Stream; Binário do arquivo eletrônico¹.▪ CONTAINER : identificador do Item da estrutura do container.ERROR : A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco. | |
KEYWORD | Array de palavra-chave:▪KeywordID : String; Identificador da palavra-chave. |
info
¹ - 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.
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:newDocument>
<!--You may enter the following 11 items in any order-->
<urn:idcategory>?</urn:idcategory>
<urn:iddocument>?</urn:iddocument>
<urn:title>?</urn:title>
<urn:dsresume>?</urn:dsresume>
<urn:dtdocument>?</urn:dtdocument>
<urn:attributes>?</urn:attributes>
<urn:iduser>?</urn:iduser>
<urn:participants>
<!--0 to 1000 repetitions:-->
<urn:item>
<!--You may enter the following 5 items in any order-->
<urn:CONTROL>?</urn:CONTROL>
<urn:ENTCONTROL>?</urn:ENTCONTROL>
<urn:STEP>?</urn:STEP>
<urn:SEQUENCE>?</urn:SEQUENCE>
<urn:QTDEADLINE>?</urn:QTDEADLINE>
</urn:item>
</urn:participants>
<urn:fgmodel>?</urn:fgmodel>
<urn:file>
<!--0 to 1000 repetitions:-->
<urn:item>
<!--You may enter the following 4 items in any order-->
<urn:NMFILE>?</urn:NMFILE>
<urn:BINFILE>cid:326079726430</urn:BINFILE>
<urn:CONTAINER>?</urn:CONTAINER>
<urn:ERROR>?</urn:ERROR>
</urn:item>
</urn:file>
<urn:keyword>
<!--0 to 1000 repetitions:-->
<urn:item>
<urn:KeywordID>?</urn:KeywordID>
</urn:item>
</urn:keyword>
</urn:newDocument>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
Identificador | Descrição |
---|---|
return | SUCESSO: 1: ID_DOCUMENTO_CRIADO: Documento criado com sucesso. FALHA: 0: Mensagem com o erro ocorrido. |