Histórico da Página

createSimpleCardIndex

Criação simples de um formulário.

Método:

createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocumentId: número do formulário.
• publisherId: código do autor.
• documentDescription: descrição.
• cardDescription: nome.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleCardIndexWithDataset

Criação simples de um formulário com datasets.

Método:

createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocumentId: número do formulário.
• publisherId: código do autor.
• documentDescription: descrição.
• cardDescription: nome.
• datasetName: nome do dataset.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleCardIndexWithDatasetPersisteType

Criação simples de um formulário com datasets determinando o tipo da persistência (Formulário ou Lista).

createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa;
• parentDocumentId: número do formulário.
• publisherId: código do autor.
• documentDescription: descrição.
• cardDescription: nome.
• datasetName: nome do dataset.
• attachments: arquivo anexo.
• customEvents: eventos.
• persistenceType: tipo da persistência que será utilizada (0 = Formulário / 1 = Lista).

Retorno: WebServiceMessageArray [] .

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getActiveCardIndex

Retorna o formulário ativo.

Método:

getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.
• colleagueId: número do usuário.

Retorno: DocumentDtoArray [].

getAttachmentsList

Retorna a lista de anexos do formulário.

Método:

getAttachmentsList (String user, String password, int companyId, int documentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.

Retorno: StringArray [], com o nome dos anexos.

getCardIndexContent

Retorna o conteúdo de um formulário.

Método:

getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.
• colleagueId : matrícula do usuário para a verificação de permissão nos formulários.
• version: número da versão do formulário.
• nomeArquivo: nome do arquivo anexo.

Retorno: Uma lista de byte[]. 

getCardIndexesWithoutApprover

Retorna os formulários sem aprovadores que o usuário tenha permissão.

Método:

getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId : matrícula do usuário para a verificação de permissão nos formulários.

Retorno: DocumentDto[].

getCustomizationEvents

Retorna os eventos do formulário.

Método:

getCustomizationEvents (String user, String password, int companyId, int documentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.

Retorno: CardEventDtoArray [].

getFormFields

Retorna os campos do formulário.

Método:

getFormFields(String user, String password, int companyId, int documentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.

Retorno: Lista de String[] com o ID de cada campo do formulário.

updateSimpleCardIndex

Atualização simples do formulário.

Método:

updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.
• publisherId: código do autor.
• cardDescription: nome.
• descriptionField: descrição.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateSimpleCardIndexWithDataset

Atualização simples do formulário com datasets.

Método:

updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do formulário.
• publisherId: código do autor.
• cardDescription: nome.
• descriptionField: descrição.
• datasetName: nome do dataset.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

create

Cria um formulário.

Método:

create(int companyId, String user, String password, CardDto[] carddtos)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• carddtos: formulário que será criado.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

deleteCard

Exclui um formulário e envia para a lixeira.

Método:

deleteCard(int companyId, String user, String password, int cardId)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardId: número do formulário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getCardVersion

Retorna a versão de um formulário.

Método:

getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)

Método:

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• nrDocumentId: número do formulário.
• version: versão do formulário.
• colleagueId: matrícula do usuário.

Retorno: CardDto[], lista com ID do campo e seus valores.

updateCard

Altera os metadados de um formulário.

Método:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardDtos: formulário que será alterado.
• attachs: anexos do formulário.
• docsecurity: segurança do formulário.
• docapprovers: aprovadores do formulário.
• reldocs: documentos relacionados do formulário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateCardData

Altera os campos de um formulário.

Método:

updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardId: número do formulário.
• cardData: campos do formulário que serão alterados.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createCustomFields

Cria um campo customizado.

Método:

createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsDto: campo customizado que será criado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja correto.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getAllCustomField

Retorna todos os campos customizados.

Método:

getAllCustomField(String user, String password, int companyId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: CustomFieldsDto[].

getAllDocumentCustomField

Retorna todos os campos customizados de um documento.

Método:

getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento.
• version: versão do documento.

Retorno: DocumentCustomFieldsDto[].

removeCustomField

Exclui um campo customizado.

Método:

removeCustomField(String user, String password, int companyId, String customFieldsId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsId: código do campo customizado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja correto. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro

removeDocumentCustomField

Exclui um campo customizado de um documento.

Método:

removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsId: código do campo customizado.
• documentId: número do documento.
• version: versão do documento.

Retorno:

Retorno: String, retorna OK caso os parâmetros da requisição esteja correto.

.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

setDocumentCustomFields

Cria ou altera um campo customizado em um documento.

Método:

setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentCustomFieldsDto: documento com campo customizado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja correto. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateCustomFields

Altera um campo customizado.

Método:

updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsDto: campo customizado que será alterado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja correto. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro

findMyDocuments

Retorna os documentos do usuário que precisam ser aprovados.

Método:

findMyDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

findMyDocumentsOnDemand

Retorna os documentos do usuário que precisam ser aprovados, paginados.

Método:

findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: DocumentDto[].

findDocumentsToApprove

Retorna os documentos que o usuário precisa aprovar.

Método:

findDocumentsToApprove(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

findDocumentsToApproveOnDemand

Retorna os documentos que o usuário precisa aprovar, paginados.

Método:

findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: DocumentDto[].

findAgreementDocuments

Retorna os documentos do usuário que estão em consenso.

Método:

findAgreementDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

findCheckoutDocuments

Retorna os documentos do usuário que estão em checkout.

Método:

findCheckoutDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

findCancelledTasks

Retorna as tarefas atribuidas ao usuário que foram canceladas.

Método:

findCancelledTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findCompletedTasks

Retorna as tarefas atribuidas ao usuário que foram finalizadas.

Método:

findCompletedTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findConsensusTasks

Retorna as tarefas atribuidas ao usuário que estão em consenso.

Método:

findConsensusTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findTransferredTasks

Retorna as tarefas atribuidas ao usuário que foram transferidas.

Método:

findTransferredTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findWorkflowTasks

Retorna as tarefas do usuário que estão abertas.

Método:

findWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findWorkflowTasksOnDemand

Retorna as tarefas do usuário que estão abertas, paginadas.

Método:

findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: WorkflowProcessDto[].

findMyRequests

Retorna as solicitações abertas que foram inicializadas pelo usuário.

Método:

findMyRequests(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findMyRequestsOnDemand

Retorna as solicitações abertas que foram inicializadas pelo usuário, paginadas.

Método:

findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: WorkflowProcessDto[].

findMyManagerTasks

Retorna as tarefas gerenciadas pelo usuário.

Método:

findMyManagerTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

findExpiredWorkflowTasks

Retorna as tarefas do usuário que estão em atraso

Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowProcessDto[].

fillStatusTask

Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um usuário.

Método:

fillStatusTask(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: List de int[], com a quantidade de tarefas atrasadas.

fillChronoTasks

Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas ao usuário e não foram finalizadas.

Método:

fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• yearIni: ano inicial.
• yearFin: ano final.
• mounthIni: mês inicial.
• mounthFin: mês final.
• dayIni: dia inicial.
• dayFin: dia final.
• kindTask: tipo da tarefa.

Retorno: : Lista de int[], com a quantidade de tarefas com prazo de conclusão atribuída ao usuário.

fillTypeTasks

Retorna os tipos de tarefas que o usuário possui.

Método:

fillTypeTasks(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: TaskVODto[].

fillTypeTasksOfReplacement

Retorna os tipos de tarefas que o usuário substituto possui.

Método:

fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• replacementId: matrícula do usuário substituto.

Retorno: TaskVODto[].

getOpenTasksByColleagueGroups

Retorna as tarefas atribuídas a um grupo que o usuário participa.

Método:

getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueGroupsOnDemand

Retorna as tarefas atribuídas a um grupo que o usuário participa, paginadas.

Método:

getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueRoles

Retorna as tarefas atribuídas a um papel que o usuário participa.

Método:

getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueRolesOnDemand

Retorna as tarefas atribuidas a um papel workflow que o usuário participa, paginadas.

Método:

getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: WorkflowTaskDto[].

getSummaryRequests

Retorna os contadores de pendências da Home.

Método:

getSummaryRequests(int companyId, String user, String password, String colleagueId)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• colleagueId: matrícula do usuário.

Retorno: HomeRequestSummaryDto[].

Retorna a url do servidor.

Método:

getUrlEcm(long companyId)

Parâmetros:

• companyId: código da empresa.
  
  

approveDocument

Aprova ou reprova documento pendente de aprovação.

Metodo:

approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)

Parâmetros:

• user: código do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: código do documento a ser aprovado.
• version: versão do documento a ser aprovado.
• approverId: código do aprovador
• approved: true se aprova o documento e false caso o documento sera reprovado.
• observation: observação da aprovação ou rejeição.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

copyDocumentToUploadArea

Copia os arquivos (principal e anexos) de um documento para a area de upload do usuário. Isto permite que os documentos tornem-se acessíveis via FTP.

Método:

copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento que será copiado.
• version: versão do documento
• colleagueId: matrícula do usuário cuja área de upload será utilizada

Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createDocument

Cria um documento.

Método:

createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
• attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
• docSecurity: segurança do documento que será publicado  (mais detalhes do parâmetro aqui ).
• docApprovers: aprovadores do documento que será publicado  (mais detalhes do parâmetro aqui ).
• relDocs: documentos relacionados ao documento que será publicado  (mais detalhes do parâmetro aqui ).

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createDocumentWithApprovementLevels

Cria um documento com nível de aprovação.

Método:

createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docDtos: documento que será publicado.
• attachs: arquivo anexado na publicação.
• docSecurity: segurança do documento que será publicado.
• docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos.
• levels: níveis de aprovação que o documento terá.
• relDocs: documentos relacionados ao documento que será publicado.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleDocument

Cria um documento simples.

Método:

createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocumentId: número da pasta pai.
• publisherId: matrícula do usuário que publicará o documento.
• documentDescription: descrição do documento.
• attachments: arquivo anexado na publicação (para utilização via TDS é necessário instanciar a classe Attachment. Confira um exemplo de utilização em Criação de documento a partir do método createSimpleDocument).

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleDocumentPrivate

Cria um documento simples na pasta particular.

Método:

createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)

Parâmetros:

• colleagueId: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocumentId: número da pasta pai.
• documentDescription: descrição do documento.
• attachments: arquivo anexado na publicação.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

deleteDocument

Exclui um documento e o envia para a lixeira.

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento que será excluído.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

destroyDocument

Exclui um documento da lixeira.

Método:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento que será excluído.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

destroyDocumentApproval

Exclui documento pendente de aprovação.

Metodo:

destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)

Parâmetros:

• user: código do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: código do documento a excluido.
• publisherId: código do publicador.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

findMostPopularDocuments

Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso.

Método:

findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• nr_resultados: quantidade de documentos que serão retornados.

Retorno: DocumentDto[].

Atributos de Retorno:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

findMostPopularDocumentsOnDemand

Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso, paginados.

Método:

findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• colleagueId: matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: DocumentDto[].

Atributos de Retorno:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

findRecycledDocuments

Retorna os documentos da lixeira.

Método:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

Atributos de Retorno:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

getActiveDocument

Retorna um documento ativo.

Método:

getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getApprovers

Retorna os aprovadores de um documento.

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• version: número da versão do documento.

Retorno: ApproverWithLevelDto[].

Atributos de Retorno:

• approverType
• colleagueId
• companyId
• documentId
• levelId
• version

getDocumentApprovalHistory

Retorna o histórico de aprovações do documento solicitado.

Metodo:

getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version)

Parâmetros:

• user: código do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: código do documento que se deseja visualizar o status.
• version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).

Retorno: DocumentApprovementHistoryDto[].

Atributos de Retorno:

• colleagueId
• documentVersion
• iterationSequence
• levelId
• movementSequence
• observation
• signed
• status

getDocumentApprovalStatus

Retorna o status do documento com relação a aprovação. O status do documento pode ser:

0 - Aprovado.

1 - Rejeitado.

2- Em aprovação.

Método:

getDocumentApprovalStatus(String user, String password, int companyId, int documentId, int version)

Parâmetros:

• user: código do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: código do documento que se deseja visualizar o status.
• version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).

Retorno: DocumentApprovalStatusDto[].

Atributos de Retorno:

• companyId
• documentId
• status
• version

getDocumentByExternalId

Retorna um documento pelo código externo.

Método:

getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• externalDocumentId: código externo do documento.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getDocumentContent

Retorna o byte do arquivo físico de um documento, caso o usuário tenha permissão para acessá-lo.

Método:

getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• colleagueId: matrícula do usuário.
• documentVersao: número da versão do documento.
• nomeArquivo: nome do arquivo.

Retorno: Lista de byte[].

getDocumentVersion

Retorna a versão de um documento.

Método:

getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• version: número da versão do documento.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

Atributos de Retorno:

• accesCount
• activeVersion
• additionalComments
• allowMuiltiCardsPerUser
• approved
• colleagueId
• companyId
• crc
• createDate
• datasetName
• deleted
• documentDescription
• documentId
• documentType
• documentTypeId
• downloadEnabled
• draft
• expirationDate
• expires
• iconId
• imutable
• indexed
• inheritSecurity
• isEncrypted
• keyWord
• lastModifiedDate
• metaListId
• metaListRecordId
• parentDocumentId
• permissionType
• phisicalFile
• phisicalFileSize
• privateDocument
• protectedCopy
• publisherId
• restrictionType
• rowId
• securityLevel
• topicId
• translated
• UUID
• updateIsoProperties
• userNotify
• validationStartDate
• version
• versionDescription
• volumeId

getRelatedDocuments

Retorna todos os documentos relacionados de um documento.

Método:

getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• version: número da versão do documento.

Retorno: RelatedDocumentDto[].

Atributos de Retorno:

• companyId
• documentId
• relatedDocumentId
• version

getReportSubjectId

Retorna o código do assunto de relatórios dentro do fluig.

Método:

getReportSubjectId(String user, String password, int companyId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: topicId : int.

getSecurity

Retorna a segurança de um documento.

Método:

getSecurity(String user, String password, int company, int nrDocumentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• version: número da versão do documento.

Retorno: DocumentSecurityConfigDto[].

Atributos de Retorno:

• attributionType
• attributionValue
• companyId
• documentId
• permission
• securityLevel
• sequence
• showContent
• version

getUserPermissions

Retorna as permissões do usuário sobre um documento.

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• nrDocumentId: número do documento.
• version: número da versão do documento.

Retorno: Integer, retorna o valor correspondente a permissão..

Atributos de Retorno:

• result

moveDocument

Move documentos para pasta destino.

Método:

moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentIds: lista com os números dos documentos que serão movidos.
• colleagueId: matrícula do usuário com permissão para mover o documento
• destFolder: número da pasta de destino.

Retorno: Lista String[].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

removeSecurity

Remove a segurança de um documento.

Método:

removeSecurity(String user, String password, int companyId, int documentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento.
• version: número da versão do documento.

Retorno: Não há retorno.

restoreDocument

Restaura um documento da lixeira.

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento que será restaurado.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateDocument

Altera um documento.

Método:

updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity,ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
• attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
• docSecurity: segurança do documento que será publicado  (mais detalhes do parâmetro aqui ).
• docApprovers: aprovadores do documento que será publicado  (mais detalhes do parâmetro aqui ).
• relDocs: documentos relacionados ao documento que será publicado  (mais detalhes do parâmetro aqui ).

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateDocumentWithApprovementLevels

Altera um documento com nível de aprovação.

Métodos:

updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[]  docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docDtos: documento que será alterado.
• attachs: arquivo anexado na alteração.
• docSecurity: segurança do documento que será alterado.
• docApprovers: nível de aprovação que os aprovadores do documento estão inseridos.
• levels: níveis de aprovação que o documento terá.
• relDocs: documentos relacionados ao documento que será alterado.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateGroupSecurityType

Modifica o tipo da segurança dos grupos na permissão e na restrição. Existem duas opções que são representadas por um inteiro:

0 - TODOS os usuários dos Grupos.

1 - SOMENTE usuários comuns dos grupos.

Método:

updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId)

Parâmetros:

• user: código do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: código do documento.
• version: versão do documento.
• permissionType: tipo da permissão (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
• restrictionType: tipo da restrição (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
• colleagueId: matrícula do usuário

Retorno: WebServiceMessage[]  WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateSimpleDocument

Altera de forma simples um documento.

Método:

updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)

Parâmetros:

• username: login do usuário de integração.
• password: senha do usuário de integração.
• companyId: código da empresa.
• documentId: número do documento que será alterado.
• publisherId: matrícula do usuário que realizará a alteração do documento.
• documentDescription: descrição do documento.
• attachments: arquivos anexados na alteração.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

validateIntegrationRequirements

Verifica a integração do usuário no fluig.

Método:

validateIntegrationRequirements (String user, String password, int companyId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: String WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

addDocumentToFavorites

Adiciona um documento aos favoritos do usuário informado.

Método:

addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao,  String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocument: número do documento
• nrVersao: versão do documento
• colleagueId : matrícula do usuário.

Retorno: void.

addProcessToFavorites

Adiciona um processo aos favoritos do usuário informado.

Método:

addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• processId: código do processo
• colleagueId : matrícula do usuário.

findFavorites

Retorna os documentos favoritos do usuário.

Método:

findFavorites(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId : matrícula do usuário.

Retorno: DocumentDto[].

findFavoritesOnDemand

Retorna os documentos favoritos do usuário, paginados.

Método:

findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId : matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: DocumentDto[].

findFavoritesProcess

Retorna os processos favoritos do usuário.

Método:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId : matrícula do usuário.

Retorno: ProcessDefinitionVersionDto[] .

findFavoritesProcessOnDemand

Retorna os processos favoritos do usuário, paginados.

Método:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId : matrícula do usuário.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.

Retorno: ProcessDefinitionVersionDto[] .

isFavoriteDocument

Verifica se documento é favorito.

Método:

isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId)

Parâmetros:

• username: login do usuário de integração.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocument: código do documento.
• colleagueId: matricula do usuário.

Retorno: Boolean, documento favoritado.

removeFavoriteDocument

Remove um documento dos favoritos do usuário informado.

Método:

removeFavoriteDocument (String username, String password, int companyId, int nrDocument,  String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocument: número do documento
• colleagueId : matrícula do usuário.

Retorno: void.

removeFavoriteProcess

Remove um processo dos favoritos do usuário informado.

Método:

addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• processId: código do processo.
• colleagueId : matrícula do usuário.

Retorno: void.

createFolder

Cria uma pasta.

Método:

createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docdtos: pasta que será criada.
• docsecurity: segurança da pasta.
• docapprovers: aprovadores da pasta.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createFolderWithApprovementLevels

Cria uma pasta com nível de aprovação.

Método:

createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docdtos: pasta que será criada.
• docsecurity: segurança da pasta.
• docapprovers: aprovadores em níveis.
• levels: níveis de aprovação da pasta.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleFolder

Cria uma pasta simples.

Método:

createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocumentId: número do documento pai.
• publisherId: matrícula do usuário publicador.
• documentDescription: descrição da pasta.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

deleteDocument

Exclui uma pasta e envia para a lixeira.

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

destroyDocument

Exclui uma pasta da lixeira.

Método:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

findRecycledDocuments

Retorna todos os documentos da lixeira de um usuário.

Método:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getApprovers

Retorna os aprovadores de uma pasta.

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número da pasta.

Retorno: ApproverWithLevelDto[].

getChildren

Retorna todos os documentos de uma pasta.

Método:

getChildren(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getFolder

Retorna uma pasta.

Método:

getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número da pasta.
• colleagueId: matrícula do usuário origem.

Retorno: DocumentDto[].

getPrivateChildren

Retorna todos os documentos de uma pasta particular.

Método:

getPrivateChildren(String user, String password, int companyId, int parentDocumentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.

Retorno: DocumentDto[].

getRootFolders

Retorna as pastas root que um usuário tem acesso, exceto a pasta particular.

Método:

getRootFolders(String user, String password, int companyId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getSecurity

Retorna a segurança de uma pasta.

Método:

getSecurity(String user, String password, int companyId, int nrDocumentId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número da pasta.

Retorno: DocumentSecurityConfigDto[].

getSubFolders

Retorna todas as subpastas e arquivos de um pasta.

Método:

getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getSubFoldersOnDemand

Retorna todas as subpastas e arquivos de uma pasta, paginados.

Método:

getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• documentId: número da pasta.
• privatefolder: identifica se é uma pasta particular.
• documenttypes: tipos de documentos das pastas.
• limit: número de registros a serem retornados.
• lastRowId: última linha retornada.
• colleagueId: matrícula do usuário.

Retorno: DocumentDto[].

getSubFoldersPermission

Retorna todas as subspastas em que o usuário tenha a permissão informada.

Método:

getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta particular.
• colleagueId: matrícula do usuário.
• permission: permissão sobre a pasta.

Retorno: DocumentDto[].

getSubPrivateFolders

Retorna todas as subpastas de uma pasta particular.

Método:

getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)

Parâmetros:

• colleagueId: matrícula do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta particular.

Retorno: DocumentDto[].

getUserPermissions

Retorna a permissão de um usuário sobre uma pasta.

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

Parâmetros:

• companyId: código da empresa.
• user: matrícula do usuário.
• nrDocumentId: número da pasta.
• version: versão da pasta.

Retorno: Integer, referente ao nível de permissão do usuário.

restoreDocument

Restaura uma pasta da lixeira.

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número da pasta.
• colleagueId: matrícula do usuário.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateFolder

Altera uma pasta.

Método:

updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docdtos: pasta que será alterada.
• docsecurity: segurança da pasta.
• docapprovers: aprovadores da pasta.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateFolderWithApprovementLevels

Altera uma pasta com nível de aprovação.

Método:

updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docdtos: pasta que será alterada.
• docsecurity: segurança da pasta.
• docapprovers: aprovadores em níveis.
• levels: níveis de aprovação da pasta.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateSimpleFolder

Altera de forma simples uma pasta.

Método:

updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)

Parâmetros:

• user: login do usuário
• password: senha do usuário
• companyId: código da empresa
• docdtos: pasta que será alterada.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

createSimpleReport

Cria um relatório de maneira simplificada no fluig.

Método:

createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• parentDocId: código da pasta pai.
• reportDescription: descrição do relatório.
• attachments: anexos do relatório.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getActiveReport

Retorna um relatório ativo no fluig.

Método:

getActiveReport(int companyId, String username, String password, String documentId)

Parâmetros:

• companyId: código da empresa.
• username: login do usuário.
• password: senha do usuário.
• documentId: código do documento.

Retorno: DocumentDto.

getAttachmentsList

Retorna uma lista de anexos do relatório no fluig.

Método:

getAttachmentsList(String username, String password, int companyId, String documentId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: código do documento.

Retorno: Retorna lista de String[], com nome dos anexos.

getReportContent

Retorna o arquivo físico de um relatório.

Método:

getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• nrDocumentId: número do documento.
• colleagueId: matrícula do usuário.
• documentoVersao: versão do documento.
• fileName: nome do arquivo.

Retorno: byte[].

getRepots

Retorna os relatórios disponíveis.

Método:

getRepots(String username, String password, int companyId)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: DocumentDto[].

updateSimpleReport

Atualiza um relatório de maneira simplificada no fluig.

Método:

createSimpleReportupdateSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• docId: código da pasta pai.
• reportDescription: descrição do relatório.
• attachments: anexos do relatório.
• versionOption: informa se deseja atualizar a versão do relatório.

Retorno: WebServiceMessage[] WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

advancedSearchDocuments

Utiliza busca avançada.

Método:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• content: conteúdo da busca.
• findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
• findFolders: indica se deve buscar pastas.
• findDocuments: indica se deve buscar documentos.
• findCardIndex: indica se deve buscar formulários.
• findCards: indica se deve buscar registros de formulários.
• findExternalDocument: indica se deve buscar documentos externos.
• documentParentId: número do documento pai.
• startDate: data inicial.
• finalDate: data final.

Retorno: SearchResultDto[].

Utiliza busca avançada através das opções de metadados e campos customizados.

Método:

advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean  findAllDocumentTypes, boolean  findFolders, boolean  findDocuments, boolean  findCardIndex, boolean  findCards, boolean  findExternalDocument, int  documentParentId, Date  startDate, Date  finalDate)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• content: conteúdo da busca.
• metadata: informações para busca a partir de metadados do arquivo, como publicador (usando o fieldName publisher), autor (author), descrição (description), descrição da versão/revisão (versionDescription), comentários (additionalComments), tags (tags), data de criação (createDate) e data da última alteração (lastUpdateDate).
• customfields: informações para busca a partir de metadados de campos customizados, informando o código do campo customizado como fieldName e valor a ser utilizado como filtro.
• findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
• findFolders: indica se deve buscar pastas.
• findDocuments: indica se deve buscar documentos.
• findCardIndex: indica se deve buscar formulários.
• findCards: indica se deve buscar registros de formulários.
• findExternalDocument: indica se deve buscar documentos externos.
• documentParentId: número do documento pai.
• startDate: data inicial.
• finalDate: data final.

Retorno: SearchResultDto[].

searchDocuments

Utiliza busca simples.

Método:

searchDocuments(String user, String password, int companyId, String colleagueId, String content)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• content: conteúdo da busca.

Retorno: SearchResultDto[].

searchFavoritesDocuments

Busca documentos favoritos.

Metodo:

searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)

Parametros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• contente: conteúdo a ser buscado

Retorno: SearchResultDto[].