Guia de Referência Utilização de Webservices.pdf

May 25, 2018 | Author: Rodrigo Dourado | Category: Web Service, Login, Infinity, Information Technology Management, Areas Of Computer Science
Share
Report this link


Comments



Description

ECM - WebservicesGuia de Referência Utilização de Webservices ECM - Webservices Copyright © 2009 TOTVS S.A. Todos os direitos reservados. Nenhuma parte deste documento pode ser copiada, reproduzida, traduzida ou transmitida por qualquer meio eletrônico ou mecânico, na sua totalidade ou em parte, sem a prévia autorização escrita da TOTVS S.A., que reserva-se o direito de efetuar alterações sem aviso prévio. A TOTVS S.A não assume nenhuma responsabilidade pelas conseqüências de quaisquer erros ou inexatidões que possam aparecer neste documento. TOTVS S.A. Av. Santos Dumont, 831, Joinville, SC, Brasil, CEP 89.222-900 2 ECM - Webservices Índice Objetivo............................................................................................... 6 Criar Stubs.......................................................................................... 6 Considerações Métodos de Update .................................................. 8 DocumentService ............................................................................... 9 Métodos ......................................................................................................... 9 Exemplo de utilização .................................................................................. 22 WorkflowEngineService .................................................................. 23 Métodos ....................................................................................................... 23 Exemplo de utilização .................................................................................. 38 GroupService.................................................................................... 39 Métodos ....................................................................................................... 39 Exemplo de utilização .................................................................................. 41 FavoritesService .............................................................................. 42 Método ......................................................................................................... 42 Exemplo de utilização .................................................................................. 45 CompanyService .............................................................................. 46 Métodos ....................................................................................................... 46 Exemplo de utilização .................................................................................. 47 SearchDocumentService ................................................................. 49 Métodos ....................................................................................................... 49 Exemplo de utilização .................................................................................. 50 ColleagueGroupService ................................................................... 51 Métodos ....................................................................................................... 51 Exemplo de utilização .................................................................................. 53 3 ..................................................................................................................................... 54 Métodos .................................................................. 59 Métodos ............................................................................................................................................................................................................................................................................................................................................................................................................................ 73 Métodos ........................................................... 73 Exemplo de utilização ........................................... 89 DatasetService ............................................................................................. 77 GlobalParamService ........................................................................................................................................................................................................................................ 72 TokenService ........... 90 Métodos ....................................................................................................................................................................................................................... 62 Métodos ......................................................................................................... 73 CustomFieldsService ................................... 70 Exemplo de utilização ............................. 54 Exemplo de utilização ............................................................................................................ 81 Método .................................................................................. 78 Métodos .... 76 OutstandingService .. 62 Exemplo de utilização ... 80 DashBoardService ................................................................................................................................... 59 Exemplo de utilização ........... 57 ColleagueReplacementService ................. 61 FolderService ......................... 74 Métodos ..................................................................................................................................................................................................................ECM ......................................................Webservices ColleagueService ...................................................................................................... 81 Exemplo de utilização ......................................... 77 Exemplo de utilização .......... 78 Exemplo de utilização .................................................................. 77 Método .......................................................................................................................................... 90 4 ..................................... 70 Métodos ........... 69 CardService ....................................... 74 Exemplo de utilização ....... ................................................. 92 AttributionMecanismService ........................................................................................ 92 Métodos ...................................................... 95 5 ................................................................................................ 93 Métodos ................................................................................................Webservices Exemplo de utilização ..........................................................ECM ........................................................................ 91 BusinessPeriodService ............................................... 92 Exemplo de utilização ................... 94 Métodos ...................................................................... 93 Exemplo de utilização ....................................................................................................................... 94 Exemplo de utilização .......... 93 CardIndexService ................................................................ Para criar um stub é necessário que o serviço do ECM esteja inicializado. deve-se abrir o Prompt de comando e utilizar a sintaxe: wsimport -d <output_directory> <wsdl_url>. mostrar e explicar todos seus métodos. Após isso.ECM . onde output_directory é o diretório onde o stub será criado e wsdl_url é a url de acesso ao serviço. basta apertar Enter e o resultado aparecerá conforme mostra a figura 1. disponibilizar exemplos de classes que utilizam esses Webservices e mostrar exemplos de geração de stubs que são necessários para que os client’s possam se comunicar com o serviço. Webservices WorkflowEngineService Comando wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/WorkflowEngineService?w sdl 6 . Depois de iniciar o serviço. Figura 1: Exemplo de criação de stub No quadro 1.Webservices Objetivo O objetivo deste documento é descrever a utilização de Webservices. Criar Stubs Os stubs são necessários para que os client’s que utilizam os métodos dos Webservices possam se comunicar com o serviço. é mostrado o comando necessário para criação de stubs de cada serviço disponível no ECM. Webservices ColleagueGroupService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ColleagueGroupService?w sdl ColleagueReplacementService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ColleagueReplacementSer vice?wsdl ColleagueService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ColleagueService?wsdl CompanyService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/CompanyService?wsdl GlobalParamService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/GlobalParamService?wsdl GroupService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/GroupService?wsdl CardService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/CardService?wsdl CustomFieldsService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/CustomFieldsService?wsdl DashBoardService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/DashBoardService?wsdl DocumentService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/DocumentService?wsdl FavoritesService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/FavoritesService?wsdl FolderService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/FolderService?wsdl SearchDocumentService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/SearchDocumentService? wsdl TokenService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/TokenService?wsdl DatasetService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/DatasetService?wsdl OutstandingService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/OutstandingService?wsdl BusinessPeriodService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/BusinessPeriodService?ws dl AttributionMecanismService wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/AttributionMecanismServic e?wsdl Quadro 1: Comandos para criação de stubs 7 .ECM . Webservices Considerações Métodos de Update Para os métodos de update que recebem objetos complexos (DocumentDto. sugerimos sempre utilizar os métodos get para recuperar o objeto. etc) é obrigatório passar todos os campos do objeto alterado. Para evitar esta situação. dependendo do seu tipo. nulo ou zero. Os campos não informados serão substituídos por branco. GroupDto.ECM . efetuar as alterações nos campos necessários e enviá-lo para o método update. ColleagueDto. 8 . companyId.ECM .  nrDocumentId: número do documento.  nomeArquivo: nome do arquivo. Método: getActiveDocument(String user. alterar. caso o usuário tenha permissão para acessá-lo. Métodos No quadro 2.  password: senha do colaborador. Retorna o byte do arquivo físico de um documento. String colleagueId) Parâmetros:  user: login do colaborador. getActiveDocument Retorna um documento ativo. String colleagueId.  password: senha do colaborador. Pode ser utilizado para criar. Retorno: DocumentDto[]. String password. String password.  colleagueId: matrícula do colaborador.Webservices DocumentService Webservices responsável por realizar operações referentes a documentos do ECM.  documentVersao: número da versão do documento. int nrDocumentId. é mostrado todos os métodos disponíveis na classe DocumentService. documentoVersao.  colleagueId: matrícula do colaborador. int nrDocumentId. entre outras funcionalidades. companyId.  companyId: código da empresa. Método: getDocumentContent(String user.  nrDocumentId: número do documento. String nomeArquivo) int getDocumentContent int int Parâmetros:  user: login do colaborador. 9 . excluir e procurar documentos.  companyId: código da empresa. String colleagueId) Parâmetros:  user: login do colaborador. Método: getDocumentVersion(String user.  externalDocumentId: código externo do documento. String password. Método: getDocumentByExternalId(String user.Webservices Retorno: byte[]. String colleagueId) Parâmetros:  user: login do colaborador. Retorna a versão de um documento. String password.  colleagueId: matrícula do colaborador.  version: número da versão do documento. Retorna um documento pelo código externo. Método: getSecurity(String user. String password.ECM .  colleagueId: matrícula do colaborador.  password: senha do colaborador. int nrDocumentId.  version: número da versão do documento.  nrDocumentId: número do documento.  companyId: código da empresa. Retorno: DocumentDto[]. Retorno: DocumentDto[]. getDocumentVersion getDocumentByExternalId getSecurity getApprovers 10 .  companyId: código da empresa.  nrDocumentId: número do documento. Retorna a segurança de um documento.  companyId: código da empresa. Retorno: DocumentSecurityConfigDto[]. int companyId.  password: senha do colaborador. String externalDocumentId. int version. int nrDocumentId. int version) Parâmetros:  user: login do colaborador. int company. int companyId.  password: senha do colaborador. Retorna os aprovadores de um documento.  password: senha do colaborador.  docApprovers: aprovadores do documento que será publicado. int version) Parâmetros:  user: login do colaborador. int nrDocumentId. int companyId. Retorna todos os documentos documento.ECM . getRelatedDocuments relacionados de um Método: getRelatedDocuments(String user. String password.  relDocs: documentos relacionados ao documento que será publicado. Retorno: ApproverWithLevelDto[].Webservices Método: getApprovers(String user. Attachment[] attachs.  password: senha do colaborador. RelatedDocumentDto[] relDocs) Parâmetros:  user: login do colaborador.  nrDocumentId: número do documento. DocumentDto[] docDtos.  companyId: código da empresa. Método: createDocument(String user. ApproverDto[] docApprovers. int companyId. String password. DocumentSecurityConfigDto[] docSecurity.  docSecurity: segurança do documento que será publicado. String password. int version) Parâmetros:  user: login do colaborador. Cria um documento. Retorno: RelatedDocumentDto[].  docDtos: documento que será publicado.  attachs: arquivo anexado na publicação.  nrDocumentId: número do documento.  version: número da versão do documento. int nrDocumentId. createDocument 11 .  companyId: código da empresa.  password: senha do colaborador. int companyId.  companyId: código da empresa. Cria um documento com nível de aprovação. Attachment[] attach.  attachs: arquivo anexado na alteração. Método: createDocumentWithApprovementLevels(String user.  password: senha do colaborador.  levels: níveis de aprovação que o documento terá.  relDocs: documentos relacionados ao documento que será publicado. DocumentDto[] docDtos. String password. RelatedDocumentDto[] relDocs) Parâmetros:  user: login do colaborador.  password: senha do colaborador.  relDocs: documentos relacionados ao documento que será alterado.  companyId: código da empresa. String password. Método: updateDocument(String user. DocumentSecurityConfigDto[] docSecurity.  docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos.  companyId: código da empresa. DocumentDto[] docDtos. updateDocument 12 . RelatedDocumentDto[] relDocs) Parâmetros:  user: login do colaborador. ApproverDto[] docApprovers.  attachs: arquivo anexado na publicação.  docApprovers: aprovadores do documento que será alterado.ECM .  docDtos: documento que será publicado. Attachment[] attachs. int companyId.  docSecurity: segurança do documento que será publicado. ApprovalLevelDto[] levels. DocumentSecurityConfigDto[] docSecurity. int companyId.  docDtos: documento que será alterado. Altera um documento.Webservices createDocumentWithApprove mentLevels Retorno: WebServiceMessage[].  docSecurity: segurança do documento que será alterado. Retorno: WebServiceMessage[]. ApproverWithLevelDto[] docApproversLevels.  publisherId: matrícula do colaborador que realizará a alteração do documento. ApproverWithLevelDto[] docApprovers. Métodos: updateDocumentWithApprovementLevels(String user.  companyId: código da empresa.  attachs: arquivo anexado na alteração. Retorno: WebServiceMessage[].  password: senha do colaborador. String documentDescription. String password. Retorno: WebServiceMessage[]. ApprovalLevelDto[] levels.  docDtos: documento que será alterado. int companyId.  documentId: número do documento que será alterado. Método: updateSimpleDocument(String username. Attachment[] attach. DocumentSecurityConfigDto[] docSecutiry.  attachments: arquivos anexados na alteração.  docSecurity: segurança do documento que será alterado. Verifica a integração do colaborador no ECM. String publisherId. String password.Webservices updateSimpleDocument Retorno: WebServiceMessage[].  levels: níveis de aprovação que o documento terá.  docApprovers: nível de aprovação que os aprovadores do documento estão inseridos. Attachment[] attachments) Parâmetros:  username: login do usuário de integração.  companyId: código da empresa.ECM .  password: senha do usuário de integração. DocumentDto[] docDtos.  relDocs: documentos relacionados ao documento que será alterado. Altera um documento com nível de aprovação. RelatedDocumentDto[] relDocs) Parâmetros:  user: login do colaborador. updateDocumentWithApprov ementLevels validateIntegrationRequireme 13 . int companyId.  documentDescription: descrição do documento. Altera de forma simples um documento. int documentId. Webservices nts Método: validateIntegrationRequirements password. Retorna as permissões do colaborador sobre um documento. int version) Parâmetros:  user: login do colaborador. nrDocumentId. int documentId.  password: senha do colaborador. int Parâmetros:  user: login do colaborador.  version: número da versão do documento. Remove a segurança de um documento. int version) Parâmetros:  companyId: código da empresa.  companyId: código da empresa.  password: senha do colaborador. Retorno: String. Método: removeSecurity(String user. removeSecurity getUserPermissions String user. Retorna o código do assunto relatórios dentro do ECM. int companyId) (String user. Retorno: int. String Parâmetros:  user: login do colaborador. Método: getReportSubjectId(String companyId) getReportSubjectId user.  companyId: código da empresa.ECM .  password: senha do colaborador.  companyId: código da empresa. int companyId. int 14 . Retorno: Não há retorno. Método: getUserPermissions(int companyId. String password. String password.  documentId: número do documento.  user: login do colaborador. createSimpleDocument Retorno: Integer. Retorna os documentos mais acessados no ECM que o colaborador tenha permissão de acesso.  publisherId: matrícula do colaborador que publicará o documento.  companyId: código da empresa. Attachment[] attachments) Parâmetros:  user: login do colaborador. int companyId. int parentDocumentId. String password.  parentDocumentId: número da pasta pai.  documentDescription: descrição do documento. int company.ECM . int nr_resultados) Parâmetros: createSimpleDocumentPrivat e findMostPopularDocuments 15 . String password. version: número da versão do documento. String colleagueId.Webservices   nrDocumentId: número do documento. int companyId.  attachments: arquivo anexado na publicação. Retorno: WebServiceMessage[].  password: senha do colaborador. String password. int parentDocumentId. Retorno: WebServiceMessage[]. String publisherId. Método: findMostPopularDocuments(String user. Cria um documento simples na pasta particular. String documentDescription.  documentDescription: descrição do documento. Attachment[] attachments) Parâmetros:  colleagueId: login do colaborador. Cria um documento simples.  attachments: arquivo anexado na publicação.  parentDocumentId: número da pasta pai.  companyId: código da empresa.  password: senha do colaborador. Método: createSimpleDocument(String user. Método: createSimpleDocumentPrivate(String colleagueId. String documentDescription. Exclui um documento e o envia para a lixeira. findMostPopularDocumentsO nDemand Retorno: DocumentDto[]. colleagueId: matrícula do colaborador. String password. String password. int nr_resultados. companyId: código da empresa.  companyId: código da empresa.  colleagueId: matrícula do colaborador. paginados.  password: senha do colaborador. Retorno: WebServiceMessage[].  nr_resultados: quantidade de documentos que serão retornados. int limit.  companyId: código da empresa.Webservices      user: login do colaborador.  password: senha do colaborador. int companyId. int lastRowId) Parâmetros:  user: login do colaborador.ECM .  documentId: número do documento excluído. String colleagueId) Parâmetros:  user: login do colaborador. int 16 . password: senha do colaborador. Retorno: DocumentDto[]. int companyId. nr_resultados: quantidade de documentos que serão retornados. Método: deleteDocument(String user. int documentId. String password. Exclui um documento da lixeira. String colleagueId. Retorna os documentos mais acessados no ECM que o colaborador tenha permissão de acesso. Método: destroyDocument(String deleteDocument que será destroyDocument user.  limit: número de registros a serem retornados. Método: findMostPopularDocuments(String user.  colleagueId: matrícula do colaborador.  lastRowId: última linha retornada. Método: copyDocumentToUploadArea(String user. String password. String colleagueId) Parâmetros:  user: login do colaborador. companyId. int companyId. String password.  colleagueId: matrícula do colaborador.ECM . Retorno: DocumentDto[]. Método: restoreDocument(String user. int documentId.  documentId: número do documento excluído.Webservices companyId.  password: senha do colaborador. Método: findRecycledDocuments(String user. String colleagueId) Parâmetros:  user: login do colaborador.  companyId: código da empresa. int documentId.  password: senha do colaborador.  companyId: código da empresa. Copia os arquivos (principal e anexos) de um documento para a area de upload do usuário.  password: senha do colaborador. Isto permite que os documentos tornem-se acessíveis via FTP. Retorno: WebServiceMessage[].  colleagueId: matrícula do colaborador. int documentId.  documentId: número do documento restaurado. int companyId. String colleagueId) 17 . que será findRecycledDocuments restoreDocument int que será copyDocumentToUploadAre a Retorno: WebServiceMessage[]. int version. Restaura um documento da lixeira. String password. Retorna os documentos da lixeira. String colleagueId) Parâmetros:  user: login do colaborador.  companyId: código da empresa.  colleagueId: matrícula do colaborador. moveDocument updateGroupSecurityType Método: updateGroupSecurityType(String user. int documentId. String colleagueId) Parâmetros:     user: código do usuário de integração. int companyId. companyId: código da empresa. String password.  companyId: código da empresa. Existem duas opções que são representadas por um inteiro: 0 . int[] documentIds.  documentId: número do documento que será copiado. int restrictionType. int version.TODOS os colaboradores dos Grupos.  version: versão do documento  colleagueId: matrícula do colaborador cuja área de upload será utilizada Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload Move documentos para pasta destino. Retorno: String[] Modifica a tipo da segurança dos grupos na permissão e na restrição. 18 .SOMENTE colaboradores comuns dos grupos.Webservices Parâmetros:  user: login do colaborador.  password: senha do colaborador. int destfolder) Parâmetros:  user: login do colaborador. 1 .  password: senha do colaborador. int companyId. String colleagueId. password: senha do usuário de integração. String password.  companyId: código da empresa. Método: moveDocument(String user. int permissionType.ECM .  colleagueId: matrícula do colaborador com permissão para mover o documento  destFolder: número da pasta de destino. documentId: código do documento.  documentIds: lista com os números dos documentos que serão movidos. TODOS os colaboradores dos Grupos / 1 . Retorno: DocumentApprovalStatusDto[] getDocumentApprovalHistory Retorna o histórico de aprovacoes do documento solicitado.Em aprovação.Webservices   version: versão do documento. int companyId. 1 . String password. int version) Parâmetros:      user: código do usuário de integração. password: senha do usuário de integração. version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento). Método: getDocumentApprovalStatus(String user. companyId: código da empresa. Metodo: 19 .SOMENTE colaboradores comuns dos grupos)  colleagueId: matrícula do colaborador Retorno: WebServiceMessage[] getDocumentApprovalStatus Retorna o status do documento com relação a aprovação. permissionType: tipo da permissão (0 .TODOS os colaboradores dos Grupos / 1 .ECM . documentId: código do documento que se deseja visualizar o status.SOMENTE colaboradores comuns dos grupos)  restrictionType: tipo da restrição (0 . int documentId. 2. O status do documento pode ser: 0 – Aprovado.Rejeitado. int companyId. documentId: código do documento a ser aprovado. password: senha do usuário de integração. approverId: código do aprovador approved: true se aprova o documento e false caso o documento sera reprovado. String userId. Metodo: approveDocument(int companyId. String password. version: versão do documento a ser aprovado. int documentId. Retorno: WebServiceMessage[] 20 . version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento). boolean approved. int version) Parâmetros:      user: código do usuário de integração. companyId: código da empresa. observation: observação da aprovação ou rejeição. password: senha do usuário de integração. String observation) Parâmetros:         user: código do usuário de integração. Retorno: DocumentApprovementHistoryDto[] approveDocument Aprova ou reprova documento pendente de aprovação. companyId: código da empresa. int documentId. String approverId.Webservices getDocumentApprovalHistory(String user. String password.ECM . documentId: código do documento que se deseja visualizar o status. int version. publisherId: código do publicador. String login. Retorno: WebServiceMessage[] copyDocuments Realiza a cópia de vários documentos e pastas em uma única requisição. password: senha do usuário de integração. int companyId.ECM . destination: pasta destino das cópias. companyId: código da empresa. String password. userId: código do usuário. Metodo: copyDocuments(int companyId. String publisherId) Parâmetros:      user: código do usuário de integração. Metodo: destroyDocumentApproval(String userId. Retorno: CopyDocumentDto[] Quadro 2: Métodos da DocumentService 21 . origins: lista de documentos a serem copiados. documentId: código do documento a excluido. String password. Integer[] origins. String userId. Integer destination) Parâmetros:       companyId: código da empresa. int documentId. password: senha do usuário de integração. login: login ou código do usuário de integração.Webservices destroyDocumentApproval Exclui documento pendente de aprovação. java. 22 .ECM .Webservices 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. esta exemplifica a utilização de todos os métodos da classe DocumentService. Inicia uma solicitação. Métodos No quadro 3.  processId: código do processo.  cardData: dados da ficha.  companyId: código da empresa. ProcessTaskAppointmentDto[] appointment. String password. int companyId. startProcess 23 .  password: senha do colaborador. int choosedState. Método: startProcess(String user. String processId. é mostrado todos os métodos disponíveis na classe WorkflowEngineService. String[] colleagueIds. ProcessAttachmentDto[] attachments. simpleStartProcess Inicia uma solicitação simples.  companyId: código da empresa.  attachments: anexos da solicitação. String[][] cardData. Retorno: String[]. String password. String processId. int companyId. String cardData[][]) Parâmetros:  user: login do colaborador. boolean completeTask. Pode ser utilizado para movimentar solicitações.ECM . String comments. String userId.  comments: comentários.  password: senha do colaborador. ProcessAttachmentDto[] attachments. entre outras funcionalidades. Método: simpleStartProcess(String user.Webservices WorkflowEngineService Webservices responsável por realizar operações referentes a workflow no ECM. boolean managerMode) Parâmetros:  user: login do colaborador. String comments.  processId: código do processo. int choosedState.ECM . boolean completeTask.  choosedState: número da atividade. startProcessClassic Retorno: String[][]. ProcessTaskAppointmentDto[] appointment.Webservices          choosedState: número da atividade. userId: matrícula do colaborador que vai iniciar a solicitação. String comments.  completeTask: indica se deve completar a tarefa (true) ou somente salvar (false). Altera a data de prazo da tarefa.  companyId: código da empresa. KeyValueDto[] cardData.  cardData: dados da ficha. Retorno: String[][]. colleagueIds: colaborador que receberá a tarefa.  colleagueIds: colaborador que receberá a tarefa. int companyId.  userId: matrícula do colaborador que vai iniciar a solicitação. appointment: apontamentos da tarefa.  password: senha do colaborador. managerMode: indica se colaborador esta iniciando a solicitação como gestor do processo. completeTask: indica se deve completar a tarefa (true) ou somente salvar (false). boolean managerMode) Parâmetros:  user: login do colaborador. ProcessAttachmentDto[] attachments. String password. attachments: anexos da solicitação.  processId: código do processo. comments: comentários. String userId.  comments: comentários.  attachments: anexos da solicitação. Inicia uma solicitação e retorna um array de objeto com chave e valor. Método: startProcessClassic(String user. setDueDate 24 . cardData: dados da ficha. String[] colleagueIds. String processId.  appointment: apontamentos da tarefa.  managerMode: indica se colaborador esta iniciando a solicitação como gestor do processo. int timeInSeconds) Parâmetros:  user: login do colaborador. String password. Altera os comentários da tarefa. Método: cancelInstance(String user.ECM . Se não existir o valor é 0 (zero).  processInstanceId: número da solicitação. caso exista. companyId. String comments) setTasksComments int int Parâmetros:  user: login do colaborador. int processInstanceId. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.  companyId: código da empresa. String newDueDate.  password: senha do colaborador. int threadSequence. int companyId. threadSequence. int companyId. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.  threadSequence: Indica se existe atividade paralela no processo.  password: senha do colaborador.Webservices Método: setDueDate(String user.  userId: mátricula do colaborador. String password.  processInstanceId: número da solicitação. Cancela uma solicitação. Retorno: String.  newDueDate: nova data de prazo da tarefa. Método: setTasksComments(String user.  companyId: código da empresa. String password.  timeInSeconds: quantidade de segundos após a meia noite. String userId. int processInstanceId.  comments: comentários. Retorno: String. caso exista. cancelInstance 25 .  userId: mátricula do colaborador. Se não existir o valor é 0 (zero).  threadSequence: Indica se existe atividade paralela no processo. String userId. ECM - Webservices int processInstanceId, String userId, String cancelText) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  processInstanceId: número da solicitação;  userId: mátricula do colaborador;  cancelText: comentários do cancelamento. Retorno: String. Cancela uma solicitação utilizando colaborador substituto. Método: cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  processInstanceId: número da solicitação;  userId: mátricula do colaborador;  cancelText: comentários do cancelamento;  replacementId: matrícula do colaborador substituto. Retorno: String. Retorna o valor de um campo da ficha. Método: getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  processInstanceId: número da solicitação;  userId: mátricula do colaborador;  cardFieldName: nome do campo da ficha. Retorno: String. Movimenta solicitação para próxima atividade. Método: cancelInstanceByReplaceme nt getCardValue saveAndSendTask 26 ECM - Webservices saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  processInstanceId: número da solicitação;  choosedState: número da atividade;  colleagueIds: colaborador que receberá a tarefa;  comments: comentários;  userId: matrícula do colaborador que vai executar a tarefa;  completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);  attachments: anexos da solicitação;  cardData: dados da ficha;  appointment: apontamentos da tarefa;  managerMode: indica se colaborador esta executando a tarefa como gestor do processo;  threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. Retorno: String[][]. Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor. Método: saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa; saveAndSendTaskClassic 27 ECM - Webservices            processInstanceId: número da solicitação; choosedState: número da atividade; colleagueIds: colaborador que receberá a tarefa; comments: comentários; userId: matrícula do colaborador que vai executar a tarefa; completeTask: indica se deve completar a tarefa (true) ou somente salvar (false); attachments: anexos da solicitação; cardData: dados da ficha; appointment: apontamentos da tarefa; managerMode: indica se colaborador esta executando a tarefa como gestor do processo; threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. saveAndSendTaskByReplac ement Retorno: KeyValueDto[]. Movimenta solicitação para próxima atividade utilizando colaborador substituto. Método: saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId) Parâmetros:  user: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  processInstanceId: número da solicitação;  choosedState: número da atividade;  colleagueIds: colaborador que receberá a tarefa;  comments: comentários;  userId: matrícula do colaborador que vai executar a tarefa;  completeTask: indica se deve completar a tarefa (true) ou somente salvar (false);  attachments: anexos da solicitação;  cardData: dados da ficha; 28 boolean managerMode. managerMode: indica se colaborador esta executando a tarefa como gestor do processo. Seleciona usuário(s) e avança atividade automática. Se não existir o valor é 0 (zero). Método: 29 . int iTask. iTaskAutom: número da atividade automática. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. takeProcessTask Retorno: KeyValueDto[] Assume uma tarefa. String[] colleagueIds. int iTaskAutom. Metodo: setAutomaticDecisionClassic(String user. processInstanceId: número da solicitação. replacementId: matrícula do colaborador substituto. iTask: numero da atividade atual. String comments. int condition. colleagueIds: colaborador que receberá a tarefa.ECM . int threadSequence) Parâmetros:             user: login do colaborador. String password. threadSequence: Indica se existe atividade paralela no processo. threadSequence: Indica se existe atividade paralela no processo. companyId: código da empresa. comments: comentários. managerMode: indica se colaborador esta executando a tarefa como gestor do processo. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.Webservices    appointment: apontamentos da tarefa. Se não existir o valor é 0 (zero). int companyId. userId: matrícula do colaborador que vai executar a tarefa. password: senha do colaborador.  setAutomaticDecisionClassic Retorno: String[][]. int processInstanceId. condition: numero da condição da atividade automática. caso exista. String userId. caso exista.  processInstanceId: número da solicitação. int processInstanceId.  userId: matrícula do colaborador. String password.  threadSequence: Indica se existe atividade paralela no processo. Método: getAttachments(String user.  password: senha do colaborador. caso exista.  userId: matrícula do colaborador. companyId.  password: senha do colaborador. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. caso exista. Retorno: String. getAttachments 30 . String userId. Método: takeProcessTask(String user.ECM . threadSequence. Se não existir o valor é 0 (zero). String password. threadSequence) int int Parâmetros:  user: login do colaborador. String userId. int companyId.Webservices takeProcessTask(String user.  replacementId: matrícula do colaborador substituto. int processInstanceId) Parâmetros:  user: login do colaborador.  processInstanceId: número da solicitação.  threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero). Assume uma tarefa utilizando colaborador substituto. Retorno: String.  companyId: código da empresa. companyId. String replacementId) takeProcessTaskByReplace ment int int Parâmetros:  user: login do colaborador.  companyId: código da empresa. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. String password. Retorna os anexos de uma solicitação. int processInstanceId. String userId.  companyId: código da empresa. processInstanceId: número da solicitação.  processInstanceId: número da solicitação. int processInstanceId) Parâmetros:  user: login do colaborador. userId: matrícula do colaborador.  password: senha do colaborador. Retorno: Integer[]. companyId: código da empresa. Retorna o número da próxima atividade de uma solicitação. companyId. Método: getActualThread(String user. int processInstanceId. Retorna o número da atividade em que uma solicitação esta. Retorna a sequência da thread de uma solicitação. String password. Método: getAvailableStates(String user.ECM . String password.Webservices     password: senha do colaborador. String userId. int processInstanceId. String processId. int companyId. Retorno: int.  stateSequence: sequência do estado. int threadSequence) Parâmetros:  user: login do colaborador. companyId.  companyId: código da empresa. String password.  userId: matrícula do colaborador. int getActualThread int getAvailableStates 31 . Método: getAllActiveStates(String user.  processId: código do processo. getAllActiveStates Retorno: ProcessAttachmentDto[].  userId: matrícula do colaborador.  password: senha do colaborador.  companyId: código da empresa. int stateSequence) Parâmetros:  user: login do colaborador.  password: senha do colaborador.  state: número da atividade.  processId: código do processo.  password: senha do colaborador. getAvailableStatesDetail Retorno: Integer[].ECM .Webservices   processInstanceId: número da solicitação.  threadSequence: Indica se existe atividade paralela no processo. String password. Se não existir o valor é 0 (zero). Método: getAvailableUsers(String username.  password: senha do colaborador.  companyId: código da empresa.  threadSequence: Indica se existe atividade paralela no processo. caso exista. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. Se não existir o valor é 0 (zero). int state.  processInstanceId: número da solicitação.. Retorna detalhes das atividades disponíveis para seleção. Método: getAvailableStatesDetail(String user. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. int processInstanceId.  companyId: código da empresa. String processId. Retorna os colaboradores que podem executar a tarefa corrente de uma solicitação. Se não existir o valor é 0 (zero). int companyId. int threadSequence) Parâmetros:  username: login do colaborador. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas getAvailableUsers 32 . caso exista. int threadSequence) Parâmetros:  user: login do colaborador. String password. Retorno: ProcessStateDto[]. int companyId. caso exista.  processInstanceId: número da solicitação. threadSequence: Indica se existe atividade paralela no processo. int processInstanceId. String password. Retorno: String[].  userSearch: texto a ser buscado.  state: número da atividade.  processInstanceId: número da solicitação. Retorno: AvailableUsersDto. Método: getInstanceCardData(String user. int processInstanceId) Parâmetros:  user: login do colaborador. Retorno: String[][].  companyId: código da empresa. String password. Se não existir o valor é 0 (zero). String userId.  initialUser: última linha retornada.  password: senha do colaborador. int limit.  threadSequence: Indica se existe atividade paralela no processo. Retorna os processos que o colaborador pode iniciar uma solicitação. int getAvailableUsersOnDeman d getInstanceCardData int getAvailableProcess 33 . String userSearch) Parâmetros:  username: login do colaborador. caso exista. Retorna os colaboradores que podem executar a tarefa corrente de uma solicitação. String password. int state. int processInstanceId.  userId: matrícula do colaborador. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. companyId. int companyId. Método: getAvailableProcess(String username. Retorna o valor dos campos da ficha de uma solicitação.ECM .  companyId: código da empresa.  processInstanceId: número da solicitação.Webservices existentes no processo. paginados e com busca. int initialUser.  limit: número de registros a serem retornados. Método: getAvailableUsersOnDemand(String username.  password: senha do colaborador. int threadSequence.  password: senha do colaborador. String password.  password: senha do colaborador. DocumentDto[] docdtos. String userId) Parâmetros:  username: login do colaborador. Método: updateWorkflowAttachment(String username. paginados. int companyId.ECM .  userId: matrícula do colaborador.  lastRowId: última linha retornada. int companyId.  companyId: código da empresa. Método: getAvailableProcessOnDemand(String username. Retorna os processos que o colaborador pode iniciar uma solicitação. Attachment[] attach) Parâmetros:  username: login do colaborador. String usuario. int lastRowId) Parâmetros:  username: login do colaborador. int limit. String userId. Atualiza um documento do tipo 7. getAvailableProcessOnDema nd updateWorkflowAttachment getAvailableUsersStart 34 .  processInstanceId: número da solicitação workflow  usuario: usuário responsável pela edição do documento.  userId: matrícula do colaborador. int processInstanceId. String password. Retorna uma string contendo a descrição de sucesso ou falha da operação.  password: senha do colaborador.Webservices companyId.  docDtos: documento ou documentos que serão publicados. Retorno: ProcessDefinitionVersionDto[].  companyId: código da empresa.  attachs: arquivo(s) anexado(s) na publicação.  limit: número de registros a serem retornados. Retorna os colaboradores disponíveis na abertura de uma solicitação.  companyId: código da empresa. Retorno: ProcessDefinitionVersionDto[].  companyId: código da empresa. String password.  companyId: código da empresa.  processId: código do processo. getAvailableUsersStartOnDe mand importProcess 35 .  state: número da atividade. String userSearch) Parâmetros:  username: login do colaborador. int state.  limit: número de registros a serem retornados. Retorna os colaboradores disponíveis na abertura de uma solicitação. caso exista.  state: número da atividade.  threadSequence: Indica se existe atividade paralela no processo. paginados e com busca. String processId.  processId: código do processo. int companyId. int companyId. int limit. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.  initialUser: última linha retornada. int companyId. int threadSequence. String password. int threadSequence) Parâmetros:  username: login do colaborador. Retorno: String[]. String processId. Retorno: AvailableUsersDto. este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo. Método: getAvailableUsersStart (String username. Se não existir o valor é 0 (zero). Importa processos workflow.  threadSequence: Indica se existe atividade paralela no processo.  userSearch: texto a ser buscado.Webservices Método: getAvailableUsersStart (String username. caso exista. int state.  password: senha do colaborador. Se não existir o valor é 0 (zero).ECM . int initialUser. Método: importProcess(String user. String password.  password: senha do colaborador. String colleagueId) Parâmetros:  user: login do colaborador.  overWrite: indica se as atividade e fluxos do processo existente dever ser sobrescritas. String password.data (Tipo String no formato "yyyy-MM-dd").ECM . String data. String data.  segundos .Código da empresa  userId . Método: calculateDeadLineHours(String username. String password. int segundos. boolean overWrite.Prazo que será aplicado em horas (Variável int). int segundos. String userId.  colleagueId : matrícula do colaborador.Webservices String processId. Método: calculateDeadLineHours(String username.  password: senha do colaborador.  companyId: código da empresa. String periodId) Parâmetros: 36 .Código de Expediente Retorno: Objeto DeadLineDto que contem variáveis com a data e hora. String periodId) Parâmetros:  username . Retorno: String. calculateDeadLineTime Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos. int prazo. boolean newProcess.  processId: código do processo. int prazo. calculateDeadLineHours Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas.  newProcess: indica se deve ser criado um processo ou atualizado o existente.Matrícula do usuário  data .Senha de Integração  companyId . int companyId.Quantidade de segundos após a meia noite  prazo . Attachment file. int companyId.Usuário de Integração  password . String userId.  file: arquivo a ser importado.  periodId . String password. int companyId.Código de Expediente Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.Senha de Integração companyId . segundos .Código da empresa Retorno: ProcessDefinitionDto[]. periodId .Senha de Integração  companyId .Usuário de Integração  password . int companyId) Parâmetros:  username .Usuário de Integração  password .Webservices         username . Método: getAllProcessAvailableToExport (String username. int companyId) Parâmetros:  username . exportProcess Retorna o processo selecionado em uma String. String password.Senha de Integração  companyId . Método: exportProcess (String username.Usuário de Integração password . Método: getAllProcessAvailableToImport (String username.Senha de Integração  companyId .Quantidade de segundos após a meia noite prazo . 37 .Código da empresa Retorno: ProcessDefinitionDto[] getAllProcessAvailableToExp ort Retorna uma lista de processos disponíveis para serem exportados.ECM . String password.Código da empresa  processId .data (Tipo String no formato "yyyy-MM-dd").Prazo que será aplicado em minutos (Variável int). String processId) Parâmetros:  username .Matrícula do usuário data .Código do processo Retorno: String que contém a definição do processo getAllProcessAvailableToImp ort Retorna uma lista de processos disponíveis para serem importados.Usuário de Integração  password .Código da empresa userId . searchProcess Busca processo disponíveis para inicialização. Método: getHistories (String username. 38 .Matrícula do usuário  processInstanceId .java. String content. Retorno: ProcessDefinitionVersionDto[] Quadro 3: Métodos da WorkflowEngineService Exemplo de utilização No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosWorkflowEngineService é disponibilizada a classe WorkflowEngineServiceClient.ECM .Senha de Integração companyId .Matrícula do usuário content – nome do processo a ser pesquisado favorite – busca da lista de processos favoritos ou da listagem padrão.Usuário de Integração  password . String Password. int companyId. int companyId) Parâmetros:  username .Código da empresa colleagueId .Usuário de Integração password . esta exemplifica a utilização de todos os métodos da classe WorkflowEngineService. String password.número da solicitação workflow Retorno: ProcessHistoryDto[].Webservices getHistories Retorna lista de históricos de um processo.Senha de Integração  companyId . boolean favorite) Parametros       user . String colleagueId. Metodo: searchProcess(String user.Código da empresa  userId . String password. Cria um grupo no ECM. Retorno: GroupDto[].  password: senha do colaborador.ECM . entre outras funcionalidades.  companyId: código da empresa. companyId. getGroups Retorna todos os grupos cadastrados no ECM.Webservices GroupService Webservices responsável por realizar operações referentes a grupos no ECM.  groupId: código do grupo. int companyId) Parâmetros:  username: login do colaborador. Métodos No quadro 4. int companyId. Método: getGroups(String username. String groupId) Parâmetros:  username: login do colaborador. Retorna um grupo cadastrado no ECM. String password.  companyId: código da empresa. é mostrado todos os métodos disponíveis na classe GroupService. Método: getGroups(String username. Método: createGroup(String username.  password: senha do colaborador. int Parâmetros:  username: login do colaborador. 39 . excluir e procurar grupos. GroupDto[] grupos) getGroup createGroup String password. alterar. Retorno: GroupDto[]. Pode ser utilizado para criar.  password: senha do colaborador.  pIdiAtribuic: código da atribuição.Webservices    password: senha do colaborador. grupos: grupo que será criado. String pDesValAtribuic) Parâmetros:  username: login do colaborador.  companyId: código da empresa. getGroupsByDescription getOcurrenceByKey 40 . Retorno: String. int companyId.  password: senha do colaborador.  companyId: código da empresa. String password. GroupDto[] grupos) String password. Retorno: boolean.  pDesValAtribuic: valor da atribuição. updateGroup Retorno: String. Retorna se existe configuração de segurança para atribuição e valor da atribuição. int Parâmetros:  username: login do colaborador.  password: senha do colaborador. String password. Método: updateGroup(String username. companyId: código da empresa. Retorno: GroupDto[]. Retorna um grupo pela descrição.  grupos: grupo que será alterado.  desc: descrição do grupo. Método: getOcurrenceByKey(String username. companyId. int companyId.ECM . int pIdiAtribuic. Método: getGroupsByDescription(String username.  companyId: código da empresa. Altera um grupo no ECM. String desc) Parâmetros:  username: login do colaborador. companyId.ECM .Webservices deleteGroup Exclui um grupo do ECM. Método: deleteGroup(String username. 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. Retorno: String.java. esta exemplifica a utilização de todos os métodos da classe GroupService.  password: senha do colaborador.  companyId: código da empresa.  GroupId: código do grupo. int Parâmetros:  username: login do colaborador. 41 . String groupId) String password. String colleagueId) Parâmetros:  user: login do colaborador.  companyId: código da empresa. Pode ser utilizado para pesquisar os documentos e processos favoritos de cada colaborador.  password: senha do colaborador.  lastRowId: última linha retornada.  companyId: código da empresa. Retorna os processos favoritos do colaborador. Retorno: DocumentDto[]. findFavoritesOnDemand favoritos do colaborador. findFavorites Retorna os documentos favoritos do colaborador. String password. String password.  password: senha do colaborador. String password. Método: findFavorites(String user. int limit. int findFavoritesProcess 42 . int lastRowId) Parâmetros:  user: login do colaborador. Método: findFavoritesOnDemand(String user. Método No quadro 5. int companyId. Retorna os documentos paginados. Método: findFavoritesProcess (String user.ECM . Retorno: DocumentDto[].Webservices FavoritesService Webservices responsável por interagir com os documentos e processos favoritos do ECM.  colleagueId : matrícula do colaborador.  colleagueId : matrícula do colaborador. int companyId. String colleagueId.  limit: número de registros a serem retornados. é mostrado os métodos disponíveis na classe FavoritesService.  password: senha do colaborador. Método: addDocumentToFavorites(String username.  limit: número de registros a serem retornados.Webservices companyId.  companyId: código da empresa.  colleagueId : matrícula do colaborador. int nrVersao. String colleagueId) Parâmetros:  user: login do colaborador.  companyId: código da empresa.ECM . String password. String colleagueId) Parâmetros:       username: login do colaborador. addDocumentToFavorites Adiciona um documento aos favoritos do colaborador informado. nrDocument: número do documento nrVersao: versão do documento colleagueId : matrícula do colaborador. Retorno: ProcessDefinitionVersionDto[] . paginados. Retorno: ProcessDefinitionVersionDto[] .  lastRowId: última linha retornada. Método: findFavoritesProcess (String user. String colleagueId) Parâmetros:  user: login do colaborador. 43 . int companyId. Retorna os processos favoritos do colaborador.  colleagueId : matrícula do colaborador. companyId: código da empresa. int nrDocument. String password.  password: senha do colaborador. findFavoritesProcessOnDema nd removeFavoriteDocument Remove um documento dos favoritos do colaborador informado. int companyId. password: senha do colaborador. nrDocument: número do documento colleagueId : matrícula do colaborador. processId: código do processo. String colleagueId) Parâmetros:      username: login do colaborador.String processId. int nrDocument. int companyId.Webservices Método: removeFavoriteDocument (String username. password: senha do colaborador. String password. companyId: código da empresa. 44 . int companyId. String password. addProcessToFavorites Adiciona um processo aos favoritos do colaborador informado. processId: código do processo colleagueId : matrícula do colaborador. String password. companyId: código da empresa. password: senha do colaborador. Método: addProcessToFavorites(String username. String colleagueId) Parâmetros:     username: login do colaborador. Método: addProcessToFavorites(String username. removeFavoriteProcess Remove um processo dos favoritos do colaborador informado. companyId: código da empresa. String colleagueId) Parâmetros:      username: login do colaborador. password: senha do colaborador. int companyId.ECM .String processId. ECM - Webservices  isFavoriteDocument colleagueId : matrícula do colaborador. Verifica se documento é favorito. Metodo: isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId) Parâmetros:      username: login do usuário de integração; password: senha do colaborador; companyId: código da empresa; nrDocument: código do documento; colleagueId: matricula do colaborador. Retorno: Boolean 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. 45 ECM - Webservices CompanyService 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. getCompanies Retorna todas as empresas cadastradas no ECM. Método: getCompanies(String username, String password, String companyId) Parâmetros:  username: login do colaborador;  password: senha do colaborador;  companyId: código da empresa. Retorno: CompanyDto[]. Retorna uma empresa cadastrada no ECM. Método: getCompany(int companyId) Parâmetros:  companyId: código da empresa. Retorno: CompanyDto. Cria uma empresa no ECM. Método: createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort) Parâmetros:  username: login do colaborador;  password: senha do colaborador;  companyId: código da empresa; getCompany createCompany 46 ECM - Webservices      description: descrição da empresa; urlAccessName: URL de acesso; phisicalPath: caminho físico; webdeskServer: servidor; webPort: porta. updateCompany Retorno: String. Altera uma empresa no ECM. Método: updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort) Parâmetros:  username: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  description: descrição da empresa;  urlAccessName: URL de acesso;  phisicalPath: caminho físico;  webdeskServer: servidor;  webPort: porta. Retorno: String. Exclui uma empresa do ECM. Método: delete(String username, String password, String companyId, Boolean deleteFiles) Parâmetros:  username: login do colaborador;  password: senha do colaborador;  companyId: código da empresa;  deleteFiles: indica se deve excluir o caminho físico. Retorno: String. Quadro 6: Métodos da CompanyService delete 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 47 java. 48 .Webservices CompanyServiceClient. esta exemplifica a utilização de todos os métodos da classe CompanyService.ECM . Pode ser utilizado para buscar documentos utilizando a busca simples e avançada.  password: senha do colaborador.  password: senha do colaborador. Retorno: SearchResultDto[].  colleagueId: matrícula do colaborador. String colleagueId.ECM . Date startDate. boolean findCardIndex. String content) Parâmetros:  user: login do colaborador.  findAllDocumentTypes: indica se deve buscar todos os tipos de documentos. int companyId. Date finalDate) Parâmetros:  user: login do colaborador.  colleagueId: matrícula do colaborador. boolean findCards. Método: advancedSearchDocuments(String user.  companyId: código da empresa.Webservices SearchDocumentService Webservices responsável por realizar operações referentes às buscas no ECM. int advancedSearchDocuments 49 . String content. String colleagueId. searchDocuments Utiliza busca simples. String password. Métodos No quadro 7. Método: searchDocuments(String user. boolean findFolders. String password. companyId. boolean findExternalDocument.  content: conteúdo da busca.  companyId: código da empresa.  content: conteúdo da busca. int documentParentId. boolean findDocuments. Utiliza busca avançada. boolean findAllDocumentTypes. é mostrado todos os métodos disponíveis na classe SearchDocumentService. documentParentId: número do documento pai.ECM . findCards: indica se deve buscar fichas.  colleagueId: matrícula do colaborador. esta exemplifica a utilização de todos os métodos da classe SearchDocumentService. String colleagueId.java.  password: senha do colaborador.Webservices         findFolders: indica se deve buscar pastas. Busca documentos favoritos. String content) Parametros:  user: login do colaborador. searchFavoritesDocuments Retorno: SearchResultDto[]. Metodo: searchFavoritesDocuments(String user. finalDate: data final. findDocuments: indica se deve buscar documentos.  companyId: código da empresa. findCardIndex: indica se deve buscar fichários. 50 .  contente: conteúdo a ser buscado Retorno: SearchResultDto[] 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. String Password. startDate: data inicial. findExternalDocument: indica se deve buscar documentos externos. int companyId. getColleagueGroupsByColle agueId Retorna os grupos de usuários que um colaborador participa. Pode ser utilizado para relacionar um colaborador a um grupo de usuários e serve também para alterar. Retorno: ColleagueGroupDto[]. String groupId) Parâmetros:  username: login do colaborador.ECM . int companyId. Retorna todos os grupos de usuários que possuem colaboradores relacionados.  password: senha do colaborador. Método: getColleagueGroupsByGrou pId String getAllColleagueGroups 51 . Método: getColleagueGroupsByColleagueId(String username. int companyId.  colleagueId: matrícula do colaborador.  companyId: código da empresa.  companyId: código da empresa. excluir e pesquisar esses relacionamentos criados. Retorno: ColleagueGroupDto[]. password. Retorna os colaboradores que participam de um grupo de usuários.  groupId: código do grupo. String password. String colleagueId) Parâmetros:  username: login do colaborador. Método: getColleagueGroupsByGroupId(String username.  password: senha do colaborador.Webservices ColleagueGroupService Webservices responsável por realizar operações referentes aos grupos de usuários no ECM. Métodos No quadro 8. é mostrado todos os métodos disponíveis na classe ColleagueGroupService. Método: updateColleagueGroup(String username. Método: createColleagueGroup(String username. int companyId. String password. Retorno: ColleagueGroupDto[]. Retorno: String. Retorna somente um grupo de usuários que um colaborador participa. ColleagueGroupDto[] grupo_colaborador) Parâmetros:  username: login do colaborador. int companyId. ColleagueGroupDto[] grupo_colaborador) Parâmetros: getColleagueGroup createColleagueGroup updateColleagueGroup 52 .ECM . String colleagueId) Parâmetros:  username: login do colaborador. String password. Retorno: ColleagueGroupDto[].  colleagueId: matrícula do colaborador.  password: senha do colaborador.  companyId: código da empresa.  groupId: código do grupo.  password: senha do colaborador. String password.  password: senha do colaborador. String groupId. Associa um colaborador a um grupo de usuários.  companyId: código da empresa. int companyId) Parâmetros:  username: login do colaborador.  grupo_colaborador: grupo de usuários que estará associado a um colaborador. Altera a associação de um colaborador a um grupo de usuários.Webservices getAllColleagueGroups(String username.  companyId: código da empresa. Método: getColleagueGroup(String username. String password. int companyId. java. password: senha do colaborador.  password: senha do colaborador.ECM . 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. esta exemplifica a utilização de todos os métodos da classe ColleagueGroupService. companyId: código da empresa. Retorno: String. String groupId.  colleagueId: matrícula do colaborador. int companyId. Exclui um colaborador de um grupo de usuários. String password. grupo_colaborador: grupo de usuários que será alterado. deleteColleagueGroup Retorno: String. String colleagueId) Parâmetros:  username: login do colaborador.  companyId: código da empresa.Webservices     username: login do colaborador.  groupId: código do grupo. 53 . Método: deleteColleagueGroup(String username. int Parâmetros:  username: login do colaborador. updateColleague e updateColleaguewithDependencies.Webservices ColleagueService Webservices responsável por realizar operações referentes a colaboradores no ECM. String password. recebe uma lista de ColleagueDto. companyId.  companyId: código da empresa.  colleagueId: matrícula do colaborador. int Parâmetros:  username: login do colaborador. é mostrado todos os métodos disponíveis na classe ColleagueService. Retorno: ColleagueDto[].  password: senha do colaborador. Método: getColleague(String username.  password: senha do colaborador. Retorna um colaborador. getGroups 54 . entre outras funcionalidades. Retorno: ColleagueDto[]. String colleagueId) getColleague String password.ECM . createColleaguewithDependencies. Os métodos createColleague. Métodos No quadro 9. Método: getColleagues(String companyId) username. getColleagues Retorna todos os colaboradores ativos. alterar. Pode ser utilizado para criar. nos objetos destas listas os valores para os campos de senha (password) devem ser criptografados com o algoritmo de hash MD5. em um dos seus paramtros. Retorna os grupos de usuários que o colaborador participa.  companyId: código da empresa. excluir e pesquisar colaboradores.  colegas: colaboradores. String colleagueId) Parâmetros:  username: login do colaborador.Webservices Método: getGroups(String username. Método: createColleague(String username. Retorno: String. Cria um colaborador com grupo de segurança e papéis workflow.  password: senha do colaborador. Cria um colaborador. WorkflowRoleDto[] papeis) Parâmetros:  username: login do colaborador. Retorno: String. int companyId. Retorno: GroupDto[]. int createColleaguewithDepend encies updateColleague 55 . String password. String password. Método: createColleaguewithDependencies(String username. GroupDto[] grupos.  colegas: colaboradores.  grupos: grupos de segurança. String companyId.  colleagueId: matrícula do colaborador.  companyId: código da empresa.  companyId: código da empresa. int companyId.  password: senha do colaborador.  password: senha do colaborador.  papeis: papéis workflow. int createColleague password. String password. ColleagueDto[] colegas. Altera um colaborador.  companyId: código da empresa. ColleagueDto[] colegas) Parâmetros:  username: login do colaborador. Método: updateColleague(String username.ECM .  colegas: colaboradores. String password. Método: updateColleaguewithDependencies(String username. int companyId. String password. String colleagId) Parâmetros:  username: login do colaborador. Altera um colaborador com grupo de segurança e papéis workflow. GroupDto[] grupos. WorkflowRoleDto[] papeis) Parâmetros:  username: login do colaborador. ColleagueDto[] colegas.  companyId: código da empresa.  grupos: grupos de segurança. Retorna todos os colaboradores ativos.  papeis: papéis workflow.  companyId: código da empresa.  password: senha do colaborador.Webservices companyId.  companyId: código da empresa. Método: removeColleague(String username.  colegas: colaboradores.ECM . Retorno: String. int companyId.  password: senha do colaborador. updateColleaguewithDepend encies removeColleague getSummaryColleagues 56 . Método: getSummaryColleagues(int companyId) Parâmetros:  companyId: código da empresa. Retorno: String.  colleagId: matrícula do colaborador. Exclui um colaborador. Retorno: String. ColleagueDto[] colegas) Parâmetros:  username: login do colaborador.  password: senha do colaborador. Método: getSimpleColleague(String username. Valida o acesso de um colaborador no produto. Quadro 9: Métodos da ColleagueService getColleaguesMail getSimpleColleague 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.  password: senha do colaborador. Retorno: ColleagueDto.  password: senha do colaborador.  companyId: código da empresa. Retorno: ColleagueDto[].  password: senha do colaborador. String mail) Parâmetros:  username: login do colaborador. int companyId.ECM . String password) Parâmetros:  companyId: código da empresa. esta exemplifica a utilização de todos os 57 . String colleagueId. Método: validateColleagueLogin(int companyId. Retorna um colaborador utilizando um e-mail. String password) Parâmetros:  username: login do colaborador.  mail: e-mail do colaborador. String password. Retorno: String.  colleagueId: matrícula do colaborador.Webservices validateColleagueLogin Retorno: ColleagueDto[]. Retorna o colaborador.java. Método: getColleaguesMail(String username. 58 .Webservices métodos da classe ColleagueService.ECM . Método: getReplacementsOfUser(String username. entre outras funcionalidades. String colleagueId. Retorno: ColleagueReplacementDto[].  password: senha do colaborador. excluir e pesquisar colaboradores substitutos.  colleagueId: matrícula do colaborador origem.  password: senha do colaborador. Retorna todos os colaboradores substituidos por um substituto válido. password. String password. Método: getColleagueReplacement(String username.ECM . int companyId. getColleagueReplacement Retorna um substituto de um colaborador.  replacementId: matrícula do colaborador substituto. Pode ser utilizado para criar. é mostrado todos os métodos disponíveis na classe ColleagueReplacementService. String colleagueId) Parâmetros:  username: login do colaborador.  colleagueId: matrícula do colaborador origem. Retorna todos os substitutos de um colaborador. replacementId) String String Parâmetros:  username: login do colaborador.  companyId: código da empresa. Método: getReplacementsOfUser getValidReplacedUsers 59 . int companyId. alterar. Métodos No quadro 10. Retorno: ColleagueReplacementDto.  companyId: código da empresa.Webservices ColleagueReplacementService Webservices responsável por realizar operações referentes a colaboradores substitutos no ECM.  companyId: código da empresa.Webservices getValidReplacedUsers(String username. Retorno: ColleagueReplacementDto[]. int companyId. Retorno: ColleagueReplacementDto[]. int companyId. Cria um substituto. String password. int companyId.ECM .  password: senha do colaborador.  companyId: código da empresa.  replacementId: matrícula do colaborador substituto. ColleagueReplacementDto crDto) Parâmetros:  username: login do colaborador. Retorna todos os substitutos válidos de um colaborador.  companyId: código da empresa. String password. getValidReplacement getValidReplacementsOfUse r String createColleagueReplacemen t 60 . Método: createColleagueReplacement (String username. Método: getValidReplacement(String username. Retorna um substituto válido de um colaborador. Retorno: ColleagueReplacementDto. String password. String colleagueId) Parâmetros:  username: login do colaborador.  replacementId: matrícula do colaborador substituto. String colleagueId.  colleagueId: matrícula do colaborador origem.  password: senha do colaborador. String replacementId) Parâmetros:  username: login do colaborador.  password: senha do colaborador.  password: senha do colaborador. password. int companyId. String replacementId) Parâmetros:  username: login do colaborador.  colleagueId: matrícula do colaborador origem. Método: getValidReplacementsOfUser(String username.  companyId: código da empresa.Webservices   companyId: código da empresa.  colleagueId: matrícula do colaborador origem. Método: updateColleagueReplacement (String username. Retorno: String.java. updateColleagueReplaceme nt Retorno: String. String replacementId) deleteColleagueReplacemen t username. Altera o cadastro de um substituto. crDto: cadastro do substituto. Método: deleteColleagueReplacement(String password.  crDto: cadastro do substituto. esta exemplifica a utilização de todos os métodos da classe ColleagueReplacementService.ECM . int companyId. ColleagueReplacementDto crDto) Parâmetros:  username: login do colaborador. 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.  replacementId: matrícula do colaborador substituto. colleagueId. int companyId. 61 . String String Parâmetros:  username: login do colaborador. Exclui o cadastro de um substituto. String password.  companyId: código da empresa.  password: senha do colaborador.  password: senha do colaborador. Retorno: String. Pode ser utilizado para criar.  password: senha do colaborador. Retorna a segurança de uma pasta. excluir e pesquisar pastas. int nrDocumentId. int nrDocumentId) Parâmetros:  user: login do colaborador.  colleagueId: matrícula do colaborador origem.ECM .  nrDocumentId: número da pasta. int companyId. é mostrado todos os métodos disponíveis na classe FolderService.  password: senha do colaborador. int nrDocumentId) getSecurity getApprovers 62 . String colleagueId ) Parâmetros:  user: login do colaborador. entre outras funcionalidades. Método: getFolder(String user. Retorno: DocumentSecurityConfigDto[]. getFolder Retorna uma pasta.Webservices FolderService Webservices responsável por realizar operações referentes a pastas no ECM. int companyId. Método: getApprovers(String user.  nrDocumentId: número da pasta. String password. String password. Métodos No quadro 11. Retorno: DocumentDto[].  companyId: código da empresa. alterar. String password. Retorna os aprovadores de uma pasta. Método: getSecurity(String user.  companyId: código da empresa. int companyId.  companyId: código da empresa.  companyId: código da empresa. Método: createFolder createFolderWithApproveme ntLevels updateFolder 63 . String password. DocumentSecurityConfigDto[] docsecurity.  password: senha do colaborador.  companyId: código da empresa.  password: senha do colaborador.ECM .  levels: níveis de aprovação da pasta. Cria uma pasta. Altera uma pasta. ApproverWithLevelDto[] docapprovers.  docsecurity: segurança da pasta. Retorno: WebServiceMessage[]. Método: createFolderWithApprovementLevels(String user. int companyId. DocumentDto[] docdtos.Webservices Parâmetros:  user: login do colaborador. ApproverDto[] docapprovers ) Parâmetros:  user: login do colaborador.  docdtos: pasta que será criada.  docdtos: pasta que será criada. DocumentDto[] docdtos. int companyId. ApprovalLevelDto[] levels) Parâmetros:  user: login do colaborador. Cria uma pasta com nível de aprovação.  docsecurity: segurança da pasta.  docapprovers: aprovadores da pasta. String password. DocumentSecurityConfigDto[] docsecurity. Retorno: ApproverWithLevelDto[].  docapprovers: aprovadores em níveis.  nrDocumentId: número da pasta.  password: senha do colaborador. Método: createFolder(String user. Retorno: WebServiceMessage[]. ApprovalLevelDto[] levels) Parâmetros:  user: login do colaborador.  docapprovers: aprovadores da pasta. DocumentDto[] docdtos. Método: updateFolderWithApprovementLevels(String user.  docdtos: pasta que será alterada. Altera uma pasta com nível de aprovação. ApproverWithLevelDto[] docapprovers. Altera de forma simples uma pasta.  companyId: código da empresa. String password.  docapprovers: aprovadores em níveis. DocumentSecurityConfigDto[] docsecurity.  companyId: código da empresa.  levels: níveis de aprovação da pasta. ApproverDto[] docapprovers) Parâmetros:  user: login do colaborador. DocumentDto[] docdtos) Parâmetros:  user: login do colaborador  password: senha do colaborador  companyId: código da empresa  docdtos: pasta que será alterada. String password.Webservices updateFolder(String user. int companyId. Retorno: WebServiceMessage[]. Retorna as pastas root que um colaborador tem acesso.  password: senha do colaborador. DocumentSecurityConfigDto[] docsecurity.  docsecurity: segurança da pasta.  docsecurity: segurança da pasta. int getRootFolders 64 . updateFolderWithApproveme ntLevels updateSimpleFolder Password.  password: senha do colaborador. Método: updateSimpleFolder(String user. int companyId. DocumentDto[] docdtos.ECM . String companyId. Retorno: WebServiceMessage[].  docdtos: pasta que será alterada. Retorno: WebServiceMessage[]. int parentDocumentId) Parâmetros:  user: login do colaborador. String password.  companyId: código da empresa. Retorna todos os documentos de uma pasta. Retorno: DocumentDto[].Webservices exceto a pasta particular. Método: getRootFolders(String user.  companyId: código da empresa. Método: getChildren(String user.  password: senha do colaborador. Método: getSubFolders(String user.  documentId: número da pasta. Método: getPrivateChildren(String user.  password: senha do colaborador. String colleagueId) getChildren getPrivateChildren password. int documentId. String companyId. String colleagueId) Parâmetros:  user: login do colaborador. getSubFolders Retorna todas as subpastas e arquivos de um pasta. int 65 .  colleagueId: matrícula do colaborador.  colleagueId: matrícula do colaborador.  password: senha do colaborador. int documentId. Retorno: DocumentDto[]. String password. int companyId. String password. Retorno: DocumentDto[]. int companyId. String colleagueId) Parâmetros:  user: login do colaborador.ECM . Retorna todos os documentos de uma pasta particular.  companyId: código da empresa.  documentId: número da pasta. int companyId. Cria uma pasta simples.Webservices Parâmetros:  user: login do colaborador. paginados. Método: getUserPermissions(int companyId.  password: senha do colaborador.  password: senha do colaborador. int limit . Retorno: DocumentDto[].  nrDocumentId: número da pasta. String password. int companyId. String password.  companyId: código da empresa. int lastRowId.  companyId: código da empresa.  colleagueId: matrícula do colaborador.  colleagueId: matrícula do colaborador. Retorna a permissão de um colaborador sobre uma pasta.  user: matrícula do colaborador. int companyId. Retorno: DocumentDto[].  lastRowId: última linha retornada. Retorna todas as subpastas e arquivos de um pasta. int version) Parâmetros:  companyId: código da empresa. int createSimpleFolder 66 . nrDocumentId.ECM . String colleagueId) Parâmetros:  user: login do colaborador.  version: versão da pasta.  documentId: número da pasta. Método: createSimpleFolder(String user. Retorno: Integer. String documentDescription) getSubFoldersOnDemand getUserPermissions String user. String publisherId. Método: getSubFoldersOnDemand(String user. int parentDocumentId. int documentId.  documentId: número da pasta.  limit: número de registros a serem retornados.  permission: permissão sobre a pasta. Retorna todas as subpastas de uma pasta particular. Método: getSubPrivateFolders(String colleagueId. int companyId. Método: deleteDocument(String user. Retorna todas as subspastas em que o colaborador tenha a permissão informada.Webservices Parâmetros:  user: login do colaborador.  password: senha do colaborador.ECM .  documentId: número da pasta particular.  password: senha do colaborador. String password.  password: senha do colaborador. int companyId.  publisherId: matrícula do colaborador publicador. int documentId. int documentId) Parâmetros:  colleagueId: matrícula do colaborador.  colleagueId: matrícula do colaborador. Exclui uma pasta e envia para a lixeira.  companyId: código da empresa. int companyId. Retorno: DocumentDto[].  companyId: código da empresa. String colleagueId) getSubPrivateFolders getSubFoldersPermission deleteDocument 67 .  parentDocumentId: número do documento pai. Método: getSubFoldersPermission(String user. String password.  documentDescription: descrição da pasta. Retorno: WebServiceMessage[]. String password. int documentId.  companyId: código da empresa.  documentId: número da pasta particular. Retorno: DocumentDto[]. int permission) Parâmetros:  user: login do colaborador. String colleagueId. Retorno: WebServiceMessage[].  password: senha do colaborador. String password.  companyId: código da empresa.ECM . String password.  password: senha do colaborador. Retorno: WebServiceMessage[]. String password. String colleagueId) Parâmetros:  user: login do colaborador. String colleagueId) Parâmetros:  user: login do colaborador.  companyId: código da empresa.  documentId: número da pasta. String colleagueId) Parâmetros:  user: login do colaborador.  colleagueId: matrícula do colaborador.  companyId: código da empresa. Método: restoreDocument(String user.  password: senha do colaborador. companyId. int documentId. Retorna todos os documentos da lixeira de um colaborador. Retorno: DocumentDto[]. int documentId. Exclui uma pasta da lixeira.  companyId: código da empresa.  documentId: número da pasta. destroyDocument int findRecycledDocuments restoreDocument int 68 . Método: findRecycledDocuments(String user. companyId. int companyId.  colleagueId: matrícula do colaborador.Webservices Parâmetros:  user: login do colaborador. Restaura uma pasta da lixeira. Método: destroyDocument(String user.  password: senha do colaborador.  colleagueId: matrícula do colaborador.  documentId: número da pasta. esta exemplifica a utilização de todos os métodos da classe FolderService. 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. 69 .java.Webservices  colleagueId: matrícula do colaborador. Retorno: WebServiceMessage[].ECM . Retorno: WebServiceMessage[]. CardDto[] carddtos) create String user. Método: deleteCard(int companyId. entre outras funcionalidades. CardFieldDto[] cardData) String Parâmetros:  companyId: código da empresa.  user: login do colaborador. String user. updateCardData Altera os campos de uma ficha. Cria uma ficha. Exclui uma ficha e envia para a lixeira. String password.ECM .  user: login do colaborador. Retorno: WebServiceMessage[].Webservices CardService Webservices responsável por realizar operações referentes a fichas no ECM.  password: senha do colaborador.  password: senha do colaborador.  cardId: número da ficha. é mostrado todos os métodos disponíveis na classe CardService. Método: updateCardData(int companyId. Métodos No quadro 12.  carddtos: ficha que será criada. String user.  cardData: campos da ficha que serão alterados. Método: create(int companyId. excluir e pesquisar fichas. Pode ser utilizado para criar. alterar. password. String password. int cardId) deleteCard 70 . Parâmetros:  companyId: código da empresa. int cardId. String user.Webservices Parâmetros:  companyId: código da empresa. Método: getCardVersion(int companyId. String colleagueId) Método: Parâmetros:  companyId: código da empresa. Método: updateCard(int companyId. Retorno: CardDto[]. Retorno: WebServiceMessage[]. Retorno: WebServiceMessage[]. DocumentSecurityConfigDto[] docsecurity.  user: login do colaborador. int nrDocumentId.  attachs: anexos da ficha. Quadro 12: Métodos da CardService updateCard getCardVersion 71 . String user. RelatedDocumentDto[] reldocs) Parâmetros:  companyId: código da empresa. ApproverDto[] docapprovers. int version.  docapprovers: aprovadores da ficha.  version: versão da ficha.ECM .  colleagueId: matrícula do colaborador. Altera os metadados de uma ficha. String password.  nrDocumentId: número da ficha. Retorna a versão de uma ficha. Attachment[] attachs.  docsecurity: segurança da ficha.  user: login do colaborador.  password: senha do colaborador.  password: senha do colaborador.  password: senha do colaborador. CardDto[] cardDtos.  cardDtos: ficha que será alterada. String password.  user: login do colaborador.  cardId: número da ficha.  reldocs: documentos relacionados da ficha. Webservices Exemplo de utilização No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardService é disponibilizada a classe CardServiceClient.ECM . 72 .java. esta exemplifica a utilização de todos os métodos da classe CardService. Métodos No quadro 13. Quadro 13: Métodos da TokenService validateToken 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. Retorno: String. Valida o token de segurança e retorna o login do colaborador.java. é mostrado todos os métodos disponíveis na classe TokenService. Método: validateToken(String token) Parâmetro:  token: token do colaborador.  password: senha do colaborador. Método: getToken(String login.Webservices TokenService Webservices responsável por interagir com os token’s do ECM. 73 .ECM . Pode ser utilizado para pesquisar e validar os token’s existentes. String password) Parâmetros:  login: login do colaborador. esta exemplifica a utilização de todos os métodos da classe TokenService. getToken Retorna um token de segurança. Retorno: String. createCustomFields Cria um campo customizado.  companyId: código da empresa.ECM . String password.  password: senha do colaborador. companyId. Pode ser utilizado para criar.  companyId: código da empresa. Método: removeCustomField(String removeCustomField user. CustomFieldsDto[] customFieldsDto) int Parâmetros:  user: login do colaborador. Exclui um campo customizado.  customFieldsDto: campo customizado que será criado. Altera um campo customizado. CustomFieldsDto[] customFieldsDto) updateCustomFields int Parâmetros:  user: login do colaborador. int 74 . companyId.  customFieldsDto: campo customizado que será alterado. excluir e pesquisar campos customizados. Retorno: String.  password: senha do colaborador. alterar.Webservices CustomFieldsService Webservices responsável por interagir com os campos customizados do ECM. Método: createCustomFields(String user. Método: updateCustomFields(String user. entre outras funcionalidades. String password. Métodos No quadro 14. String password. é mostrado todos os métodos disponíveis na classe CustomFieldsService. Retorno: String. String customFieldsId) Parâmetros:  user: login do colaborador.ECM . int companyId.Webservices companyId. Método: removeDocumentCustomField(String user. String customFieldsId. Método: getAllCustomField(String companyId) getAllCustomField user. setDocumentCustomFields removeDocumentCustomFiel d 75 . Cria ou altera um campo customizado em um documento. int version) Parâmetros:  user: login do colaborador. int documentId.  companyId: código da empresa. Retorno: String. String password.  documentCustomFieldsDto: documento com campo customizado. Método: setDocumentCustomFields(String user.  password: senha do colaborador.  password: senha do colaborador. Retorno: String. Exclui um campo customizado de um documento.  customFieldsId: código do campo customizado. int companyId. String password. Retorno: CustomFieldsDto[]. String password. Retorna todos os campos customizados. DocumentCustomFieldsDto[] documentCustomFieldsDto) Parâmetros:  user: login do colaborador.  password: senha do colaborador.  companyId: código da empresa. int Parâmetros:  user: login do colaborador.  companyId: código da empresa.  password: senha do colaborador. 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.  documentId: número do documento. int version) Parâmetros:  user: login do colaborador. getAllDocumentCustomField Retorno: String. String password. customFieldsId: código do campo customizado.  password: senha do colaborador. Retorna todos os campos customizados de um documento.java. 76 .ECM . Método: getAllDocumentCustomField(String user. esta exemplifica a utilização de todos os métodos da classe CustomFieldsService. Retorno: DocumentCustomFieldsDto[].  version: versão do documento. version: versão do documento.Webservices     companyId: código da empresa.  companyId: código da empresa. documentId: número do documento. int documentId. int companyId. Quadro 15: Métodos da OutstandingService Exemplo de utilização No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosOutstandingService é disponibilizada a classe OutstandingServiceClient. transfer Transfere pendências de um colaborador para outro colaborador.  password: senha do colaborador.  colleagueIdFrom: matrícula do colaborador origem (suas pendências serão tranferidas para o colaborador destino).  parameters: array de pendências que serão transferidas para o colaborador destino. Pode ser utilizado para transferir pendências de um colaborador para outro colaborador. String colleagueIdFrom. String password. esta exemplifica a utilização de todos os métodos da classe OutstandingService. int companyId.  companyId: código da empresa. String[] parameters) Parâmetros:  user: login do colaborador.Webservices OutstandingService Webservices responsável por interagir com as transferências de pendências do ECM.java. Método: transfer(String user. Retorno: String. é mostrado o método disponível na classe OutstandingService.ECM . 77 .  colleagueIdTo: matrícula do colaborador destino (receberá as pendências do colaborador origem). String colleagueIdTo. Método No quadro 15. é mostrado todos os métodos disponíveis na classe GlobalParamService. GlobalParamDto[] global) Parâmetros: createGlobalParam updateGlobalParam 78 . getGlobalParam Retorna os parâmetros gerais de uma empresa.Webservices GlobalParamService Webservices responsável por interagir com as configurações dos parâmetros gerais do ECM. String password.  password: senha do colaborador. Cria parâmetros gerais para uma empresa. GlobalParamDto[] global) Parâmetros:  username: login do colaborador. Método: getGlobalParam(String companyId) username.  global: parâmetros gerais da empresa. alterar e pesquisar os parâmetros gerais. Retorno: GlobalParamDto[].  companyId: código da empresa. Método: createGlobalParam(String username. String password. Altera parâmetros gerais de uma empresa. int Parâmetros:  username: login do colaborador. int companyId. Retorno: String. Método: updateGlobalParam(String username. String password. Pode ser utilizado para criar.ECM . Métodos No quadro 16.  companyId: código da empresa. int companyId.  password: senha do colaborador. String emailSender. String emailPort.ECM .String paramsRMTPTPort. Método: updateConfigurations( String username. boolean emailDefaultSender. String paramsLSHost. Retorna os volumes da empresa.Webservices     username: login do colaborador. String dbUser.  password: senha do colaborador. String dbDriver. Retorna as informações de configuração do sistema. int companyId) Parâmetros:  username: login do colaborador. int companyId) Parâmetros:  user: login do colaborador. password: senha do colaborador. String emailPassword.  password: senha do colaborador. String emailUser. int companyId. boolean emailTLS. Retorno: SystemInfo. Altera as configurações do sistema. String dbServer.String password. Método: getConfigurations(String username. String password. String dbPort. getConfigurations updateConfigurations 79 . Retorno: VolumeDto[]. String dbPassword. String password. String paramsOpenOfficePorts.  companyId: código da empresa.  password: senha do colaborador.  companyId: código da empresa. global: parâmetros gerais da empresa. String emailServer. getVolumes Retorno: String.String dbScheme. String dbInstance. String paramsLSPort. companyId: código da empresa. String portsSetName) Parâmetros:  username: login do colaborador. String paramsOpenOfficeDir. String lsType. Método: getVolumes(String user. Webservices   companyId: código da empresa. dbPassword: password banco de dados.OracleDriver) dbUser: username banco de dados. SQLServer net. lsType: tipo de licença utilizada. paramsLSPort: porta servidor de licenças.Driver. 80 . caso não seja o caso passar em branco ("").jdbc. emailPassword: password do email. ports-01. 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. emailSender: e-mail do remetente padrão do produto. Oracle oracle. paramsOpenOfficeDir: diretório de instalação do OpenOffice paramsOpenOfficePorts: porta utilizado pelo OpenOffice portsSetName: porta utilizadas pelo sistema (portsdefault.jdbc.Driver.mysql. emailServer: nome do servidor SMTP. dbPort: porta servidor banco de dados. ports-02)                     Retorno: String.sourceforge. paramsLSHost: servidor de licenças.ECM .jdbc.java.driver. utilizada para SQLServer. dbServer: servidor de conexão do banco de dados. esta exemplifica a utilização de todos os métodos da classe GlobalParamService. LM/LS. somente se o servidor necessitar de autenticação. dbScheme: database.jtds. somente se o servidor necessitar de autenticação. emailPort: porta do servidor SMTP. dbInstance: instância do banco. emailTLS: servidor utilizará criptografia no envio de email (true/false) paramsRMTPTPort: porta utilizada pelo Flex. dbDriver: driver do banco de dados (MySqlcom. emailDefaultSender: emailUser: usuário de email. Método: findMyDocumentsOnDemand(String user.  password: senha do colaborador. é mostrado todos os métodos disponíveis na classe DashBoardService.  password: senha do colaborador. String password. Método No quadro 17. companyId. Retorno: DocumentDto[].  companyId: código da empresa. paginados.ECM . String colleagueId. Retorna os documentos do colaborador que precisam ser aprovados. Retorno: DocumentDto[]. int limit.  colleagueId: matrícula do colaborador. Método: findMyDocuments(String user.  lastRowId: última linha retornada. int Parâmetros:  user: login do colaborador. int companyId. int lastRowId) Parâmetros:  user: login do colaborador.Webservices DashBoardService Webservices responsável por interagir com a central de tarefas do ECM. Retorna os documentos que o colaborador precisa aprovar. Pode ser utilizado para pesquisar as informações que estão disponíveis na central de tarefas. findMyDocumentsOnDemand findDocumentsToApprove 81 . findMyDocuments Retorna os documentos do colaborador que precisam ser aprovados.  limit: número de registros a serem retornados.  companyId: código da empresa. String colleagueId) String password.  colleagueId: matrícula do colaborador. Método: findAgreementDocuments(String user. int companyId.  lastRowId: última linha retornada. int companyId. String colleagueId) Parâmetros:  user: login do colaborador. String colleagueId) Parâmetros:  user: login do colaborador. Método: findDocumentsToApproveOnDemand(String user.  colleagueId: matrícula do colaborador. String password.  colleagueId: matrícula do colaborador. Retorna os documentos do colaborador que estão em checkout.ECM . int limit.Webservices Método: findDocumentsToApprove(String user. Retorno: DocumentDto[]. paginados. String password.  password: senha do colaborador.  colleagueId: matrícula do colaborador. String password. Método: findDocumentsToApproveOnD emand findAgreementDocuments findCheckoutDocuments 82 .  companyId: código da empresa.  password: senha do colaborador. Retorna os documentos do colaborador que estão em consenso. int lastRowId) Parâmetros:  user: login do colaborador.  companyId: código da empresa. int companyId.  companyId: código da empresa. Retorna os documentos que o colaborador precisa aprovar. Retorno: DocumentDto[].  password: senha do colaborador. String colleagueId.  limit: número de registros a serem retornados. Retorno: DocumentDto[]. Retorna as tarefas atribuidas ao colaborador que foram canceladas.  companyId: código da empresa. companyId. int Parâmetros:  user: login do colaborador. Retorna as tarefas atribuidas ao colaborador que foram finalizadas. int companyId.Webservices findCheckoutDocuments(String user. Retorno: DocumentDto[]. String colleagueId) findCancelledTasks String password.  companyId: código da empresa. int companyId.ECM .  colleagueId: matrícula do colaborador.  password: senha do colaborador. Método: findConsensusTasks(String user. String colleagueId) Parâmetros: findConsensusTasks 83 .  password: senha do colaborador. companyId. String colleagueId) findCompletedTasks String password. String password. String colleagueId) Parâmetros:  user: login do colaborador. Retorno: WorkflowProcessDto[]. Retorno: WorkflowProcessDto[].  colleagueId: matrícula do colaborador. String password. Método: findCancelledTasks(String user. Método: findCompletedTasks(String user. int Parâmetros:  user: login do colaborador.  colleagueId: matrícula do colaborador.  password: senha do colaborador. Retorna as tarefas atribuidas ao colaborador que estão em consenso.  companyId: código da empresa. Método: findWorkflowTasksOnDemand(String user. findTransferredTasks Retorno: WorkflowProcessDto[]. Retorna as tarefas do colaborador que estão abertas. String colleagueId. Retorna as tarefas atribuidas ao colaborador que foram transferidas. String password. companyId: código da empresa. int limit.  password: senha do colaborador. paginadas. String password.  colleagueId: matrícula do colaborador.  password: senha do colaborador. Método: findWorkflowTasks(String user. Retorno: WorkflowProcessDto[]. int lastRowId) Parâmetros:  user: login do colaborador.  colleagueId: matrícula do colaborador.Webservices     user: login do colaborador.  password: senha do colaborador. int companyId. int companyId. password: senha do colaborador.  companyId: código da empresa. int Parâmetros:  user: login do colaborador. colleagueId: matrícula do colaborador.  companyId: código da empresa. String colleagueId) Parâmetros:  user: login do colaborador. Retorna as tarefas do colaborador que estão abertas. Retorno: WorkflowProcessDto[].  colleagueId: matrícula do colaborador.ECM . findWorkflowTasksOnDemand 84 . String colleagueId) findWorkflowTasks String password. companyId. Método: findTransferredTasks(String user.  companyId: código da empresa.  limit: número de registros a serem retornados. int limit.  password: senha do colaborador. int lastRowId) Parâmetros:  user: login do colaborador.  password: senha do colaborador. String colleagueId.  companyId: código da empresa.  companyId: código da empresa. companyId.  lastRowId: última linha retornada. Retorna as solicitações abertas que foram inicializadas pelo colaborador. String password.  colleagueId: matrícula do colaborador.Webservices   limit: número de registros a serem retornados. int companyId.  colleagueId: matrícula do colaborador. Retorna as tarefas gerenciadas pelo colaborador. Método: findMyRequestsOnDemand(String user. String password.  companyId: código da empresa.  colleagueId: matrícula do colaborador. findMyRequestsOnDemand findMyManagerTasks 85 . lastRowId: última linha retornada. Retorno: WorkflowProcessDto[]. String colleagueId) Parâmetros:  user: login do colaborador. Método: findMyRequests(String user.  password: senha do colaborador. int companyId. Método: findMyManagerTasks(String user. String colleagueId) String password. Retorna as solicitações abertas que foram inicializadas pelo colaborador.ECM . Retorno: WorkflowProcessDto[]. findMyRequests Retorno: WorkflowProcessDto[]. int Parâmetros:  user: login do colaborador. paginadas. int dayIni. String colleagueId) Parâmetros:     user: login do colaborador. no prazo e sem prazo de um colaborador. int companyId. int companyId. fillChronoTasks 86 . int kindTask) Parâmetros:  user: login do colaborador.Webservices Retorno: WorkflowProcessDto[]. findExpiredWorkflowTasks Retorna as tarefas do colaborador que estão em atraso Método: findExpiredWorkflowTasks(String user. colleagueId: matrícula do colaborador. String colleagueId) Parâmetros:  user: login do colaborador. int yearFin.  colleagueId: matrícula do colaborador. Método: fillStatusTask(String user. fillStatusTask Retorna a quantidade de tarefas atrasadas. String password. int mounthFin. int mounthIni. int yearIni. String colleagueId.ECM . Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas ao colaborador e não foram finalizadas. String password. int dayFin. Retorno: int[]. Retorno: WorkflowProcessDto[]. password: senha do colaborador.  password: senha do colaborador. Método: fillChronoTasks(String user. int companyId. String password. companyId: código da empresa.  companyId: código da empresa. String colleagueId) Parâmetros:  user: login do colaborador. dayIni: dia inicial. fillTypeTasks Retorno: int[]. int companyId. Método: fillTypeTasks(String user.  colleagueId: matrícula do colaborador. String replacementId) Parâmetros:  user: login do colaborador.  replacementId: matrícula do colaborador substituto. Retorna os tipos de tarefas que o colaborador substituto possui. String colleagueId. String password. kindTask: tipo da tarefa. String password.  password: senha do colaborador. companyId: código da empresa. Método: fillTypeTasksOfReplacement(String user. dayFin: dia final.Webservices           password: senha do colaborador.  colleagueId: matrícula do colaborador. Retorna as tarefas atribuidas a um grupo de usuários que o colaborador participa. mounthFin: mês final. password. yearIni: ano inicial. Retorno: TaskVODto[].  companyId: código da empresa. Método: getOpenTasksByColleagueGroups(String user. mounthIni: mês inicial. int companyId.ECM . String colleagueId) fillTypeTasksOfReplacement getOpenTasksByColleagueGr oups String 87 . Retorno: TaskVODto[]. Retorna os tipos de tarefas que o colaborador possui. int companyId. colleagueId: matrícula do colaborador. yearFin: ano final.  companyId: código da empresa.  password: senha do colaborador. String colleagueId) Parâmetros:  user: login do colaborador. paginadas.ECM . int limit.  companyId: código da empresa. Retorno: WorkflowTaskDto[]. Método: getOpenTasksByColleagueGroupsOnDemand(String user. String password.Webservices Parâmetros:  user: login do colaborador. String colleagueId.  password: senha do colaborador. String password. password. paginadas.  password: senha do colaborador.  lastRowId: última linha retornada. int companyId. Retorna as tarefas atribuidas a um papel workflow que o colaborador participa.  colleagueId: matrícula do colaborador. int lastRowId) Parâmetros:  user: login do colaborador.  companyId: código da empresa. Retorna as tarefas atribuidas a um grupo de usuários que o colaborador participa. Retorno: WorkflowTaskDto[]. Retorna as tarefas atribuidas a um papel workflow que o colaborador participa. String colleagueId. int lastRowId) getOpenTasksByColleagueGr oupsOnDemand getOpenTasksByColleagueRol es String getOpenTasksByColleagueRol esOnDemand 88 .  password: senha do colaborador. int limit. Método: getOpenTasksByColleagueRolesOnDemand(String user. Retorno: WorkflowTaskDto[].  colleagueId: matrícula do colaborador. Método: getOpenTasksByColleagueRoles(String user. int companyId. int companyId.  companyId: código da empresa.  limit: número de registros a serem retornados.  colleagueId: matrícula do colaborador. Retorna os contadores de pendências da Home. Retorno: HomeRequestSummaryDto[].  limit: número de registros a serem retornados. String user. esta exemplifica a utilização de todos os métodos da classe DashBoardService. Método: getSummaryRequests(int companyId.  user: login do colaborador.  lastRowId: última linha retornada. String colleagueId) Parâmetros:  companyId: código da empresa. 89 .  colleagueId: matrícula do colaborador.  password: senha do colaborador.  password: senha do colaborador. Quadro 17: Métodos da DashBoardService getSummaryRequests 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. String password.java.ECM .  colleagueId: matrícula do colaborador. Retorno: WorkflowTaskDto[].Webservices Parâmetros:  user: login do colaborador.  companyId: código da empresa.  password: senha do colaborador. Método: getDataset(int companyId. Método: getAvailableDatasets(int companyId. Métodos No quadro 18.  user: login do colaborador.  constraintsDto: filtro dos registros que irão compor o dataset. String password. String user. String password) Parâmetros:  companyId: código da empresa. String[] fields.  fields: campos que serão retornados do dataset. SearchConstraintDto[] constraintsDto. Retorno: Object[]. getAvailableDatasets Retorna todos os datasets disponíveis. Pode ser utilizado para pesquisar os datasets existentes. String name.  order: campos utilizados para ordenar o dataset.  password: senha do colaborador.ECM . é mostrado todos os métodos disponíveis na classe DatasetService. Retorno: DatasetDto.  name: nome do dataset.Webservices DatasetService Webservices responsável por interagir com os datasets do ECM. String[] order) Parâmetros:  companyId: código da empresa. Retorna as informações de um dataset.  user: login do colaborador. Quadro 18: Métodos da DatasetService getDataset 90 . String user. ECM .java.Webservices 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. esta exemplifica a utilização de todos os métodos da classe DatasetService. 91 . Quadro 19: Métodos da BusinessPeriodService Exemplo de utilização No diretório de documentação do ECM na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosBusinessPeriodService é disponibilizada a classe BusinessPeriodServiceClient. Pode ser utilizado para pesquisar os expedientes de uma determinada empresa.Webservices BusinessPeriodService Webservices responsável por realizar operações referentes aos expedientes cadastrados no ECM. Métodos No quadro 19. String password.ECM .  companyId: código da empresa.java. Método: getBusinessPeriods(String user. esta exemplifica a utilização de todos os métodos da classe BusinessPeriodService.  password: senha do colaborador. Retorno: BusinessPeriodDto[]. 92 . int companyId) Parâmetros:  user: login do colaborador. getBusinessPeriods Retorna os expedientes da empresa. é mostrado todos os métodos disponíveis na classe BusinessPeriodService. Retorno: AttributionMecanismDto[]. Método: getAttributionMecanism(String user. getAttributionMecanism Retorna os mecanismos de atribuição da empresa. String password. 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. esta exemplifica a utilização de todos os métodos da classe AttributionMecanismService.java. int companyId) Parâmetros:  user: login do colaborador.  companyId: código da empresa. Pode ser utilizado para pesquisar os mecanismos de atribuição de uma determinada empresa. 93 .  password: senha do colaborador. é mostrado todos os métodos disponíveis na classe AttributionMecanismService. Métodos No quadro 20.ECM .Webservices AttributionMecanismService Webservices responsável por realizar operações referentes aos mecanismos de atribuição cadastrados no ECM. int documentId) Parâmetros:  user: login do colaborador. é mostrado todos os métodos disponíveis na classe CardIndexService. String colleagueId) Parâmetros:  user: login do colaborador. Método: getCardIndexesWithoutApprover(String user.  companyId: código da empresa.  colleagueId : matrícula do colaborador para a verificação de permissão nos fichários. Retorno: DocumentDto[]. Métodos No quadro 21. int companyId.  password: senha do colaborador. Método: getFormFields(String user. String password.  companyId: código da empresa.Webservices CardIndexService Webservices responsável por realizar operações referentes aos fichários cadastrados no ECM. Retorna os campos do fichário.ECM .  documentId : numero do fichário. Retorno: String[]. String password.  password: senha do colaborador. getCardIndexesWithoutAppr over Retorna os fichários sem aprovadores que o colaborador tenha permissão. Quadro 21: Métodos da CardIndexService getFormFields 94 . int companyId. 95 .Webservices 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.ECM .
Copyright © 2024 DOKUMEN.SITE Inc.