Webservices (WSDL)

Comando

ECMAttributionMecanismService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl

ECMBusinessPeriodService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl

ECMCardIndexService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl

ECMCardService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl

ECMColleagueGroupService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl

ECMColleagueReplacementService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl

ECMColleagueService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl

ECMCompanyService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl

ECMCustomFieldsService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl

ECMDashBoardService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl

ECMDataServiceService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl

ECMDatasetService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl

ECMDocumentService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl

ECMFavoritesService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl

ECMFolderService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl

ECMGlobalParamService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl

ECMGroupService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl

ECMOutstandingService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl

ECMReportService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl

ECMSearchDocumentService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl

ECMSignalService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl

ECMTokenService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl

ECMWorkflowEngineService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl

ECMWorkflowRoleService

wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl

getAttributionMecanism

Retorna os mecanismos de atribuição da empresa.

Método:

getAttributionMecanism(String user, String password, int companyId)

Parâmetros:

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

Retorno: AttributionMecanismDto[].

getBusinessPeriods

Retorna os expedientes da empresa.

Método:

getBusinessPeriods(String user, String password, int companyId)

Parâmetros:

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

Retorno: BusinessPeriodDto[].

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: numero do formulário.
• publisherId: código do autor.
• documentDescription: descrição.
• cardDescription: nome.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

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: numero do formulário.
• publisherId: código do autor.
• documentDescription: descrição.
• cardDescription: nome.
• datasetName: nome do dataset.
• attachments: arquivo anexo.
• customEvents: eventos.

Retorno: WebServiceMessageArray [].

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: numero 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.

Retorno: WebServiceMessageArray [].

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: numero do formulário.

Retorno: StringArray [].

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: numero 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: 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: String[].

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 [].

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 [].

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[].

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[].

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[].

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[].

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[].

createColleagueGroup

Associa um usuário a um grupo.

Método:

createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa;
• grupo_colaborador: grupo que estará associado a um usuário.

Retorno: String.

deleteColleagueGroup

Exclui um usuário de um grupo.

Método:

deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parâmetros:

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

Retorno: String.

getAllColleagueGroups

Retorna todos os grupos que possuem usuários relacionados.

Método:

getAllColleagueGroups(String username, String password, int companyId)

Parâmetros:

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

Retorno: ColleagueGroupDto[].

getColleagueGroup

Retorna somente um grupo que determinado usuário participa.

Método:

getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

Parâmetros:

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

Retorno: ColleagueGroupDto[].

getColleagueGroupsByColleagueId

Retorna os grupos que um usuário participa.

Método:

getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: ColleagueGroupDto[].

 getColleagueGroupsByGroupId

Retorna os usuários que participam de um grupo de usuários.

Método:

getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)

Parâmetros:

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

Retorno: ColleagueGroupDto[].

updateColleagueGroup

Altera a associação de um usuário a um grupo.

Método:

updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• grupo_colaborador: grupo de usuários que será alterado.

Retorno: String.

createColleagueReplacement

Cria um substituto.

Método:

createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parâmetros:

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

Retorno: String.

deleteColleagueReplacement

Exclui o cadastro de um substituto.

Método:

deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

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

Retorno: String.

getColleagueReplacement

Retorna um substituto de um usuário.

Método:

getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

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

Retorno: ColleagueReplacementDto.

 getReplacementsOfUser

Retorna todos os substitutos de um usuário.

Método:

getReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: ColleagueReplacementDto[].

getValidReplacedUsers

Retorna todos os usuário substituídos por um substituto válido.

Método:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

Parâmetros:

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

Retorno: ColleagueReplacementDto[].

getValidReplacement

Retorna um substituto válido de um usuário.

Método:

getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

Parâmetros:

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

Retorno: ColleagueReplacementDto.

getValidReplacementsOfUser

Retorna todos os substitutos válidos de um usuário.

Método:

getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: ColleagueReplacementDto[].

updateColleagueReplacement

Altera o cadastro de um substituto.

Método:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

Parâmetros:

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

Retorno: String.

createColleague

Cria um usuário.

Método:

createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parâmetros:

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

Retorno: String.

createColleaguewithDependencies

Cria um usuário com grupos e papéis.

Método:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.
• grupos: grupos.
• papeis: papéis.

Retorno: String.

getColleague

Retorna um usuário.

Método:

getColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: ColleagueDto[].

getColleagueByLogin 

Retorna o usuário a partir do login.

Método:

getColleagueByLogin(String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.

Retorno: ColleagueDto.

getColleagues

Retorna todos os usuários ativos.

Método:

getColleagues(String username, String password, int companyId)

Parâmetros:

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

Retorno: ColleagueDto[].

getColleaguesMail

Retorna um usuário utilizando um e-mail.

Método:

getColleaguesMail(String username, String password, int companyId, String mail)

Parâmetros:

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

Retorno: ColleagueDto[].

getColleagueWithMap

Retorna uma mensagem informando se o usuário foi criado corretamente.

Método:

getColleagueWithMap(String colleagueXML, String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• colleagueXML: lista normalizada de documentos.

Retorno: String.

getGroups

Retorna os grupos que o usuário participa.

Método:

getGroups(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: GroupDto[].

getSimpleColleague

Retorna o usuário.

Método:

getSimpleColleague(String username, String password)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.

Retorno: ColleagueDto.

getSummaryColleagues

Retorna todos os usuários ativos.

Método:

getSummaryColleagues(int companyId)

Parâmetros:

• companyId: código da empresa.

Retorno: ColleagueDto[].

removeColleague

Exclui um usuário.

Método:

removeColleague(String username, String password, int companyId, String colleagueId)

Parâmetros:

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

Retorno: String.

updateColleague

Altera um usuário.

Método:

updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

Parâmetros:

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

Retorno: String.

updateColleaguewithDependencies

Altera um usuário com grupos e papéis.

Método:

updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagues: usuários.
• grupos: grupos.
• papeis: papéis.

Retorno: String.

validateColleagueLogin

Valida o acesso de um usuário no produto.

Método:

validateColleagueLogin(int companyId, String colleagueId, String password)

Parâmetros:

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

Retorno: String.

createCompany

Cria uma empresa no Fluig.

Método:

createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• description: descrição da empresa.
• urlAccessName: URL de acesso.
• phisicalPath: caminho físico.
• webdeskServer: servidor.
• webPort: porta.

Retorno: String.

delete

Exclui uma empresa do Fluig.

Método:

delete(String username, String password, String companyId, Boolean deleteFiles)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• deleteFiles: indica se deve excluir o caminho físico.

Retorno: String.

getCompanies

Retorna todas as empresas cadastradas no Fluig.

Método:

getCompanies(String username, String password, String companyId)

Parâmetros:

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

Retorno: CompanyDto[].

getCompany

Retorna uma empresa cadastrada no Fluig.

Método:

getCompany(int companyId)

Parâmetros:

• companyId: código da empresa.

Retorno: CompanyDto.

updateCompany

Altera uma empresa no Fluig.

Método:

updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• description: descrição da empresa.
• urlAccessName: URL de acesso.
• phisicalPath: caminho físico.
• webdeskServer: servidor.
• webPort: porta.

Retorno: String.

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.

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.

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: String.

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.

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.

addDataset

Cria um dataset.

Método:

addDataset(int companyId, String user, String password, String datasetName, String description, String impl)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• datasetName: nome do dataset que será criado.
• description: descrição do dataset.
• impl: implementação para criação do dataset.

Retorno: String.

deleteDataset

Remove um dataset.

Método:

deleteDataset(int companyId, String user, String password, String datasetName)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• datasetName: nome do dataset que será removido.

Retorno: void.

getAvailableDatasets

Retorna todos os datasets disponíveis.

Método:

getAvailableDatasets(int companyId, String user, String password)

Parâmetros:

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

Retorno: Object[].

getDataset

Retorna as informações de um dataset.

Método:

getDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String[] order)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• name: nome do dataset.
• fields: campos que serão retornados do dataset.
• constraintsDto: filtro dos registros que irão compor o dataset.
• order: campos utilizados para ordenar o dataset.

Retorno: DatasetDto.

updateDataset

Atualiza um dataset.

Método:

updateDataset(int companyId, String user, String password, String datasetName, String description, String impl)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• datasetName: nome do dataset que será atualizado.
• description: descrição do dataset.
• impl: implementação do dataset.

Retorno: void.

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

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

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.
• attachs: arquivo anexado na publicação.
• docSecurity: segurança do documento que será publicado.
• docApprovers: aprovadores do documento que será publicado.
• relDocs: documentos relacionados ao documento que será publicado.

Retorno: WebServiceMessage[].

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[].

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.

Retorno: WebServiceMessage[].

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[].

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[].

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[].

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

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[].

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[].

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[].

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[].

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

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

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: 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[].

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[].

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: 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[].

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.

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: String[]

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[].

updateDocument

Altera um documento.

Método:

updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, 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á alterado.
• attachs: arquivo anexado na alteração.
• docSecurity: segurança do documento que será alterado.
• docApprovers: aprovadores do documento que será alterado.
• relDocs: documentos relacionados ao documento que será alterado.

Retorno: WebServiceMessage[].

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[].

updateGroupSecurityType

Modifica a 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[] 

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[].

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.

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.

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[].

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[].

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[].

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[].

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[].

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

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[].

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[].

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[].

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[].

createGlobalParam

Cria parâmetros gerais para uma empresa.

Método:

createGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• global: parâmetros gerais da empresa.

Retorno: String.

getGlobalParam

Retorna os parâmetros gerais de uma empresa.

Método:

getGlobalParam(String username, String password, int companyId)

Parâmetros:

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

Retorno: GlobalParamDto[].

getVolumes

Retorna os volumes da empresa.

Método:

getVolumes(String user, String password, int companyId)

Parâmetros:

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

Retorno: VolumeDto[].

updateConfigurations

Altera as configurações do sistema.

Método:
updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer,
String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• dbDriver: driver do banco de dados (MySql- com.mysql.jdbc.Driver. SQLServer - net.sourceforge.jtds.jdbc.Driver. Oracle -oracle.jdbc.driver.OracleDriver)
• dbUser: username banco de dados.
• dbPassword: password banco de dados.
• dbServer: servidor de conexão do banco de dados.
• dbPort: porta servidor banco de dados.
• dbScheme: database.
• dbInstance: instância do banco, utilizada para SQLServer, caso não seja o caso passar em branco ("").
• mailServer: nome do servidor SMTP.
• emailSender: e-mail do remetente padrão do produto.
• emailPort: porta do servidor SMTP.
• emailDefaultSender:
• emailUser: usuário de email, somente se o servidor necessitar de autenticação.
• emailPassword: password do email, somente se o servidor necessitar de autenticação.
• emailTLS: servidor utilizará criptografia no envio de email (true/false)
• paramsRMTPTPort: porta utilizada pelo Flex.
• lsType: tipo de licença utilizada, LM/LS.
• paramsLSHost: servidor de licenças.
• paramsLSPort: porta servidor de licenças.
• paramsOpenOfficeDir: diretório de instalação do OpenOffice
• paramsOpenOfficePorts: porta utilizado pelo OpenOffice
• portsSetName: porta utilizadas pelo sistema (ports-default, ports-01, ports-02)

Retorno: String.

updateGlobalParam

Altera parâmetros gerais de uma empresa.

Método:

updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• global: parâmetros gerais da empresa.

Retorno: String.

createGroup

Cria um grupo no Fluig.

Método:

createGroup(String username, String password, int companyId, GroupDto[] grupos)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• grupos: grupo que será criado.

Retorno: String.

deleteGroup

Exclui um grupo do Fluig.

Método:

deleteGroup(String username, String password, int companyId, String groupId)

Parâmetros:

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

Retorno: String.

getGroup

Retorna um grupo cadastrado no Fluig.

Método:

getGroups(String username, String password, int companyId, String groupId)

Parâmetros:

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

Retorno: GroupDto[].

getGroups

Retorna todos os grupos cadastrados no Fluig.

Método:

getGroups(String username, String password, int companyId)

Parâmetros:

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

Retorno: GroupDto[].

getGroupsByDescription

Retorna um grupo pela descrição.

Método:

getGroupsByDescription(String username, String password, int companyId, String desc)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• desc: descrição do grupo.

Retorno: GroupDto[].

getOcurrenceByKey

Retorna se existe configuração de segurança para atribuição e valor da atribuição.

Método:

getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• pIdiAtribuic: código da atribuição.
• pDesValAtribuic: valor da atribuição.

Retorno: boolean.

updateGroup

Altera um grupo no Fluig.

Método:

updateGroup(String username, String password, int companyId, GroupDto[] grupos)

Parâmetros:

• username: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• grupos: grupo que será alterado.

Retorno: String.

transfer

Transfere pendências de um usuário para outro usuário.

Método:

transfer(String user, String password, int companyId, String colleagueIdFrom, String colleagueIdTo, String[] parameters)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• colleagueIdFrom: matrícula do usuário origem (suas pendências serão tranferidas para o usuário destino).
• colleagueIdTo: matrícula do usuário destino (receberá as pendências do usuário origem).
• parameters: array de pendências que serão transferidas para o usuário destino.

Retorno: String.

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[].

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: String[].

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:

createSimpleReport(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[].

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 fichários.
• findCards: indica se deve buscar fichas.
• 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.
• customfields: informações para busca a partir de campos customizados.
• 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 fichários.
• findCards: indica se deve buscar fichas.
• 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[]

getToken

Retorna um token de segurança.

Método:

getToken(String login, String password)

Parâmetros:

• login: login do usuário.
• password: senha do usuário.

Retorno: String.

getTokenByLogin

Retorna um token de segurança para o login solicitado.

Método:

getTokenByLogin(int companyId, String colleagueId, String password, String login)

Parâmetros:

• companyId: código da empresa.
• colleagueId: matrícula do usuário.
• password: senha do usuário.
• login: login do usuário que será gerado pelo token.

Retorno: String.

getTokenEmail

Retorna um token de segurança para o e-mail solicitado.

Método:

getTokenEmail(int companyId, String email, String password)

Parâmetros:

• companyId: código da empresa.
• email: e-mail do usuário.
• password: senha do usuário.

Retorno: String.

validateToken

Valida o token de segurança e retorna o login do usuário.

Método:

validateToken(String token)

Parâmetro:

• token: token do usuário.

Retorno: String.