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

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

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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.

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.

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.

getSummaryColleagues

Retorna todos os usuários ativos.

Método:

getSummaryColleagues(int companyId)

Parâmetros:

• companyId: código da empresa.

Retorno: ColleagueDto[].

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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

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

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

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.
  
  

createDataService

Cria um serviço externo.

Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• dataServiceDto: serviço externo que será criado.

Retorno: String.

Remove um serviço externo.

Método:

deleteDataService(int companyId, String user, String password, String dataServiceName)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• dataServiceName: nome do serviço externo que será removido.
  
  

Retorno: void.

Retorna todos os serviços externos cadastrados.

Método:

getAllServices(int companyId, String user, String password)

Parâmetros:

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

Retorno: dataServiceDto[].

Retorna um serviço externo.

Método:

loadDataService(int companyId, String user, String password, String dataServiceName)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• dataServiceName: nome do serviço externo.

Retorno: dataServiceDto.

Atualiza um serviço externo.

Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• dataServiceDto: serviço externo que será atualizado.

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.

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.

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.

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.

xxxxx

Altera os campos de um formulário.

xxxxx

Altera os campos de um formulário.