servicos docs

Webservices Módulo DOC/GED

Documentos

Link base

Descrição do serviço

Os serviços disponíveis permitem a integração com arquivos do repositório CMS e informações do documento, permitindo através dos serviços consultar informações de um documento, efetuar o download de um arquivo, criar e excluir um arquivo.

Documentação do serviço

O acesso a este serviço é realizado utilizando o endereço {GRP}/service/documentos .

Para todos os serviços abaixo deve ser encaminhado a chave de autenticação, que deve ser obtida no serviço Autenticação.

Instrução de consumo e desenvolvimento por terceiros




/listaDocumentoPorNomeArquivo

Descrição do serviço

Permitir consultar documentos através do caminho do arquivo completo e retornar lista de documentos com seus dados.

Devem ser informados os seguintes atributos:
arquivo O caminho absoluto do arquivo criado (caminho + nome arquivo). Formato: Texto.

Como resultado, são retornados as seguintes informações:
numero Número que identifica o documento (PK). Formato: Numérico.
numeroDocumento Número do documento. Formato: Numérico.
identificacao Identificação do documento. Formato: Texto.
titulo Título do documento. Formato: Texto.
tipo Código do tipo de documento Formato: Numérico.
descricaoTipo Descrição do tipo de documento Formato: Texto.
situacao Código da situação. Formato: Numérico.
descricaoSituacao Descrição da situação. Formato: Texto.
autor Código de quem criou o documento. Formato: Numérico.
nome Nome de quem criou o documento Formato: Texto.
exercicio Ano Formato: Texto.
dataDocumento Data de criação do documento. Formato: Data.
dataPublicacao Data da publicação. Formato: Data.
ementa Ementa, texto descritivo. Formato: Texto.
original Formato: Texto.
dataReferencia Data de referência. Formato: Date.
observacao Observação, uma informação extra alem da ementa. Formato: Texto.
arquivo Caminho mais o nome do arquivo completo.Formato: Texto.
local Código do departamento. Formato: Numérico.
nomeLocal Nome do departamento Formato: Texto.
assunto Codigo do assunto. Formato: Numérico.
nomeAssunto Nome do assunto. Formato: Texto.
usuario Código do usuário.Formato: Numérico.
nomeCompleto Nome completo do usuário. Formato: Texto.
ativo Se docuemtno está ativo (null e S= Sim, N= Não) Formato: Texto.
origem Tabela origem que este docuemtno esta vinculado. Formato: Texto.
chaveOrigem Código que referencia a origem que este documento está vinculado. Formato: Texto.




/download

Descrição do serviço

Permite buscar o documento, através do código do documento ou o caminho do arquivo no repositório.

Devem ser informados os seguintes atributos:
codigo Número que identifica o documento. Formato: Numérico.
caminho O caminho absoluto do arquivo criado (caminho + nome arquivo). Formato: Texto.

Como resultado, são retornados as seguintes informações:
codigo Número que identifica o documento. Formato: Numérico.
caminho O caminho do arquivo. Formato: Texto.
nome O nomedo arquivo. Formato: Texto.
conteudo O conteúdo está em base64




/criaDocumento

Descrição do serviço

Permite criar um documento já com sua vinculação a uma origem e arquivo no repositório.

Devem ser informados os seguintes atributos:
tipo Código do tipo de documento Formato: Numérico.
titulo Título do documento. Formato: Texto.
identificacao Identificação do documento. Formato: Texto.
situacao Código da situação. Formato: Numérico.
origem Tabela origem que este docuemtno esta vinculado. Formato: Texto.
arquivo Caminho mais o nome do arquivo completo.Formato: Texto.
conteudoBase64 Conteudo no formato Base64.
observacao Descritivo do documento. Formato: Texto.
exercicio Ano Formato: Texto.
chaveOrigem Código que referencia a origem que este documento está vinculado. Formato: Texto.

Como resultado, são retornados as seguintes informações:
numero Número que identifica o documento (PK). Formato: Numérico.
arquivo Caminho mais o nome do arquivo completo.Formato: Texto.




/removeDocumentoArquivo

Descrição do serviço

Permite excluir o documento.

Devem ser informados os seguintes atributos:
arquivo é o caminho absoluto do arquivo criado. Formato: Texto.