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

create

Cria

updateCardData

Altera os campos de um formulário.

Método:

updateCardDatacreate(int companyId, String user, String password, int cardId, CardFieldDtoCardDto[] cardDatacarddtos)

Parâmetros:

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

Retorno: WebServiceMessage[].

createdeleteCard

Cria Exclui um formulário e envia para a lixeira.

Método:

createdeleteCard(int companyId, String user, String password, CardDto[] carddtosint cardId)

Parâmetros:

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

Retorno: WebServiceMessage[].

deleteCard

getCardVersion

Retorna a versão de Exclui um formulário e envia para a lixeira.

Método:

deleteCardgetCardVersion(int companyId, String user, String password, int nrDocumentId, int cardIdversion, String colleagueId)

Método:

Parâmetros:

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

Retorno: WebServiceMessageCardDto[].

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

getCardVersion

Retorna a versão de um formulário.

Método:

getCardVersionupdateCardData(int companyId, String user, String password, int nrDocumentId, int version, String colleagueIdcardId, CardFieldDto[] cardData)

 Método:

Parâmetros:

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

Retorno: CardDtoWebServiceMessage[].

createColleagueGroup

Associa

getColleagueGroupsByColleagueId

Retorna os grupos que um usuário participaa um grupo.

Método:

getColleagueGroupsByColleagueIdcreateColleagueGroup(String username, String password, int companyId, String colleagueIdColleagueGroupDto[] grupo_colaborador)

Parâmetros:

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

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

getColleagueReplacementcreateColleagueReplacement

Retorna Cria um substituto de um usuário.

Método:

getColleagueReplacementcreateColleagueReplacement (String username, String password, int companyId, String colleagueId, String replacementIdColleagueReplacementDto crDto)

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 crDto: cadastro do substituto.

Retorno: ColleagueReplacementDtoString.

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

getColleagues

Retorna todos os usuários ativos.

Método:

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

getColleaguecreateColleaguewithDependencies

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

Método:

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

Parâmetros:

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

Retorno: ColleagueDto[].

• grupos: grupos.
• papeis: papéis.

Retorno: String.

getColleague

Retorna um usuário

getGroups

Retorna os grupos que o usuário participa.

Método:

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

createColleaguegetColleagueByLogin 

Cria um usuárioRetorna o usuário a partir do login.

Método:

createColleaguegetColleagueByLogin(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: StringColleagueDto.

createColleaguewithDependencies

getColleagues

Retorna todos os usuários ativosCria um usuário com grupos e papéis.

Método:

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

updateColleaguegetColleaguesMail

Altera Retorna um usuário utilizando um e-mail.

Método:

updateColleaguegetColleaguesMail(String username, String password, int companyId, ColleagueDto[] colleaguesString mail)

Parâmetros:

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

Retorno: StringColleagueDto[].

updateColleaguewithDependencies

getColleagueWithMap

Retorna uma mensagem informando se o usuário foi criado corretamenteAltera um usuário com grupos e papéis.

Método:

updateColleaguewithDependenciesgetColleagueWithMap(String colleagueXML, 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éiscolleagueXML: lista normalizada de documentos.

Retorno: String.

getGroups

Retorna os grupos que o usuário participa

removeColleague

Exclui um usuário.

Método:

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

getSummaryColleaguesgetSimpleColleague

Retorna todos os usuários ativoso usuário.

Método:

getSummaryColleagues(int companyIdgetSimpleColleague(String username, String password)

Parâmetros:

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

Retorno: ColleagueDto[].

getSummaryColleagues

Retorna todos os usuários ativos

validateColleagueLogin

Valida o acesso de um usuário no produto.

Método:

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

getColleaguesMailremoveColleague

Retorna Exclui um usuário utilizando um e-mail.

Método:

getColleaguesMailremoveColleague(String username, String password, int companyId, String mailcolleagueId)

Parâmetros:

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

Retorno: ColleagueDto[]String.

getSimpleColleagueupdateColleague

Retorna o Altera um usuário.

Método:

getSimpleColleagueupdateColleague(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: ColleagueDtoString.

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

getCompanies

Retorna todas as empresas cadastradas no Fluig.

Método:

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

getCompanydelete

Retorna Exclui uma empresa cadastrada no do Fluig.

Método:

getCompany(int companyIddelete(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: CompanyDtoString.

getCompanies

Retorna todas as empresas cadastradas

createCompany

Cria uma empresa no Fluig.

Método:

createCompanygetCompanies(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.

Retorno: CompanyDto[].

getCompany

Retorna uma empresa cadastrada no Fluig.

Método:

getCompany(int companyId)

Parâmetros:

• companyId: código da empresa
• description: descrição da empresa.
• urlAccessName: URL de acesso.
• phisicalPath: caminho físico.
• webdeskServer: servidor.
• webPort: porta.

Retorno: StringCompanyDto.

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

• : servidor.
• webPort: porta

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

getAllCustomField

Retorna todos os campos customizadosAltera um campo customizado.

Método:

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

removeCustomField

getAllDocumentCustomField

Retorna todos os campos customizados de um documentoExclui um campo customizado.

Método:

removeCustomFieldgetAllDocumentCustomField(String user, String password, int companyId, String customFieldsIdint 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 documentocustomFieldsId: código do campo customizado.

Retorno: StringDocumentCustomFieldsDto[].

removeCustomField

Exclui um campo customizado

getAllCustomField

Retorna todos os campos customizados.

Método:

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

setDocumentCustomFieldsremoveDocumentCustomField

Cria ou altera Exclui um campo customizado em de um documento.

Método:

setDocumentCustomFieldsremoveDocumentCustomField(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto, String customFieldsId, int documentId, int version)

Parâmetros:

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

Retorno: String.

removeDocumentCustomFieldsetDocumentCustomFields

Exclui Cria ou altera um campo customizado de em um documento.

Método:

removeDocumentCustomFieldsetDocumentCustomFields(String user, String password, int companyId, String customFieldsId, int documentId, int versionDocumentCustomFieldsDto[] documentCustomFieldsDto)

Parâmetros:

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

Retorno: String.

getAllDocumentCustomField

updateCustomFields

Altera um campo customizadoRetorna todos os campos customizados de um documento.

Método:

getAllDocumentCustomFieldupdateCustomFields(String user, String password, int companyId, int documentId, int versionCustomFieldsDto[] customFieldsDto)

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 documentocustomFieldsDto: campo customizado que será alterado.

Retorno: DocumentCustomFieldsDto[]String.

addDataset

Cria um dataset

getAvailableDatasets

Retorna todos os datasets disponíveis.

Método:

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

deleteDataset

Remove

getDataset

Retorna as informações de um dataset.

Método:

getDatasetdeleteDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String [] orderdatasetName)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• namedatasetName: 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 datasetque será removido.

Retorno: DatasetDtovoid.

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.