...
| Expandir |
|---|
| title | No quadro 2, é mostrado todos os métodos disponíveis na classe AttributionMecanismService. |
|---|
|
- getAttributionMecanism | Retorna os mecanismos de atribuição da empresa. Método: getAttributionMecanism(String user, String password, int companyId) Parâmetros: - user: login do colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
Retorno: AttributionMecanismDto[]. |
Quadro 2: Métodos da AttributionMecanismService |
...
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosAttributionMecanismService é disponibilizada a classe AttributionMecanismServiceClient.java, esta exemplifica a utilização de todos os métodos da classe AttributionMecanismService.
ECMBusinessPeriodService
Webservices responsável por realizar operações referentes aos expedientes cadastrados no Fluig. Pode ser utilizado para pesquisar os expedientes de uma determinada empresa.
Métodos
| Expandir |
|---|
| title | Métodos | No quadro 3, é mostrado todos os métodos disponíveis na classe |
|---|
| ECMBusinessPeriodService |
- getBusinessPeriods | Retorna os expedientes da empresa. Método: getBusinessPeriods(String user, String password, int companyId) Parâmetros: colaborador;- usuário.
- password: senha do
colaborador;- usuário.
- companyId: código da empresa
; Retorno: BusinessPeriodDto[]. |
Quadro 3: Métodos da ECMBusinessPeriodServiceBusinessPeriodService |
Exemplo de utilização
No diretório de documentação do ECM Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosBusinessPeriodService é disponibilizada a classe BusinessPeriodServiceClient.java, esta exemplifica a utilização de todos os métodos da classe BusinessPeriodService.
...
Webservices responsável por realizar operações referentes aos fichários formulários cadastrados no Fluig.
Métodos
| Expandir |
|---|
| title | Métodos | No quadro 4, é mostrado todos os métodos disponíveis na classe |
|---|
| ECMCardIndexService |
- 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- parentDocumentId: numero do formulário.
- publisherId: código do autor.
- documentDescription: descrição.
- cardDescription: nome.
- descriptionField: descrição.
- 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- parentDocumentId: numero do formulário.
- publisherId: código do autor.
- documentDescription: descrição.
- cardDescription: nome.
- descriptionField: descrição.
- dataset: 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 (Ficha 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;
- parentDocumentId: numero do formulário.
- publisherId: código do autor.
- documentDescription: descrição.
- cardDescription: nome.
- descriptionField: descrição.
- dataset: 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 colaborador;usuário.
- password: senha do colaborador;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 colaborador;usuário.
- password: senha do colaborador;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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- documentId: numero do formulário.
- colleagueId : matrícula do colaborador usuário para a verificação de permissão nos formulárioformulários.
- version: número da versão do formulário.
- nomeArquivo: nome do arquivo anexo.
Retorno: byte[]. | getCardIndexesWithoutApprover | Retorna os fichários formulários sem aprovadores que o colaborador usuário tenha permissão. Método: getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId) Parâmetros: - user: login do colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- colleagueId : matrícula do colaborador usuário para a verificação de permissão nos ficháriosformulá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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- documentId: numero 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- documentId: numero 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- documentId: numero 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- companyId: código da empresa;.
- documentId: numero 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 []. |
Quadro 4: Métodos da ECMCardIndexServiceCardIndexService |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardIndexService é disponibilizada a classe CardIndexServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CardIndexService.
...
Webservices responsável por realizar operações referentes a fichas formulários no ECMFluig. Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras funcionalidades.
Métodos
| Expandir |
|---|
| title | Métodos | No quadro 5, é mostrado todos os métodos disponíveis na classe |
|---|
| ECMCardService |
- updateCardData | Altera os campos de uma fichaum 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- cardId: número da ficha;do formulário.
- cardData: campos da ficha do formulário que serão alterados.
Retorno: WebServiceMessage[]. | create | Cria uma fichaum formulário. Método: create(int companyId, String user, String password, CardDto[] carddtos) Parâmetros: - companyId: código da empresa;.
- user: login do colaborador;usuário.
- password: senha do colaborador;usuário.
- carddtos: ficha formulário que será criadacriado.
Retorno: WebServiceMessage[]. | deleteCard | Exclui uma ficha 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- cardId: número da fichado formulário.
Retorno: WebServiceMessage[]. | updateCard | Altera os metadados de uma fichaum 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- cardDtos: ficha formulário que será alterada;alterado.
- attachs: anexos da ficha;do formulário.
- docsecurity: segurança da ficha;do formulário.
- docapprovers: aprovadores da ficha;do formulário.
- reldocs: documentos relacionados da fichado formulário.
Retorno: WebServiceMessage[]. | getCardVersion | Retorna a versão de uma fichaum 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 colaborador;usuário.
- password: senha do colaborador;usuário.
- nrDocumentId: número da ficha;do formulário.
- version: versão da ficha;do formulário.
- colleagueId: matrícula do colaboradorusuário.
Retorno: CardDto[]. |
Quadro 5: Métodos da ECMCardServiceCardService |
Exemplo de utilização
No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardService é disponibilizada a classe CardServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CardService.
...