...
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosGroupService é disponibilizada a classe GroupServiceClient.java, esta exemplifica a utilização de todos os métodos da classe GroupService.
ECMOutstandingService
Webservice responsável por interagir com as transferências de pendências do Fluig. Pode ser utilizado para transferir pendências de um usuário para outro usuário.
Métodos
| Expandir |
|---|
| title | No quadro 19, é mostrado todos os métodos disponíveis na classe OutstandingService. |
|---|
|
- 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. |
Quadro 19: Métodos da OutstandingService. |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosOutstandingService é disponibilizada a classe OutstandingServiceClient.java, esta exemplifica a utilização de todos os métodos da classe OutstandingService.
...
Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.
Métodos
| Expandir |
|---|
| title | No quadro 5, é mostrado todos os métodos disponíveis na classe CardService. |
|---|
|
- xxxxx | Altera os campos de um formulário. | | | |
Quadro 20: Métodos da xxxxx |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosXXXX é disponibilizada a classe xxxxx.java, esta exemplifica a utilização de todos os métodos da classe xxxxxxx.
...
Webservice responsável por realizar operações referentes às buscas no Fluig. Pode ser utilizado para buscar documentos utilizando a busca simples e avançada.
Métodos
| Expandir |
|---|
| title | No quadro 21, é mostrado todos os métodos disponíveis na classe SearchDocumentService. |
|---|
|
- 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[]. | | advancedSearchDocumentsWithMetadata | 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[] |
Quadro 21: Métodos da SearchDocumentService |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosSearchDocumentService é disponibilizada a classe SearchDocumentServiceClient.java, esta exemplifica a utilização de todos os métodos da classe SearchDocumentService.
ECMSignalService
Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.
Métodos
| Expandir |
|---|
| title | No quadro 22, é mostrado todos os métodos disponíveis na classe SignalService. |
|---|
|
- xxxxx | Altera os campos de um formulário. | | | |
Quadro 22: Métodos da SignalService |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosXXXX é disponibilizada a classe xxxxx.java, esta exemplifica a utilização de todos os métodos da classe xxxxxxx.
ECMTokenService
Webservice responsável por interagir com os token’s do Fluig. Pode ser utilizado para pesquisar e validar os token’s existentes.
Métodos
| Expandir |
|---|
| title | No quadro 23, é mostrado todos os métodos disponíveis na classe TokenService. |
|---|
|
- 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: Retorno: String. |
Quadro 23: Métodos da TokenService. |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosTokenService é disponibilizada a classe TokenServiceClient.java, esta exemplifica a utilização de todos os métodos da classe TokenService.
ECMxxxxService
Webservice responsável por realizar operações referentes à empresa no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.
Métodos
| Expandir |
|---|
| title | No quadro 5, é mostrado todos os métodos disponíveis na classe CardService. |
|---|
|
- xxxxx | Altera os campos de um formulário. | | | |
Quadro 6: Métodos da xxxxx |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosXXXX é disponibilizada a classe xxxxx.java, esta exemplifica a utilização de todos os métodos da classe xxxxxxx.
...