Histórico da Página
...
Para evitar esta situação, sugerimos sempre utilizar os métodos get para recuperar o objeto, efetuar as alterações nos campos necessários e enviá-lo para o método update.
DocumentService
Webservices responsável por realizar operações referentes a documentos do ECM. Pode ser utilizado para criar, alterar, excluir e procurar documentos, entre outras funcionalidades.
...
Quadro 2: Métodos da DocumentService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDocumentService é disponibilizada a classe DocumentServiceClient.java, esta exemplifica a utilização de todos os métodos da classe DocumentService.
WorkflowEngineService
Webservices responsável por realizar operações referentes a workflow no ECM. Pode ser utilizado para movimentar solicitações, entre outras funcionalidades.
Métodos
No quadro 3, é mostrado todos os métodos disponíveis na classe WorkflowEngineService.
...
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosWorkflowEngineService é disponibilizada a classe WorkflowEngineServiceClient.java, esta exemplifica a utilização de todos os métodos da classe WorkflowEngineService.
GroupService
Webservices responsável por realizar operações referentes a grupos no ECM. Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras funcionalidades.
Métodos
No quadro 4, é mostrado todos os métodos disponíveis na classe GroupService.
...
Quadro 4: Métodos da GroupService
Exemplo de utilização
No diretório de documentação do ECM 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.
...
Webservices responsável por interagir com os documentos e processos favoritos do ECM. Pode ser utilizado para pesquisar os documentos e processos favoritos de cada colaborador.
Método
No quadro 5, é mostrado os métodos disponíveis na classe FavoritesService.
...
Quadro 5: Métodos da FavoritesService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosFavoritesService é disponibilizada a classe FavoritesServiceClient.java, esta exemplifica a utilização de todos os métodos da classe FavoritesService.
...
Webservices responsável por realizar operações referentes à empresa no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas, entre outras funcionalidades.
Métodos
No quadro 6, é mostrado todos os métodos disponíveis na classe CompanyService.
...
Quadro 6: Métodos da CompanyService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCompanyService é disponibilizada a classe CompanyServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CompanyService.
SearchDocumentService
Webservices responsável por realizar operações referentes às buscas no ECM. Pode ser utilizado para buscar documentos utilizando a busca simples e avançada.
Métodos
No quadro 7, é mostrado todos os métodos disponíveis na classe SearchDocumentService.
...
Quadro 7: Métodos da SearchDocumentService
Exemplo de utilização
No diretório de documentação do ECM 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.
ColleagueGroupService
Webservices responsável por realizar operações referentes aos grupos de usuários no ECM. Pode ser utilizado para relacionar um colaborador a um grupo de usuários e serve também para alterar, excluir e pesquisar esses relacionamentos criados.
Métodos
No quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueGroupService.
...
Quadro 8: Métodos da ColleagueGroupService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueGroupService é disponibilizada a classe ColleagueGroupServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueGroupService.
...
Webservices responsável por realizar operações referentes a colaboradores no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar colaboradores, entre outras funcionalidades.
Os métodos createColleague, createColleaguewithDependencies, updateColleague e updateColleaguewithDependencies, em um dos seus paramtros, recebe uma lista de ColleagueDto, nos objetos destas listas os valores para os campos de senha (password) devem ser criptografados com o algoritmo de hash MD5.
Métodos
No quadro 9, é mostrado todos os métodos disponíveis na classe ColleagueService.
...
Quadro 9: Métodos da ColleagueService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueService é disponibilizada a classe ColleagueServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueService.
ColleagueReplacementService
Webservices responsável por realizar operações referentes a colaboradores substitutos no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar colaboradores substitutos, entre outras funcionalidades.
Métodos
No quadro 10, é mostrado todos os métodos disponíveis na classe ColleagueReplacementService.
...
Quadro 10: Métodos da ColleagueReplacementService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueReplacementService é disponibilizada a classe ColleagueReplacementServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueReplacementService.
FolderService
Webservices responsável por realizar operações referentes a pastas no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras funcionalidades.
Métodos
No quadro 11, é mostrado todos os métodos disponíveis na classe FolderService.
| getFolder | Retorna uma pasta. Método: Parâmetros:
|
| getSecurity | Retorna a segurança de uma pasta. Método: Parâmetros:
|
| getApprovers | Retorna os aprovadores de uma pasta. Método: getApprovers(String user, String password, int companyId, int nrDocumentId) Parâmetros:
|
| createFolder | Cria uma pasta. DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers ) Parâmetros:
|
createFolderWithApprovementLevels | Cria uma pasta com nível de aprovação. Método: DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels) Parâmetros: |
| updateFolder | Altera uma pasta. Método: updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers) Parâmetros:
|
| updateFolderWithApprovementLevels | Altera uma pasta com nível de aprovação. DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels) Parâmetros:
|
| updateSimpleFolder | Altera de forma simples uma pasta. Método: Parâmetros:
|
| getRootFolders | Retorna as pastas root que um colaborador tem acesso, exceto a pasta particular.
Método: Parâmetros:
|
| getChildren | Retorna todos os documentos de uma pasta. Método: Parâmetros:
|
| getPrivateChildren | Retorna todos os documentos de uma pasta particular. Método: Parâmetros:
|
| getSubFolders | Retorna todas as subpastas e arquivos de um pasta. Método: int documentId, String colleagueId) Parâmetros:
|
| getSubFoldersOnDemand | Retorna todas as subpastas e arquivos de um pasta, paginados. Método: int documentId, int limit , int lastRowId, String colleagueId) Parâmetros:
|
| getUserPermissions | Retorna a permissão de um colaborador sobre uma pasta. Método: Parâmetros:
|
| createSimpleFolder | Cria uma pasta simples. Método: int parentDocumentId, String publisherId, String documentDescription) Parâmetros:
|
| getSubPrivateFolders | Retorna todas as subpastas de uma pasta particular. Método: Parâmetros:
|
| getSubFoldersPermission | Retorna todas as subspastas em que o colaborador tenha a permissão informada. Método: int companyId, int documentId, String colleagueId, int permission) Parâmetros:
|
| deleteDocument | Exclui uma pasta e envia para a lixeira. Método: int companyId, int documentId, String colleagueId) Parâmetros:
|
| destroyDocument | Exclui uma pasta da lixeira. String colleagueId) Parâmetros:
|
| findRecycledDocuments | Retorna todos os documentos da lixeira de um colaborador. Método: Parâmetros:
|
| restoreDocument | Restaura uma pasta da lixeira. Método: int documentId, String colleagueId) Parâmetros:
|
Quadro 11: Métodos da FolderService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosFolderService é disponibilizada a classe FolderServiceClient.java, esta exemplifica a utilização de todos os métodos da classe FolderService.
CardService
Webservices responsável por realizar operações referentes a fichas no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras funcionalidades.
Métodos
No quadro 12, é mostrado todos os métodos disponíveis na classe CardService.
| updateCardData | Altera os campos de uma ficha. Método: int cardId, CardFieldDto[] cardData) Parâmetros:
|
| create | Cria uma ficha. Método: Parâmetros:
|
| deleteCard | Exclui uma ficha e envia para a lixeira. Método: Parâmetros:
|
| updateCard | Altera os metadados de uma ficha. Método: DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs) Parâmetros:
|
| getCardVersion | Retorna a versão de uma ficha. Método: int nrDocumentId, int version, String colleagueId) Método:
|
Quadro 12: Métodos da CardService
Exemplo de uitlização
No diretório de documentação do ECM 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.
TokenService
Webservices responsável por interagir com os token’s do ECM. Pode ser utilizado para pesquisar e validar os token’s existentes.
Métodos
No quadro 13, é mostrado todos os métodos disponíveis na classe TokenService.
| getToken | Retorna um token de segurança. Método: Parâmetros:
|
| validateToken | Valida o token de segurança e retorna o login do colaborador. Método: Parâmetro:
|
Quadro 13: Métodos da TokenService
Exemplo de utilização
No diretório de documentação do ECM 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.
CustomFieldsService
Webservices responsável por interagir com os campos customizados do ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar campos customizados, entre outras funcionalidades.
Métodos
No quadro 14, é mostrado todos os métodos disponíveis na classe CustomFieldsService.
| createCustomFields | Cria um campo customizado. Método: int companyId, CustomFieldsDto[] customFieldsDto) Parâmetros:
|
| updateCustomFields | Altera um campo customizado. Método: int companyId, CustomFieldsDto[] customFieldsDto) Parâmetros:
|
| removeCustomField | Exclui um campo customizado. Método: String customFieldsId) Parâmetros:
|
| getAllCustomField | Retorna todos os campos customizados.
Método: Parâmetros:
|
| setDocumentCustomFields | Cria ou altera um campo customizado em um documento.
Método: DocumentCustomFieldsDto[] documentCustomFieldsDto) Parâmetros:
|
| removeDocumentCustomField | Exclui um campo customizado de um documento. Método: int companyId, String customFieldsId, int documentId, int version) Parâmetros:
|
| getAllDocumentCustomField | Retorna todos os campos customizados de um documento.
Método: int companyId, int documentId, int version) Parâmetros:
|
Quadro 14: Métodos da CustomFieldsService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCustomFieldsService é disponibilizada a classe CustomFieldsServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CustomFieldsService.
OutstandingService
Webservices responsável por interagir com as transferências de pendências do ECM. Pode ser utilizado para transferir pendências de um colaborador para outro colaborador.
Método
No quadro 15, é mostrado o método disponível na classe OutstandingService.
| transfer | Transfere pendências de um colaborador para outro colaborador. Método: Parâmetros:
|
Quadro 15: Métodos da OutstandingService
Exemplo de uitlização
No diretório de documentação do ECM 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.
GlobalParamService
Webservices responsável por interagir com as configurações dos parâmetros gerais do ECM. Pode ser utilizado para criar, alterar e pesquisar os parâmetros gerais.
Métodos
No quadro 16, é mostrado todos os métodos disponíveis na classe GlobalParamService.
| getGlobalParam | Retorna os parâmetros gerais de uma empresa. Método: Parâmetros:
|
| createGlobalParam | Cria parâmetros gerais para uma empresa. Método: int companyId, GlobalParamDto[] global) Parâmetros:
|
| updateGlobalParam | Altera parâmetros gerais de uma empresa. Método: int companyId, GlobalParamDto[] global) Parâmetros:
|
| getVolumes | Retorna os volumes da empresa.
Método: Parâmetros:
|
| getConfigurations | Retorna as informações de configuração do sistema.
Método: getConfigurations(String username, String password, int companyId) Parâmetros:
|
| updateConfigurations | Altera as configurações do sistema.
Método: updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer, String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName) Parâmetros:
|
Quadro 16: Métodos da GlobalParamService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosGlobalParamService é disponibilizada a classe GlobalParamServiceClient.java, esta exemplifica a utilização de todos os métodos da classe GlobalParamService.
DashBoardService
Webservices responsável por interagir com a central de tarefas do ECM. Pode ser utilizado para pesquisar as informações que estão disponíveis na central de tarefas.
Métodos
No quadro 17, é mostrado todos os métodos disponíveis na classe DashBoardService.
| findMyDocuments | Retorna os documentos do colaborador que precisam ser aprovados. Método: Parâmetros:
|
| findMyDocumentsOnDemand | Retorna os documentos do colaborador que precisam ser aprovados, paginados. Método: String colleagueId, int limit, int lastRowId) Parâmetros:
|
| findDocumentsToApprove | Retorna os documentos que o colaborador precisa aprovar. Método: int companyId, String colleagueId) Parâmetros:
|
| findDocumentsToApproveOnDemand | Retorna os documentos que o colaborador precisa aprovar, paginados. Método: int companyId, String colleagueId, int limit, int lastRowId) Parâmetros:
|
| findAgreementDocuments | Retorna os documentos do colaborador que estão em consenso. Método: int companyId, String colleagueId) Parâmetros:
|
| findCheckoutDocuments | Retorna os documentos do colaborador que estão em checkout.
Método: findCheckoutDocuments(String user, String password, int companyId, String colleagueId) Parâmetros:
|
| findCancelledTasks | Retorna as tarefas atribuidas ao colaborador que foram canceladas.
Método: Parâmetros:
|
| findCompletedTasks | Retorna as tarefas atribuidas ao colaborador que foram finalizadas.
Método: Parâmetros:
|
| findConsensusTasks | Retorna as tarefas atribuidas ao colaborador que estão em consenso.
Método: Parâmetros:
|
| findTransferredTasks | Retorna as tarefas atribuidas ao colaborador que foram transferidas.
Método: Parâmetros:
|
| findWorkflowTasks | Retorna as tarefas do colaborador que estão abertas.
Método: Parâmetros:
|
| findWorkflowTasksOnDemand | Retorna as tarefas do colaborador que estão abertas, paginadas.
Método: int companyId, String colleagueId, int limit, int lastRowId) Parâmetros:
|
| findMyRequests | Retorna as solicitações abertas que foram inicializadas pelo colaborador.
Método: Parâmetros:
|
| findMyRequestsOnDemand | Retorna as solicitações abertas que foram inicializadas pelo colaborador, paginadas.
Método: String colleagueId, int limit, int lastRowId) Parâmetros:
|
| findMyManagerTasks | Retorna as tarefas gerenciadas pelo colaborador.
Método: Parâmetros:
Retorno: WorkflowProcessDto[]. |
| findExpiredWorkflowTasks | Retorna as tarefas do colaborador que estão em atraso
Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId) Parâmetros:
|
| fillStatusTask | Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um colaborador.
Método: Parâmetros:
|
| fillChronoTasks | Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas ao colaborador e não foram finalizadas.
Método: int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask) Parâmetros:
|
| fillTypeTasks | Retorna os tipos de tarefas que o colaborador possui. Método: Parâmetros:
|
| fillTypeTasksOfReplacement | Retorna os tipos de tarefas que o colaborador substituto possui. Método: Parâmetros:
|
| getOpenTasksByColleagueGroups | Retorna as tarefas atribuidas a um grupo de usuários que o colaborador participa. Método: Parâmetros:
|
| getOpenTasksByColleagueGroupsOnDemand | Retorna as tarefas atribuidas a um grupo de usuários que o colaborador participa, paginadas. Método: int companyId, String colleagueId, int limit, int lastRowId) Parâmetros:
|
| getOpenTasksByColleagueRoles | Retorna as tarefas atribuidas a um papel workflow que o colaborador participa. Método: Parâmetros:
|
| getOpenTasksByColleagueRolesOnDemand | Retorna as tarefas atribuidas a um papel workflow que o colaborador participa, paginadas. Método: String colleagueId, int limit, int lastRowId) Parâmetros:
|
| getSummaryRequests | Retorna os contadores de pendências da Home. Método: Parâmetros:
|
Quadro 17: Métodos da DashBoardService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDashBoardService é disponibilizada a classe DashBoardClient.java, esta exemplifica a utilização de todos os métodos da classe DashBoardService.
DatasetService
Webservices responsável por interagir com os datasets do ECM. Pode ser utilizado para pesquisar os datasets existentes.
Métodos
No quadro 18, é mostrado todos os métodos disponíveis na classe DatasetService.
| getAvailableDatasets | Retorna todos os datasets disponíveis. Método: Parâmetros:
|
| getDataset | Retorna as informações de um dataset. Método: SearchConstraintDto[] constraintsDto, String[] order) Parâmetros:
|
Quadro 18: Métodos da DatasetService
Exemplo de utilização
No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosDatasetService é disponibilizada a classe DatasetServiceClient.java, esta exemplifica a utilização de todos os métodos da classe DatasetService.
BusinessPeriodService
Webservices responsável por realizar operações referentes aos expedientes cadastrados no ECM. Pode ser utilizado para pesquisar os expedientes de uma determinada empresa.
Método
No quadro 19, é mostrado todos os métodos disponíveis na classe BusinessPeriodService.
| getBusinessPeriods | Retorna os expedientes da empresa. Método: Parâmetros:
|
Quadro 19: Métodos da BusinessPeriodService
Exemplo de uitlização
No diretório de documentação do ECM 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.
AttribuionMecanismService
Webservices responsável por realizar operações referentes aos mecanismos de atribuição cadastrados no ECM. Pode ser utilizado para pesquisar os mecanismos de atribuição de uma determinada empresa.
Métodos Métodos
Método
No quadro 20, é mostrado todos os métodos disponíveis na classe AttributionMecanismService.
| getAttributionMecanism | Retorna os mecanismos de atribuição da empresa. Método: Parâmetros:
|
Quadro 20: Métodos da AttributionMecanismService
Exemplo de utilização
No diretório de documentação do ECM 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.
CardIndexService
Webservices responsável por realizar operações referentes aos fichários cadastrados no ECM.
Métodos
No quadro 21, é mostrado todos os métodos disponíveis na classe CardIndexService.
| getCardIndexesWithoutApprover | Retorna os fichários sem aprovadores que o colaborador tenha permissão. Método: int companyId, String colleagueId) Parâmetros:
|
| getFormFields | Retorna os campos do fichário. Método: Parâmetros:
|
Quadro 21: Métodos da CardIndexService
Exemplo de utilização
No diretório de documentação do ECM 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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas