Você está na página 1de 88

ECM - Webservices

Guia de Referncia Utilizao


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 eletrnico ou mecnico, na sua totalidade ou em parte, sem a prvia autorizao
escrita da TOTVS S.A., que reserva-se o direito de efetuar alteraes sem aviso prvio. A TOTVS
S.A no assume nenhuma responsabilidade pelas conseqncias de quaisquer erros ou
inexatides que possam aparecer neste documento.
TOTVS S.A.
Av. Santos Dumont, 831, Joinville, SC, Brasil, CEP 89.222-900

ECM - Webservices

ndice
Objetivo............................................................................................... 6
Criar Stubs.......................................................................................... 6
Consideraes Mtodos de Update .................................................. 8
DocumentService ............................................................................... 9
Mtodos ......................................................................................................... 9
Exemplo de utilizao .................................................................................. 20

WorkflowEngineService .................................................................. 21
Mtodos ....................................................................................................... 21
Exemplo de utilizao .................................................................................. 33

GroupService.................................................................................... 34
Mtodos ....................................................................................................... 34
Exemplo de utilizao .................................................................................. 36

FavoritesService .............................................................................. 37
Mtodo ......................................................................................................... 37
Exemplo de utilizao .................................................................................. 40

CompanyService .............................................................................. 41
Mtodos ....................................................................................................... 41
Exemplo de utilizao .................................................................................. 42

SearchDocumentService ................................................................. 44
Mtodos ....................................................................................................... 44
Exemplo de utilizao .................................................................................. 45

ColleagueGroupService ................................................................... 46
Mtodos ....................................................................................................... 46
Exemplo de utilizao .................................................................................. 48

ECM - Webservices
ColleagueService ............................................................................. 49
Mtodos ....................................................................................................... 49
Exemplo de utilizao .................................................................................. 52

ColleagueReplacementService ....................................................... 53
Mtodos ....................................................................................................... 53
Exemplo de utilizao .................................................................................. 55

FolderService ................................................................................... 56
Mtodos ....................................................................................................... 56
Exemplo de utilizao .................................................................................. 62

CardService ...................................................................................... 63
Mtodos ....................................................................................................... 63
Exemplo de utilizao .................................................................................. 65

TokenService .................................................................................... 66
Mtodos ....................................................................................................... 66
Exemplo de utilizao .................................................................................. 66

CustomFieldsService ....................................................................... 67
Mtodos ....................................................................................................... 67
Exemplo de utilizao .................................................................................. 69

OutstandingService ......................................................................... 70
Mtodo ......................................................................................................... 70
Exemplo de utilizao .................................................................................. 70

GlobalParamService ........................................................................ 71
Mtodos ....................................................................................................... 71
Exemplo de utilizao .................................................................................. 73

DashBoardService ........................................................................... 74
Mtodo ......................................................................................................... 74
Exemplo de utilizao .................................................................................. 82

DatasetService ................................................................................. 83
Mtodos ....................................................................................................... 83

ECM - Webservices
Exemplo de utilizao .................................................................................. 84

BusinessPeriodService ................................................................... 85
Mtodos ....................................................................................................... 85
Exemplo de utilizao .................................................................................. 85

AttributionMecanismService ........................................................... 86
Mtodos ....................................................................................................... 86
Exemplo de utilizao .................................................................................. 86

CardIndexService ............................................................................. 87
Mtodos ....................................................................................................... 87
Exemplo de utilizao .................................................................................. 88

ECM - Webservices

Objetivo
O objetivo deste documento descrever a utilizao de Webservices, mostrar
e explicar todos seus mtodos, disponibilizar exemplos de classes que
utilizam esses Webservices e mostrar exemplos de gerao de stubs que so
necessrios para que os clients possam se comunicar com o servio.

Criar Stubs
Os stubs so necessrios para que os clients que utilizam os mtodos dos
Webservices possam se comunicar com o servio.
Para criar um stub necessrio que o servio do ECM esteja inicializado.
Depois de iniciar o servio, deve-se abrir o Prompt de comando e utilizar a
sintaxe: wsimport -d <output_directory> <wsdl_url>, onde output_directory o
diretrio onde o stub ser criado e wsdl_url a url de acesso ao servio. Aps
isso, basta apertar Enter e o resultado aparecer conforme mostra a figura 1.

Figura 1: Exemplo de criao de stub

No quadro 1, mostrado o comando necessrio para criao de stubs de


cada servio disponvel no ECM.

Webservices
WorkflowEngineService

Comando
wsimport
-d
C:\Webservices\tmp
http://<SERVER>:<PORT>/webdesk/WorkflowEngineService?w
sdl

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 criao de stubs

ECM - Webservices

Consideraes Mtodos de
Update
Para os mtodos de update que recebem objetos complexos (DocumentDto,
ColleagueDto, GroupDto, etc) obrigatrio passar todos os campos do objeto
alterado. Os campos no informados sero substitudos por branco, nulo ou
zero, dependendo do seu tipo.
Para evitar esta situao, sugerimos sempre utilizar os mtodos get para
recuperar o objeto, efetuar as alteraes nos campos necessrios e envi-lo
para o mtodo update.

ECM - Webservices

DocumentService
Webservices responsvel por realizar operaes referentes a documentos do
ECM. Pode ser utilizado para criar, alterar, excluir e procurar documentos,
entre outras funcionalidades.

Mtodos
No quadro 2, mostrado todos os mtodos disponveis na classe
DocumentService.

getActiveDocument

Retorna um documento ativo.


Mtodo:
getActiveDocument(String user, String password,
companyId, int nrDocumentId, String colleagueId)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
colleagueId: matrcula do colaborador.

getDocumentContent

Retorno: DocumentDto[].
Retorna o byte do arquivo fsico de um documento, caso o
usurio tenha permisso para acess-lo.
Mtodo:
getDocumentContent(String user, String password,
companyId, int nrDocumentId, String colleagueId,
documentoVersao, String nomeArquivo)

int
int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
colleagueId: matrcula do colaborador;
documentVersao: nmero da verso do documento;
nomeArquivo: nome do arquivo.

ECM - Webservices

getDocumentVersion

Retorno: byte[].
Retorna a verso de um documento.
Mtodo:
getDocumentVersion(String user, String password, int
companyId, int nrDocumentId, int version, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento;
colleagueId: matrcula do colaborador.

getDocumentByExternalId

Retorno: DocumentDto[].
Retorna um documento pelo cdigo externo.
Mtodo:
getDocumentByExternalId(String user, String password, int
companyId, String externalDocumentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
externalDocumentId: cdigo externo do documento;
colleagueId: matrcula do colaborador.

getSecurity

Retorno: DocumentDto[].
Retorna a segurana de um documento.
Mtodo:
getSecurity(String user, String password, int company, int
nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento.

getApprovers

Retorno: DocumentSecurityConfigDto[].
Retorna os aprovadores de um documento.

10

ECM - Webservices
Mtodo:
getApprovers(String user, String password, int companyId, int
nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento.

getRelatedDocuments

Retorno: ApproverWithLevelDto[].
Retorna todos os documentos
documento.

relacionados

de

um

Mtodo:
getRelatedDocuments(String user, String password, int
companyId, int nrDocumentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero do documento;
version: nmero da verso do documento.

createDocument

Retorno: RelatedDocumentDto[].
Cria um documento.
Mtodo:
createDocument(String
user,
String
password,
int
companyId, DocumentDto[] docDtos, Attachment[] attachs,
DocumentSecurityConfigDto[] docSecurity, ApproverDto[]
docApprovers, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser publicado;
attachs: arquivo anexado na publicao;
docSecurity: segurana do documento que ser
publicado;
docApprovers: aprovadores do documento que ser
publicado;
relDocs: documentos relacionados ao documento
que ser publicado.

11

ECM - Webservices

createDocumentWithApprove
mentLevels

Retorno: WebServiceMessage[].
Cria um documento com nvel de aprovao.
Mtodo:
createDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[]
attachs,
DocumentSecurityConfigDto[]
docSecurity, ApproverWithLevelDto[] docApproversLevels,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser publicado;
attachs: arquivo anexado na publicao;
docSecurity: segurana do documento que ser
publicado;
docApproversLevel: nvel de aprovao que os
aprovadores do documento esto inseridos;
levels: nveis de aprovao que o documento ter;
relDocs: documentos relacionados ao documento
que ser publicado.

updateDocument

Retorno: WebServiceMessage[].
Altera um documento.
Mtodo:
updateDocument(String
user,
String
password,
int
companyId, DocumentDto[] docDtos, Attachment[] attach,
DocumentSecurityConfigDto[] docSecurity, ApproverDto[]
docApprovers, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser alterado;
attachs: arquivo anexado na alterao;
docSecurity: segurana do documento que ser
alterado;
docApprovers: aprovadores do documento que ser
alterado;
relDocs: documentos relacionados ao documento
que ser alterado.

12

ECM - Webservices

updateSimpleDocument

Retorno: WebServiceMessage[].
Altera de forma simples um documento.
Mtodo:
updateSimpleDocument(String username, String password,
int companyId, int documentId, String publisherId, String
documentDescription, Attachment[] attachments)
Parmetros:
username: login do usurio de integrao;
password: senha do usurio de integrao;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
alterado;
publisherId: matrcula do colaborador que realizar a
alterao do documento;
documentDescription: descrio do documento;
attachments: arquivos anexados na alterao.

updateDocumentWithApprov
ementLevels

Retorno: WebServiceMessage[].
Altera um documento com nvel de aprovao.
Mtodos:
updateDocumentWithApprovementLevels(String user, String
password, int companyId, DocumentDto[] docDtos,
Attachment[]
attach,
DocumentSecurityConfigDto[]
docSecutiry,
ApproverWithLevelDto[]
docApprovers,
ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docDtos: documento que ser alterado;
attachs: arquivo anexado na alterao;
docSecurity: segurana do documento que ser
alterado;
docApprovers: nvel de aprovao que os
aprovadores do documento esto inseridos;
levels: nveis de aprovao que o documento ter;
relDocs: documentos relacionados ao documento
que ser alterado.

validateIntegrationRequireme

Retorno: WebServiceMessage[].
Verifica a integrao do colaborador no ECM.

13

ECM - Webservices
nts
Mtodo:
validateIntegrationRequirements
password, int companyId)

(String

user,

String

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

getReportSubjectId

Retorno: String.
Retorna o cdigo do assunto relatrios dentro do ECM.
Mtodo:
getReportSubjectId(String
companyId)

user,

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

removeSecurity

Retorno: int.
Remove a segurana de um documento.
Mtodo:
removeSecurity(String user, String password, int companyId,
int documentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento;
version: nmero da verso do documento.

getUserPermissions

Retorno: No h retorno.
Retorna as permisses do colaborador sobre um documento.
Mtodo:
getUserPermissions(int companyId,
nrDocumentId, int version)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;

14

String

user,

int

ECM - Webservices

createSimpleDocument

nrDocumentId: nmero do documento;


version: nmero da verso do documento.

Retorno: Integer.
Cria um documento simples.
Mtodo:
createSimpleDocument(String user, String password, int
company, int parentDocumentId, String publisherId, String
documentDescription, Attachment[] attachments)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
parentDocumentId: nmero da pasta pai;
publisherId: matrcula do colaborador que publicar o
documento;
documentDescription: descrio do documento;
attachments: arquivo anexado na publicao.

createSimpleDocumentPrivat
e

Retorno: WebServiceMessage[].
Cria um documento simples na pasta particular.
Mtodo:
createSimpleDocumentPrivate(String colleagueId, String
password, int companyId, int parentDocumentId, String
documentDescription, Attachment[] attachments)
Parmetros:
colleagueId: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
parentDocumentId: nmero da pasta pai;
documentDescription: descrio do documento;
attachments: arquivo anexado na publicao.

findMostPopularDocuments

Retorno: WebServiceMessage[].
Retorna os documentos mais acessados no ECM que o
colaborador tenha permisso de acesso.
Mtodo:
findMostPopularDocuments(String user, String password, int
companyId, String colleagueId, int nr_resultados)
Parmetros:

15

ECM - Webservices

findMostPopularDocumentsO
nDemand

user: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
nr_resultados: quantidade de documentos que sero
retornados.

Retorno: DocumentDto[].
Retorna os documentos mais acessados no ECM que o
colaborador tenha permisso de acesso, paginados.
Mtodo:
findMostPopularDocuments(String user, String password, int
companyId, String colleagueId, int nr_resultados, int limit, int
lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
nr_resultados: quantidade de documentos que sero
retornados;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

deleteDocument

Retorno: DocumentDto[].
Exclui um documento e o envia para a lixeira.
Mtodo:
deleteDocument(String user, String password, int companyId,
int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento
excludo;
colleagueId: matrcula do colaborador.

destroyDocument

que

ser

Retorno: WebServiceMessage[].
Exclui um documento da lixeira.
Mtodo:
destroyDocument(String

16

user,

String

password,

int

ECM - Webservices
companyId, int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento
excludo;
colleagueId: matrcula do colaborador.

findRecycledDocuments

que

ser

Retorno: WebServiceMessage[].
Retorna os documentos da lixeira.
Mtodo:
findRecycledDocuments(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

restoreDocument

Retorno: DocumentDto[].
Restaura um documento da lixeira.
Mtodo:
restoreDocument(String
user,
String
password,
companyId, int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento
restaurado;
colleagueId: matrcula do colaborador.

copyDocumentToUploadAre
a

que

int

ser

Retorno: WebServiceMessage[].
Copia os arquivos (principal e anexos) de um documento
para a area de upload do usurio. Isto permite que os
documentos tornem-se acessveis via FTP.
Mtodo:
copyDocumentToUploadArea(String user, String password,
int companyId, int documentId, int version, String
colleagueId)

17

ECM - Webservices
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento que ser
copiado;
version: verso do documento
colleagueId: matrcula do colaborador cuja rea de
upload ser utilizada

moveDocument

updateGroupSecurityType

Retorno: String[] nome dos arquivos que foram


disponibilizados na rea de upload
Move documentos para pasta destino.
Mtodo:
moveDocument(String user, String password, int companyId,
int[] documentIds, String colleagueId, int destfolder)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentIds: lista com os nmeros dos documentos
que sero movidos;
colleagueId: matrcula
do colaborador
com
permisso para mover o documento
destFolder: nmero da pasta de destino.
Retorno: String[]
Modifica a tipo da segurana dos grupos na permisso e na
restrio. Existem duas opes que so representadas por
um inteiro:
0 - TODOS os colaboradores dos Grupos.
1 - SOMENTE colaboradores comuns dos grupos;

Mtodo:
updateGroupSecurityType(String user, String password, int
companyId, int documentId, int version, int permissionType,
int restrictionType, String colleagueId)

Parmetros:

user: cdigo do usurio de integrao.

password: senha do usurio de integrao.

companyId: cdigo da empresa.

documentId: cdigo do documento.

18

ECM - Webservices

version: verso do documento.

permissionType: tipo da permisso (0 - TODOS os


colaboradores dos Grupos / 1 - SOMENTE
colaboradores comuns dos grupos)

restrictionType: tipo da restrio (0 - TODOS os


colaboradores dos Grupos / 1 - SOMENTE
colaboradores comuns dos grupos)

colleagueId: matrcula do colaborador

Retorno: WebServiceMessage[]
getDocumentApprovalStatus

Retorna o status do documento com relao a aprovao. O


status do documento pode ser:
0 Aprovado;
1 - Rejeitado;
2- Em aprovao.

Mtodo:

getDocumentApprovalStatus(String user, String password, int


companyId, int documentId, int version)

Parmetros:

user: cdigo do usurio de integrao;

password: senha do usurio de integrao;

companyId: cdigo da empresa;

documentId: cdigo do documento que se deseja


visualizar o status;

version: verso do documento (caso seja informada


a verso 0 sera solicitada a ultima verso do
documento).

Retorno: DocumentApprovalStatusDto[]
getDocumentApprovalHistory

Retorna o histrico de aprovacoes do documento solicitado.

Metodo:

19

ECM - Webservices
getDocumentApprovalHistory(String user, String password,
int companyId, int documentId,
int version)

Parmetros:

user: cdigo do usurio de integrao;

password: senha do usurio de integrao;

companyId: cdigo da empresa;

documentId: cdigo do documento que se deseja


visualizar o status;

version: verso do documento (caso seja informada


a verso 0 sera solicitada a ultima verso do
documento).

Retorno: DocumentApprovementHistoryDto[]

Quadro 2: Mtodos da DocumentService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosDocumentService

disponibilizada
a
classe
DocumentServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe DocumentService.

20

ECM - Webservices

WorkflowEngineService
Webservices responsvel por realizar operaes referentes a workflow no
ECM. Pode ser utilizado para movimentar solicitaes, entre outras
funcionalidades.

Mtodos
No quadro 3, mostrado todos os mtodos disponveis na classe
DocumentService.
simpleStartProcess

Inicia uma solicitao simples.


Mtodo:
simpleStartProcess(String user, String password, int
companyId,
String
processId,
String
comments,
ProcessAttachmentDto[] attachments, String cardData[][])
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
comments: comentrios;
attachments: anexos da solicitao;
cardData: dados da ficha.

startProcess

Retorno: String[].
Inicia uma solicitao.
Mtodo:
startProcess(String user, String password, int companyId,
String processId, int choosedState, String[] colleagueIds,
String comments, String userId, boolean completeTask,
ProcessAttachmentDto[] attachments, String[][] cardData,
ProcessTaskAppointmentDto[]
appointment,
boolean
managerMode)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;

21

ECM - Webservices

setDueDate

choosedState: nmero da atividade;


colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai iniciar a
solicitao;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
cardData: dados da ficha;
appointment: apontamentos da tarefa;
managerMode: indica se colaborador esta iniciando
a solicitao como gestor do processo.

Retorno: String[][].
Altera a data de prazo da tarefa.
Mtodo:
setDueDate(String user, String password, int companyId, int
processInstanceId, String userId, int threadSequence, String
newDueDate, int timeInSeconds)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
newDueDate: nova data de prazo da tarefa;
timeInSeconds: quantidade de segundos aps a
meia noite.

setTasksComments

Retorno: String.
Altera os comentrios da tarefa.
Mtodo:
setTasksComments(String user, String password,
companyId, int processInstanceId, String userId,
threadSequence, String comments)
Parmetros:
user: login do colaborador;

22

int
int

ECM - Webservices

cancelInstance

password: senha do colaborador;


companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
comments: comentrios.

Retorno: String.
Cancela uma solicitao.
Mtodo:
cancelInstance(String user, String password, int companyId,
int processInstanceId, String userId, String cancelText)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cancelText: comentrios do cancelamento.

cancelInstanceByReplaceme
nt

Retorno: String.
Cancela uma solicitao utilizando colaborador substituto.
Mtodo:
cancelInstanceByReplacement(String user, String password,
int companyId, int processInstanceId, String userId, String
cancelText, String replacementId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cancelText: comentrios do cancelamento;
replacementId: matrcula do colaborador substituto.

getCardValue

Retorno: String.
Retorna o valor de um campo da ficha.

23

ECM - Webservices
Mtodo:
getCardValue(String user, String password, int companyId,
int processInstanceId, String userId, String cardFieldName)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
userId: mtricula do colaborador;
cardFieldName: nome do campo da ficha.

saveAndSendTask

Retorno: String.
Movimenta solicitao para prxima atividade.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai executar a
tarefa;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
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 no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo.

24

ECM - Webservices

saveAndSendTaskByReplac
ement

Retorno: String[][].
Movimenta solicitao para prxima atividade utilizando
colaborador substituto.
Mtodo:
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)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
choosedState: nmero da atividade;
colleagueIds: colaborador que receber a tarefa;
comments: comentrios;
userId: matrcula do colaborador que vai executar a
tarefa;
completeTask: indica se deve completar a tarefa
(true) ou somente salvar (false);
attachments: anexos da solicitao;
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 no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
replacementId: matrcula do colaborador substituto.

takeProcessTask

Retorno: String[][].
Assume uma tarefa.
Mtodo:
takeProcessTask(String
user,
String
password,
companyId, String userId, int processInstanceId,
threadSequence)
Parmetros:

25

int
int

ECM - Webservices

takeProcessTaskByReplace
ment

user: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no 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.
Assume uma tarefa utilizando colaborador substituto.
Mtodo:
takeProcessTask(String
user,
String
password,
companyId, String userId, int processInstanceId,
threadSequence, String replacementId)

int
int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
replacementId: matrcula do colaborador substituto.

getAttachments

Retorno: String.
Retorna os anexos de uma solicitao.
Mtodo:
getAttachments(String user, String password, int companyId,
String userId, int processInstanceId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.

26

ECM - Webservices

getAllActiveStates

Retorno: ProcessAttachmentDto[].
Retorna o nmero da atividade em que uma solicitao esta.
Mtodo:
getAllActiveStates(String user, String password,
companyId, String userId, int processInstanceId)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.

getActualThread

Retorno: Integer[].
Retorna a sequncia da thread de uma solicitao.
Mtodo:
getActualThread(String
user,
String
password,
companyId, int processInstanceId, int stateSequence)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
stateSequence: sequncia do estado.

getAvailableStates

Retorno: int.
Retorna o nmero da prxima atividade de uma solicitao.
Mtodo:
getAvailableStates(String user, String password, int
companyId, String processId, int processInstanceId, int
threadSequence)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
processInstanceId: nmero da solicitao;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas

27

ECM - Webservices
existentes no processo.

getAvailableUsers

Retorno: Integer[].
Retorna os colaboradores que podem executar a tarefa
corrente de uma solicitao.
Mtodo:
getAvailableUsers(String username, String password, int
companyId,
int
processInstanceId,
int
state,
int
threadSequence)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo.

getAvailableUsersOnDeman
d

Retorno: String[].
Retorna os colaboradores que podem executar a tarefa
corrente de uma solicitao, paginados e com busca.
Mtodo:
getAvailableUsersOnDemand(String
username,
String
password, int companyId, int processInstanceId, int state, int
threadSequence, int limit, int initialUser, String userSearch)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
limit: nmero de registros a serem retornados;
initialUser: ltima linha retornada;
userSearch: texto a ser buscado.

28

ECM - Webservices

getInstanceCardData

Retorno: AvailableUsersDto.
Retorna o valor dos campos da ficha de uma solicitao.
Mtodo:
getInstanceCardData(String user, String password,
companyId, String userId, int processInstanceId)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
processInstanceId: nmero da solicitao.

getAvailableProcess

Retorno: String[][].
Retorna os processos que o colaborador pode iniciar uma
solicitao.
Mtodo:
getAvailableProcess(String username, String password, int
companyId, String userId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador.

getAvailableProcessOnDema
nd

Retorno: ProcessDefinitionVersionDto[].
Retorna os processos que o colaborador pode iniciar uma
solicitao, paginados.
Mtodo:
getAvailableProcessOnDemand(String username, String
password, int companyId, String userId, int limit, int
lastRowId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
userId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

29

ECM - Webservices

updateWorkflowAttachment

getAvailableUsersStart

Retorno: ProcessDefinitionVersionDto[].
Atualiza um documento do tipo 7.
Retorna uma string contendo a descrio de sucesso ou
falha da operao.
Mtodo:
updateWorkflowAttachment(String
username,
String
password, int companyId, int processInstanceId, String
usuario, DocumentDto[] docdtos, Attachment[] attach)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processInstanceId: nmero da solicitao workflow
usuario: usurio responsvel pela edio do
documento;
docDtos: documento ou documentos que sero
publicados;
attachs: arquivo(s) anexado(s) na publicao;
Retorna os colaboradores disponveis na abertura de uma
solicitao.
Mtodo:
getAvailableUsersStart (String username, String password,
int
companyId,
String
processId,
int
state,
int
threadSequence)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo.

getAvailableUsersStartOnDe
mand

Retorno: String[].
Retorna os colaboradores disponveis na abertura de uma
solicitao, paginados e com busca.
Mtodo:
getAvailableUsersStart (String username, String password,
int
companyId,
String
processId,
int
state,
int
threadSequence, int limit, int initialUser, String userSearch)

30

ECM - Webservices

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
state: nmero da atividade;
threadSequence: Indica se existe atividade paralela
no processo. Se no existir o valor 0 (zero), caso
exista, este valor pode ser de 1 a infinito
dependendo da quantidade de atividade paralelas
existentes no processo;
limit: nmero de registros a serem retornados;
initialUser: ltima linha retornada;
userSearch: texto a ser buscado.

importProcess

Retorno: AvailableUsersDto.
Importa processos workflow.
Mtodo:
importProcess(String user, String password, int companyId,
String processId, Attachment file, boolean newProcess,
boolean overWrite, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
processId: cdigo do processo;
file: arquivo a ser importado;
newProcess: indica se deve ser criado um processo
ou atualizado o existente;
overWrite: indica se as atividade e fluxos do
processo existente dever ser sobrescritas.
colleagueId : matrcula do colaborador.
Retorno: String.

calculateDeadLineHours

Calcula um prazo a partir de uma data com base no


expediente e feriados cadastrados no produto passando o
prazo em horas.
Mtodo:
calculateDeadLineHours(String username, String password,
int companyId, String userId, String data, int segundos, int
prazo, String periodId)
Parmetros:

31

ECM - Webservices

username - Usurio de Integrao


password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
data - data (Tipo String no formato "yyyy-MM-dd").
segundos - Quantidade de segundos aps a meia
noite
prazo - Prazo que ser aplicado em horas (Varivel
int).
periodId - Cdigo de Expediente

Retorno: Objeto DeadLineDto que contem variveis com a


data e hora.
calculateDeadLineTime

Calcula um prazo a partir de uma data com base no


expediente e feriados cadastrados no produto passando o
prazo em minutos.
Mtodo:
calculateDeadLineHours(String username, String password,
int companyId, String userId, String data, int segundos, int
prazo, String periodId)
Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
data - data (Tipo String no formato "yyyy-MM-dd").
segundos - Quantidade de segundos aps a meia
noite
prazo - Prazo que ser aplicado em minutos
(Varivel int).
periodId - Cdigo de Expediente
Retorno: Objeto DeadLineDto que contem variveis com a
data e hora.

exportProcess

getAllProcessAvailableToImp

Retorna o processo selecionado em uma String.


Mtodo:
exportProcess (String username, String password, int
companyId, String processId)
Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
processId - Cdigo do processo
Retorno: String que contm a definio do processo

Retorna uma lista de processos disponveis para serem


importados.

ort
Mtodo:

32

ECM - Webservices
getAllProcessAvailableToImport (String username, String
password, int companyId)
Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
Retorno: ProcessDefinitionDto[]
getAllProcessAvailableToExp

Retorna uma lista de processos disponveis para serem


exportados.

ort
Mtodo:
getAllProcessAvailableToExport (String username, String
password, int companyId)
Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
Retorno: ProcessDefinitionDto[].
getHistories

Retorna lista de histricos de um processo.


Mtodo:
getHistories (String username, String password, int
companyId)
Parmetros:
username - Usurio de Integrao
password - Senha de Integrao
companyId - Cdigo da empresa
userId - Matrcula do usurio
processInstanceId - nmero da solicitao workflow
Retorno: ProcessHistoryDto[].
Quadro 3: Mtodos da WorkflowEngineService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosWorkflowEngineService disponibilizada a classe
WorkflowEngineServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe WorkflowEngineService.

33

ECM - Webservices

GroupService
Webservices responsvel por realizar operaes referentes a grupos no ECM.
Pode ser utilizado para criar, alterar, excluir e procurar grupos, entre outras
funcionalidades.

Mtodos
No quadro 4, mostrado todos os mtodos disponveis na classe
GroupService.

getGroups

Retorna todos os grupos cadastrados no ECM.


Mtodo:
getGroups(String username, String password, int companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

getGroup

Retorno: GroupDto[].
Retorna um grupo cadastrado no ECM.
Mtodo:
getGroups(String username, String password, int companyId,
String groupId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo.

createGroup

Retorno: GroupDto[].
Cria um grupo no ECM.
Mtodo:
createGroup(String username,
companyId, GroupDto[] grupos)

String

Parmetros:
username: login do colaborador;
password: senha do colaborador;

34

password,

int

ECM - Webservices

updateGroup

companyId: cdigo da empresa;


grupos: grupo que ser criado.

Retorno: String.
Altera um grupo no ECM.
Mtodo:
updateGroup(String username,
companyId, GroupDto[] grupos)

String

password,

int

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
grupos: grupo que ser alterado.

getGroupsByDescription

Retorno: String.
Retorna um grupo pela descrio.
Mtodo:
getGroupsByDescription(String username, String password,
int companyId, String desc)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
desc: descrio do grupo.

getOcurrenceByKey

Retorno: GroupDto[].
Retorna se existe configurao de segurana para atribuio
e valor da atribuio.
Mtodo:
getOcurrenceByKey(String username, String password, int
companyId, int pIdiAtribuic, String pDesValAtribuic)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
pIdiAtribuic: cdigo da atribuio;
pDesValAtribuic: valor da atribuio.

deleteGroup

Retorno: boolean.
Exclui um grupo do ECM.

35

ECM - Webservices

Mtodo:
deleteGroup(String username,
companyId, String groupId)

String

password,

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
GroupId: cdigo do grupo.
Retorno: String.
Quadro 4: Mtodos da GroupService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosGroupService

disponibilizada
a
classe
GroupServiceClient.java, esta exemplifica a utilizao de todos os mtodos da
classe GroupService.

36

int

ECM - Webservices

FavoritesService
Webservices responsvel por interagir com os documentos e processos
favoritos do ECM. Pode ser utilizado para pesquisar os documentos e
processos favoritos de cada colaborador.

Mtodo
No quadro 5, mostrado os mtodos disponveis na classe FavoritesService.
findFavorites

Retorna os documentos favoritos do colaborador.


Mtodo:
findFavorites(String user, String password, int companyId,
String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador.

findFavoritesOnDemand

Retorno: DocumentDto[].
Retorna os documentos
paginados.

favoritos

do

colaborador,

Mtodo:
findFavoritesOnDemand(String user, String password, int
companyId, String colleagueId, int limit, int lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

findFavoritesProcess

Retorno: DocumentDto[].
Retorna os processos favoritos do colaborador.
Mtodo:
findFavoritesProcess (String user, String password, int

37

ECM - Webservices
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador.

findFavoritesProcessOnDema
nd

Retorno: ProcessDefinitionVersionDto[] .
Retorna os processos favoritos do colaborador, paginados.
Mtodo:
findFavoritesProcess (String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.
Retorno: ProcessDefinitionVersionDto[] .

addDocumentToFavorites

Adiciona um documento aos favoritos do colaborador


informado.
Mtodo:
addDocumentToFavorites(String username, String
password, int companyId, int nrDocument, int nrVersao,
String colleagueId)
Parmetros:

removeFavoriteDocument

username: login do colaborador;

password: senha do colaborador;

companyId: cdigo da empresa;

nrDocument: nmero do documento

nrVersao: verso do documento

colleagueId : matrcula do colaborador.

Remove um documento dos favoritos do colaborador


informado.

38

ECM - Webservices
Mtodo:
removeFavoriteDocument (String username, String
password, int companyId, int nrDocument, String
colleagueId)
Parmetros:

addProcessToFavorites

username: login do colaborador;

password: senha do colaborador;

companyId: cdigo da empresa;

nrDocument: nmero do documento

colleagueId : matrcula do colaborador.

Adiciona um processo aos favoritos do colaborador


informado.
Mtodo:
addProcessToFavorites(String username, String password,
int companyId,String processId, String colleagueId)
Parmetros:

removeFavoriteProcess

username: login do colaborador;

password: senha do colaborador;

companyId: cdigo da empresa;

processId: cdigo do processo

colleagueId : matrcula do colaborador.

Remove um processo dos favoritos do colaborador


informado.
Mtodo:
addProcessToFavorites(String username, String password,
int companyId,String processId, String colleagueId)
Parmetros:

username: login do colaborador;

password: senha do colaborador;

companyId: cdigo da empresa;

processId: cdigo do processo

39

ECM - Webservices

colleagueId : matrcula do colaborador.

Quadro 5: Mtodos da FavoritesService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosFavoritesService

disponibilizada
a
classe
FavoritesServiceClient.java, esta exemplifica a utilizao de todos os mtodos
da classe FavoritesService.

40

ECM - Webservices

CompanyService
Webservices responsvel por realizar operaes referentes empresa no
ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar empresas,
entre outras funcionalidades.

Mtodos
No quadro 6, mostrado todos os mtodos disponveis na classe
CompanyService.
getCompanies

Retorna todas as empresas cadastradas no ECM.


Mtodo:
getCompanies(String username, String password, String
companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

getCompany

Retorno: CompanyDto[].
Retorna uma empresa cadastrada no ECM.
Mtodo:
getCompany(int companyId)
Parmetros:
companyId: cdigo da empresa.

createCompany

Retorno: CompanyDto.
Cria uma empresa no ECM.
Mtodo:
createCompany(String username, String password, String
companyId, String description, String urlAccessName, String
phisicalPath, String webdeskServer, String webPort)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;

41

ECM - Webservices

updateCompany

description: descrio da empresa;


urlAccessName: URL de acesso;
phisicalPath: caminho fsico;
webdeskServer: servidor;
webPort: porta.

Retorno: String.
Altera uma empresa no ECM.
Mtodo:
updateCompany(String username, String password, String
companyId, String description, String urlAccessName, String
phisicalPath, String webdeskServer, String webPort)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
description: descrio da empresa;
urlAccessName: URL de acesso;
phisicalPath: caminho fsico;
webdeskServer: servidor;
webPort: porta.

delete

Retorno: String.
Exclui uma empresa do ECM.
Mtodo:
delete(String username, String password, String companyId,
Boolean deleteFiles)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
deleteFiles: indica se deve excluir o caminho fsico.
Retorno: String.
Quadro 6: Mtodos da CompanyService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosCompanyService

disponibilizada
a
classe

42

ECM - Webservices
CompanyServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe CompanyService.

43

ECM - Webservices

SearchDocumentService
Webservices responsvel por realizar operaes referentes s buscas no
ECM. Pode ser utilizado para buscar documentos utilizando a busca simples e
avanada.

Mtodos
No quadro 7, mostrado todos os mtodos disponveis na classe
SearchDocumentService.
searchDocuments

Utiliza busca simples.


Mtodo:
searchDocuments(String user, String password,
companyId, String colleagueId, String content)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
content: contedo da busca.

advancedSearchDocuments

Retorno: SearchResultDto[].
Utiliza busca avanada.
Mtodo:
advancedSearchDocuments(String user, String password, int
companyId, String colleagueId, String content, boolean
findAllDocumentTypes, boolean
findFolders, boolean
findDocuments, boolean findCardIndex, boolean findCards,
boolean findExternalDocument, int documentParentId, Date
startDate, Date finalDate)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
content: contedo da busca;
findAllDocumentTypes: indica se deve buscar todos
os tipos de documentos;

44

ECM - Webservices

findFolders: indica se deve buscar pastas;


findDocuments: indica se deve buscar documentos;
findCardIndex: indica se deve buscar fichrios;
findCards: indica se deve buscar fichas;
findExternalDocument: indica se deve buscar
documentos externos;
documentParentId: nmero do documento pai;
startDate: data inicial;
finalDate: data final.

Retorno: SearchResultDto[].
Quadro 7: Mtodos da SearchDocumentService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosSearchDocumentService disponibilizada a classe
SearchDocumentServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe SearchDocumentService.

45

ECM - Webservices

ColleagueGroupService
Webservices responsvel por realizar operaes referentes aos grupos de
usurios no ECM. Pode ser utilizado para relacionar um colaborador a um
grupo de usurios e serve tambm para alterar, excluir e pesquisar esses
relacionamentos criados.

Mtodos
No quadro 8, mostrado todos os mtodos disponveis na classe
ColleagueGroupService.
getColleagueGroupsByColle
agueId

Retorna os grupos de usurios que um colaborador participa.


Mtodo:
getColleagueGroupsByColleagueId(String username, String
password, int companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

getColleagueGroupsByGrou
pId

Retorno: ColleagueGroupDto[].
Retorna os colaboradores que participam de um grupo de
usurios.
Mtodo:
getColleagueGroupsByGroupId(String
username,
password, int companyId, String groupId)

String

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo.

getAllColleagueGroups

Retorno: ColleagueGroupDto[].
Retorna todos os grupos de usurios que possuem
colaboradores relacionados.
Mtodo:

46

ECM - Webservices
getAllColleagueGroups(String username, String password,
int companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

getColleagueGroup

Retorno: ColleagueGroupDto[].
Retorna somente um grupo de usurios que um colaborador
participa.
Mtodo:
getColleagueGroup(String username, String password, int
companyId, String groupId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo;
colleagueId: matrcula do colaborador.

createColleagueGroup

Retorno: ColleagueGroupDto[].
Associa um colaborador a um grupo de usurios.
Mtodo:
createColleagueGroup(String username, String password, int
companyId, ColleagueGroupDto[] grupo_colaborador)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
grupo_colaborador: grupo de usurios que estar
associado a um colaborador.

updateColleagueGroup

Retorno: String.
Altera a associao de um colaborador a um grupo de
usurios.
Mtodo:
updateColleagueGroup(String username, String password,
int companyId, ColleagueGroupDto[] grupo_colaborador)
Parmetros:

47

ECM - Webservices

deleteColleagueGroup

username: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
grupo_colaborador: grupo de usurios que ser
alterado.

Retorno: String.
Exclui um colaborador de um grupo de usurios.
Mtodo:
deleteColleagueGroup(String username, String password, int
companyId, String groupId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
groupId: cdigo do grupo;
colleagueId: matrcula do colaborador.
Retorno: String.

Quadro 8: Mtodos da ColleagueGroupService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosColleagueGroupService disponibilizada a classe
ColleagueGroupServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe ColleagueGroupService.

48

ECM - Webservices

ColleagueService
Webservices responsvel por realizar operaes referentes a colaboradores
no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar
colaboradores, entre outras funcionalidades.

Mtodos
No quadro 9, mostrado todos os mtodos disponveis na classe
ColleagueService.
getColleagues

Retorna todos os colaboradores ativos.


Mtodo:
getColleagues(String
companyId)

username,

String

password,

int

password,

int

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

getColleague

Retorno: ColleagueDto[].
Retorna um colaborador.
Mtodo:
getColleague(String username,
companyId, String colleagueId)

String

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

getGroups

Retorno: ColleagueDto[].
Retorna os grupos de usurios que o colaborador participa.
Mtodo:
getGroups(String username, String password, int companyId,
String colleagueId)
Parmetros:

49

ECM - Webservices

createColleague

username: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

Retorno: GroupDto[].
Cria um colaborador.
Mtodo:
createColleague(String username, String
companyId, ColleagueDto[] colegas)

password,

int

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores.

createColleaguewithDepend
encies

Retorno: String.
Cria um colaborador com grupo de segurana e papis
workflow.
Mtodo:
createColleaguewithDependencies(String username, String
password,
int
companyId,
ColleagueDto[]
colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores;
grupos: grupos de segurana;
papeis: papis workflow.

updateColleague

Retorno: String.
Altera um colaborador.
Mtodo:
updateColleague(String username, String password, int
companyId, ColleagueDto[] colegas)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;

50

ECM - Webservices

updateColleaguewithDepend
encies

colegas: colaboradores.

Retorno: String.
Altera um colaborador com grupo de segurana e papis
workflow.
Mtodo:
updateColleaguewithDependencies(String username, String
password,
int
companyId,
ColleagueDto[]
colegas,
GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colegas: colaboradores;
grupos: grupos de segurana;
papeis: papis workflow.

removeColleague

Retorno: String.
Exclui um colaborador.
Mtodo:
removeColleague(String username, String password, int
companyId, String colleagId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagId: matrcula do colaborador.

getSummaryColleagues

Retorno: String.
Retorna todos os colaboradores ativos.
Mtodo:
getSummaryColleagues(int companyId)
Parmetros:
companyId: cdigo da empresa.

validateColleagueLogin

Retorno: ColleagueDto[].
Valida o acesso de um colaborador no produto.
Mtodo:
validateColleagueLogin(int companyId, String colleagueId,

51

ECM - Webservices
String password)
Parmetros:
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
password: senha do colaborador.

getColleaguesMail

Retorno: String.
Retorna um colaborador utilizando um e-mail.
Mtodo:
getColleaguesMail(String username, String password, int
companyId, String mail)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
mail: e-mail do colaborador.

getSimpleColleague

Retorno: ColleagueDto[].
Retorna o colaborador.
Mtodo:
getSimpleColleague(String username, String password)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
Retorno: ColleagueDto.
Quadro 9: Mtodos da ColleagueService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosColleagueService

disponibilizada
a
classe
ColleagueServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe ColleagueService.

52

ECM - Webservices

ColleagueReplacementService
Webservices responsvel por realizar operaes referentes a colaboradores
substitutos no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar
colaboradores substitutos, entre outras funcionalidades.

Mtodos
No quadro 10, mostrado todos os mtodos disponveis na classe
ColleagueReplacementService.
getColleagueReplacement

Retorna um substituto de um colaborador.


Mtodo:
getColleagueReplacement(String
username,
password, int companyId, String colleagueId,
replacementId)

String
String

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.

getReplacementsOfUser

Retorno: ColleagueReplacementDto.
Retorna todos os substitutos de um colaborador.
Mtodo:
getReplacementsOfUser(String username, String password,
int companyId, String colleagueId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem.

getValidReplacedUsers

Retorno: ColleagueReplacementDto[].
Retorna todos os colaboradores substituidos por um
substituto vlido.
Mtodo:

53

ECM - Webservices
getValidReplacedUsers(String username, String password,
int companyId, String replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
replacementId: matrcula do colaborador substituto.

getValidReplacement

Retorno: ColleagueReplacementDto[].
Retorna um substituto vlido de um colaborador.
Mtodo:
getValidReplacement(String username, String password, int
companyId, String colleagueId, String replacementId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.

getValidReplacementsOfUse
r

Retorno: ColleagueReplacementDto.
Retorna todos os substitutos vlidos de um colaborador.
Mtodo:
getValidReplacementsOfUser(String
username,
password, int companyId, String colleagueId)

String

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem.

createColleagueReplacemen
t

Retorno: ColleagueReplacementDto[].
Cria um substituto.
Mtodo:
createColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parmetros:
username: login do colaborador;
password: senha do colaborador;

54

ECM - Webservices

updateColleagueReplaceme
nt

companyId: cdigo da empresa;


crDto: cadastro do substituto.

Retorno: String.
Altera o cadastro de um substituto.
Mtodo:
updateColleagueReplacement (String username, String
password, int companyId, ColleagueReplacementDto crDto)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
crDto: cadastro do substituto.

deleteColleagueReplacemen
t

Retorno: String.
Exclui o cadastro de um substituto.
Mtodo:
deleteColleagueReplacement(String
password, int companyId, String
replacementId)

username,
colleagueId,

String
String

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador origem;
replacementId: matrcula do colaborador substituto.
Retorno: String.
Quadro 10: Mtodos da ColleagueReplacementService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosColleagueReplacementService disponibilizada a
classe ColleagueReplacementServiceClient.java, esta exemplifica a utilizao
de todos os mtodos da classe ColleagueReplacementService.

55

ECM - Webservices

FolderService
Webservices responsvel por realizar operaes referentes a pastas no ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar pastas, entre outras
funcionalidades.

Mtodos
No quadro 11, mostrado todos os mtodos disponveis na classe
FolderService.
getFolder

Retorna uma pasta.


Mtodo:
getFolder(String user, String password, int companyId, int
nrDocumentId, String colleagueId )
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta;
colleagueId: matrcula do colaborador origem.

getSecurity

Retorno: DocumentDto[].
Retorna a segurana de uma pasta.
Mtodo:
getSecurity(String user, String password, int companyId, int
nrDocumentId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta.

getApprovers

Retorno: DocumentSecurityConfigDto[].
Retorna os aprovadores de uma pasta.
Mtodo:
getApprovers(String user, String password, int companyId, int
nrDocumentId)

56

ECM - Webservices

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
nrDocumentId: nmero da pasta.

createFolder

Retorno: ApproverWithLevelDto[].
Cria uma pasta.
Mtodo:
createFolder(String user, String password, int companyId,
DocumentDto[]
docdtos,
DocumentSecurityConfigDto[]
docsecurity, ApproverDto[] docapprovers )
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docdtos: pasta que ser criada;
docsecurity: segurana da pasta;
docapprovers: aprovadores da pasta.

createFolderWithApproveme
ntLevels

Retorno: WebServiceMessage[].
Cria uma pasta com nvel de aprovao.
Mtodo:
createFolderWithApprovementLevels(String
user,
String
password,
int
companyId,
DocumentDto[]
docdtos,
DocumentSecurityConfigDto[]
docsecurity,
ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[]
levels)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docdtos: pasta que ser criada;
docsecurity: segurana da pasta;
docapprovers: aprovadores em nveis;
levels: nveis de aprovao da pasta.

updateFolder

Retorno: WebServiceMessage[].
Altera uma pasta.
Mtodo:

57

ECM - Webservices
updateFolder(String user, String password, int companyId,
DocumentDto[]
docdtos,
DocumentSecurityConfigDto[]
docsecurity, ApproverDto[] docapprovers)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docdtos: pasta que ser alterada;
docsecurity: segurana da pasta;
docapprovers: aprovadores da pasta.

updateFolderWithApproveme
ntLevels

Retorno: WebServiceMessage[].
Altera uma pasta com nvel de aprovao.
Mtodo:
updateFolderWithApprovementLevels(String user, String
password,
int
companyId,
DocumentDto[]
docdtos,
DocumentSecurityConfigDto[]
docsecurity,
ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[]
levels)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
docdtos: pasta que ser alterada;
docsecurity: segurana da pasta;
docapprovers: aprovadores em nveis;
levels: nveis de aprovao da pasta.

getRootFolders

Retorno: WebServiceMessage[].
Retorna as pastas root que um colaborador tem acesso,
exceto a pasta particular.
Mtodo:
getRootFolders(String user, String password, int companyId,
String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.
Retorno: DocumentDto[].

58

ECM - Webservices
getChildren

Retorna todos os documentos de uma pasta.


Mtodo:
getChildren(String user, String password, int companyId, int
documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
colleagueId: matrcula do colaborador.

getPrivateChildren

Retorno: DocumentDto[].
Retorna todos os documentos de uma pasta particular.
Mtodo:
getPrivateChildren(String user, String
companyId, int parentDocumentId)

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
Retorno: DocumentDto[].
getSubFolders

Retorna todas as subpastas e arquivos de um pasta.


Mtodo:
getSubFolders(String user, String password, int companyId,
int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
colleagueId: matrcula do colaborador.

getSubFoldersOnDemand

Retorno: DocumentDto[].
Retorna todas as subpastas e arquivos de um pasta,
paginados.
Mtodo:

59

ECM - Webservices
getSubFoldersOnDemand(String user, String password, int
companyId, int documentId, int limit , int lastRowId, String
colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada;
colleagueId: matrcula do colaborador.

getUserPermissions

Retorno: DocumentDto[].
Retorna a permisso de um colaborador sobre uma pasta.
Mtodo:
getUserPermissions(int companyId,
nrDocumentId, int version)

String

user,

int

Parmetros:
companyId: cdigo da empresa;
user: matrcula do colaborador;
nrDocumentId: nmero da pasta;
version: verso da pasta.

createSimpleFolder

Retorno: Integer.
Cria uma pasta simples.
Mtodo:
createSimpleFolder(String user, String password, int
companyId, int parentDocumentId, String publisherId, String
documentDescription)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
parentDocumentId: nmero do documento pai;
publisherId: matrcula do colaborador publicador;
documentDescription: descrio da pasta.

getSubPrivateFolders

Retorno: WebServiceMessage[].
Retorna todas as subpastas de uma pasta particular.
Mtodo:

60

ECM - Webservices
getSubPrivateFolders(String colleagueId, String password,
int companyId, int documentId)
Parmetros:
colleagueId: matrcula do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta particular.

getSubFoldersPermission

Retorno: DocumentDto[].
Retorna todas as subspastas em que o colaborador tenha a
permisso informada.
Mtodo:
getSubFoldersPermission(String user, String password, int
companyId, int documentId, String colleagueId, int
permission)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta particular;
colleagueId: matrcula do colaborador;
permission: permisso sobre a pasta.

deleteDocument

Retorno: DocumentDto[].
Exclui uma pasta e envia para a lixeira.
Mtodo:
deleteDocument(String user, String password, int companyId,
int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
colleagueId: matrcula do colaborador.

destroyDocument

Retorno: WebServiceMessage[].
Exclui uma pasta da lixeira.
Mtodo:
destroyDocument(String
user,
String
password,
companyId, int documentId, String colleagueId)

61

int

ECM - Webservices

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
colleagueId: matrcula do colaborador.

findRecycledDocuments

Retorno: WebServiceMessage[].
Retorna todos os documentos da lixeira de um colaborador.
Mtodo:
findRecycledDocuments(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

restoreDocument

Retorno: DocumentDto[].
Restaura uma pasta da lixeira.
Mtodo:
restoreDocument(String
user,
String
password,
companyId, int documentId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero da pasta;
colleagueId: matrcula do colaborador.
Retorno: WebServiceMessage[].
Quadro 11: Mtodos da FolderService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosFolderService

disponibilizada
a
classe
FolderServiceClient.java, esta exemplifica a utilizao de todos os mtodos da
classe FolderService.

62

int

ECM - Webservices

CardService
Webservices responsvel por realizar operaes referentes a fichas no ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras
funcionalidades.

Mtodos
No quadro 12, mostrado todos os mtodos disponveis na classe
CardService.
updateCardData

Altera os campos de uma ficha.


Mtodo:
updateCardData(int companyId, String user,
password, int cardId, CardFieldDto[] cardData)

String

Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
cardId: nmero da ficha;
cardData: campos da ficha que sero alterados.

create

Retorno: WebServiceMessage[].
Cria uma ficha.
Mtodo:
create(int companyId,
CardDto[] carddtos)

String

user,

String

password,

Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
carddtos: ficha que ser criada.

deleteCard

Retorno: WebServiceMessage[].
Exclui uma ficha e envia para a lixeira.
Mtodo:
deleteCard(int companyId, String user, String password, int
cardId)

63

ECM - Webservices

Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
cardId: nmero da ficha.

updateCard

Retorno: WebServiceMessage[].
Altera os metadados de uma ficha.
Mtodo:
updateCard(int companyId, String user, String password,
CardDto[]
cardDtos,
Attachment[]
attachs,
DocumentSecurityConfigDto[] docsecurity, ApproverDto[]
docapprovers, RelatedDocumentDto[] reldocs)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
cardDtos: ficha que ser alterada;
attachs: anexos da ficha;
docsecurity: segurana da ficha;
docapprovers: aprovadores da ficha;
reldocs: documentos relacionados da ficha.

getCardVersion

Retorno: WebServiceMessage[].
Retorna a verso de uma ficha.
Mtodo:
getCardVersion(int companyId, String user, String password,
int nrDocumentId, int version, String colleagueId)
Mtodo:
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
nrDocumentId: nmero da ficha;
version: verso da ficha;
colleagueId: matrcula do colaborador.
Retorno: CardDto[].
Quadro 12: Mtodos da CardService

64

ECM - Webservices
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosCardService

disponibilizada
a
classe
CardServiceClient.java, esta exemplifica a utilizao de todos os mtodos da
classe CardService.

65

ECM - Webservices

TokenService
Webservices responsvel por interagir com os tokens do ECM. Pode ser
utilizado para pesquisar e validar os tokens existentes.

Mtodos
No quadro 13, mostrado todos os mtodos disponveis na classe
TokenService.
getToken

Retorna um token de segurana.


Mtodo:
getToken(String login, String password)
Parmetros:
login: login do colaborador;
password: senha do colaborador.

validateToken

Retorno: String.
Valida o token de segurana e retorna o login do
colaborador.
Mtodo:
validateToken(String token)
Parmetro:
token: token do colaborador.
Retorno: String.
Quadro 13: Mtodos da TokenService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosTokenService

disponibilizada
a
classe
TokenServiceClient.java, esta exemplifica a utilizao de todos os mtodos da
classe TokenService.

66

ECM - Webservices

CustomFieldsService
Webservices responsvel por interagir com os campos customizados do ECM.
Pode ser utilizado para criar, alterar, excluir e pesquisar campos
customizados, entre outras funcionalidades.

Mtodos
No quadro 14, mostrado todos os mtodos disponveis na classe
CustomFieldsService.
createCustomFields

Cria um campo customizado.


Mtodo:
createCustomFields(String user, String password,
companyId, CustomFieldsDto[] customFieldsDto)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
customFieldsDto: campo customizado que ser
criado.

updateCustomFields

Retorno: String.
Altera um campo customizado.
Mtodo:
updateCustomFields(String user, String password,
companyId, CustomFieldsDto[] customFieldsDto)

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
customFieldsDto: campo customizado que ser
alterado.

removeCustomField

Retorno: String.
Exclui um campo customizado.
Mtodo:
removeCustomField(String

67

user,

String

password,

int

ECM - Webservices
companyId, String customFieldsId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
customFieldsId: cdigo do campo customizado.

getAllCustomField

Retorno: String.
Retorna todos os campos customizados.
Mtodo:
getAllCustomField(String
companyId)

user,

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

setDocumentCustomFields

Retorno: CustomFieldsDto[].
Cria ou altera um campo customizado em um documento.
Mtodo:
setDocumentCustomFields(String user, String password, int
companyId,
DocumentCustomFieldsDto[]
documentCustomFieldsDto)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentCustomFieldsDto: documento com campo
customizado.

removeDocumentCustomFiel
d

Retorno: String.
Exclui um campo customizado de um documento.
Mtodo:
removeDocumentCustomField(String user, String password,
int companyId, String customFieldsId, int documentId, int
version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;

68

ECM - Webservices

getAllDocumentCustomField

companyId: cdigo da empresa;


customFieldsId: cdigo do campo customizado;
documentId: nmero do documento;
version: verso do documento.

Retorno: String.
Retorna todos os campos customizados de um documento.
Mtodo:
getAllDocumentCustomField(String user, String password, int
companyId, int documentId, int version)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId: nmero do documento;
version: verso do documento.
Retorno: DocumentCustomFieldsDto[].

Quadro 14: Mtodos da CustomFieldsService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosCustomFieldsService disponibilizada a classe
CustomFieldsServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe CustomFieldsService.

69

ECM - Webservices

OutstandingService
Webservices responsvel por interagir com as transferncias de pendncias
do ECM. Pode ser utilizado para transferir pendncias de um colaborador
para outro colaborador.

Mtodo
No quadro 15, mostrado o mtodo disponvel na classe OutstandingService.
transfer

Transfere pendncias de um colaborador para outro


colaborador.
Mtodo:
transfer(String user, String password, int companyId, String
colleagueIdFrom, String colleagueIdTo, String[] parameters)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueIdFrom: matrcula do colaborador origem
(suas pendncias sero tranferidas para o
colaborador destino);
colleagueIdTo: matrcula do colaborador destino
(receber as pendncias do colaborador origem);
parameters: array de pendncias que sero
transferidas para o colaborador destino.
Retorno: String.
Quadro 15: Mtodos da OutstandingService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosOutstandingService disponibilizada a classe
OutstandingServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe OutstandingService.

70

ECM - Webservices

GlobalParamService
Webservices responsvel por interagir com as configuraes dos parmetros
gerais do ECM. Pode ser utilizado para criar, alterar e pesquisar os
parmetros gerais.

Mtodos
No quadro 16, mostrado todos os mtodos disponveis na classe
GlobalParamService.
getGlobalParam

Retorna os parmetros gerais de uma empresa.


Mtodo:
getGlobalParam(String
companyId)

username,

String

password,

int

Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

createGlobalParam

Retorno: GlobalParamDto[].
Cria parmetros gerais para uma empresa.
Mtodo:
createGlobalParam(String username, String password, int
companyId, GlobalParamDto[] global)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
global: parmetros gerais da empresa.

updateGlobalParam

Retorno: String.
Altera parmetros gerais de uma empresa.
Mtodo:
updateGlobalParam(String username, String password, int
companyId, GlobalParamDto[] global)
Parmetros:

71

ECM - Webservices

getVolumes

username: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
global: parmetros gerais da empresa.

Retorno: String.
Retorna os volumes da empresa.
Mtodo:
getVolumes(String user, String password, int companyId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;

getConfigurations

Retorno: VolumeDto[].
Retorna as informaes de configurao do sistema.
Mtodo:
getConfigurations(String username, String password, int
companyId)
Parmetros:
username: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa.

updateConfigurations

Retorno: SystemInfo.
Altera as configuraes do sistema.
Mtodo:
updateConfigurations( String username,String password, int
companyId, String dbDriver, String dbUser, String
dbPassword, String dbServer,
String dbPort,String dbScheme, String dbInstance, String
emailServer, String emailPort, String emailSender, boolean
emailDefaultSender, String emailUser, String
emailPassword, boolean emailTLS,String
paramsRMTPTPort, String lsType, String paramsLSHost,
String paramsLSPort, String paramsOpenOfficeDir, String
paramsOpenOfficePorts, String portsSetName)
Parmetros:
username: login do colaborador;
password: senha do colaborador;

72

ECM - Webservices

companyId: cdigo da empresa;


dbDriver: driver do banco de dados (MySqlcom.mysql.jdbc.Driver; SQLServer net.sourceforge.jtds.jdbc.Driver; Oracle oracle.jdbc.driver.OracleDriver)
dbUser: username banco de dados;
dbPassword: password banco de dados;
dbServer: servidor de conexo do banco de dados;
dbPort: porta servidor banco de dados;
dbScheme: database;
dbInstance: instncia do banco, utilizada para
SQLServer, caso no seja o caso passar em branco
("");
emailServer: nome do servidor SMTP;
emailSender: e-mail do remetente padro do
produto.
emailPort: porta do servidor SMTP;
emailDefaultSender:
emailUser: usurio de email, somente se o servidor
necessitar de autenticao;
emailPassword: password do email, somente se o
servidor necessitar de autenticao;
emailTLS: servidor utilizar criptografia no envio de
email (true/false)
paramsRMTPTPort: porta utilizada pelo Flex;
lsType: tipo de licena utilizada, LM/LS;
paramsLSHost: servidor de licenas;
paramsLSPort: porta servidor de licenas;
paramsOpenOfficeDir: diretrio de instalao do
OpenOffice
paramsOpenOfficePorts: porta utilizado pelo
OpenOffice
portsSetName: porta utilizadas pelo sistema (portsdefault, ports-01, ports-02)

Retorno: String.
Quadro 16: Mtodos da GlobalParamService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosGlobalParamService disponibilizada a classe
GlobalParamServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe GlobalParamService.

73

ECM - Webservices

DashBoardService
Webservices responsvel por interagir com a central de tarefas do ECM. Pode
ser utilizado para pesquisar as informaes que esto disponveis na central
de tarefas.

Mtodo
No quadro 17, mostrado todos os mtodos disponveis na classe
DashBoardService.
findMyDocuments

Retorna os documentos do colaborador que precisam ser


aprovados.
Mtodo:
findMyDocuments(String user,
companyId, String colleagueId)

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findMyDocumentsOnDemand

Retorno: DocumentDto[].
Retorna os documentos do colaborador que precisam ser
aprovados, paginados.
Mtodo:
findMyDocumentsOnDemand(String user, String password,
int companyId, String colleagueId, int limit, int lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

findDocumentsToApprove

Retorno: DocumentDto[].
Retorna os documentos que o colaborador precisa aprovar.

74

ECM - Webservices
Mtodo:
findDocumentsToApprove(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findDocumentsToApproveOnD
emand

Retorno: DocumentDto[].
Retorna os documentos que o colaborador precisa aprovar,
paginados.
Mtodo:
findDocumentsToApproveOnDemand(String user, String
password, int companyId, String colleagueId, int limit, int
lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

findAgreementDocuments

Retorno: DocumentDto[].
Retorna os documentos do colaborador que esto em
consenso.
Mtodo:
findAgreementDocuments(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findCheckoutDocuments

Retorno: DocumentDto[].
Retorna os documentos do colaborador que esto em
checkout.
Mtodo:

75

ECM - Webservices
findCheckoutDocuments(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findCancelledTasks

Retorno: DocumentDto[].
Retorna as tarefas atribuidas ao colaborador que foram
canceladas.
Mtodo:
findCancelledTasks(String user,
companyId, String colleagueId)

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findCompletedTasks

Retorno: WorkflowProcessDto[].
Retorna as tarefas atribuidas ao colaborador que foram
finalizadas.
Mtodo:
findCompletedTasks(String user,
companyId, String colleagueId)

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findConsensusTasks

Retorno: WorkflowProcessDto[].
Retorna as tarefas atribuidas ao colaborador que esto em
consenso.
Mtodo:
findConsensusTasks(String user, String password, int
companyId, String colleagueId)
Parmetros:

76

ECM - Webservices

findTransferredTasks

user: login do colaborador;


password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

Retorno: WorkflowProcessDto[].
Retorna as tarefas atribuidas ao colaborador que foram
transferidas.
Mtodo:
findTransferredTasks(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findWorkflowTasks

Retorno: WorkflowProcessDto[].
Retorna as tarefas do colaborador que esto abertas.
Mtodo:
findWorkflowTasks(String user,
companyId, String colleagueId)

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findWorkflowTasksOnDemand

Retorno: WorkflowProcessDto[].
Retorna as tarefas do colaborador que esto abertas,
paginadas.
Mtodo:
findWorkflowTasksOnDemand(String
user,
String
password, int companyId, String colleagueId, int limit, int
lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;

77

ECM - Webservices

findMyRequests

limit: nmero de registros a serem retornados;


lastRowId: ltima linha retornada.

Retorno: WorkflowProcessDto[].
Retorna as solicitaes abertas que foram inicializadas
pelo colaborador.
Mtodo:
findMyRequests(String
user,
companyId, String colleagueId)

String

password,

int

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

findMyRequestsOnDemand

Retorno: WorkflowProcessDto[].
Retorna as solicitaes abertas que foram inicializadas
pelo colaborador, paginadas.
Mtodo:
findMyRequestsOnDemand(String user, String password,
int companyId, String colleagueId, int limit, int lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

findMyManagerTasks

Retorno: WorkflowProcessDto[].
Retorna as tarefas gerenciadas pelo colaborador.
Mtodo:
findMyManagerTasks(String user, String password, int
companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

78

ECM - Webservices
Retorno: WorkflowProcessDto[].
findExpiredWorkflowTasks

Retorna as tarefas do colaborador que esto em atraso

Mtodo:

findExpiredWorkflowTasks(String

user,

String

password, int companyId, String colleagueId)

Parmetros:

user: login do colaborador;

password: senha do colaborador;

companyId: cdigo da empresa;

colleagueId: matrcula do colaborador.

Retorno: WorkflowProcessDto[].
fillStatusTask

Retorna a quantidade de tarefas atrasadas, no prazo e sem


prazo de um colaborador.
Mtodo:
fillStatusTask(String user, String password, int companyId,
String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

fillChronoTasks

Retorno: int[].
Retorna a quantidade de tarefas com prazo de concluso
que foram atribuidas ao colaborador e no foram
finalizadas.
Mtodo:
fillChronoTasks(String
user,
String
password,
int
companyId, String colleagueId, int yearIni, int yearFin, int
mounthIni, int mounthFin, int dayIni, int dayFin, int
kindTask)
Parmetros:
user: login do colaborador;

79

ECM - Webservices

fillTypeTasks

password: senha do colaborador;


companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
yearIni: ano inicial;
yearFin: ano final;
mounthIni: ms inicial;
mounthFin: ms final;
dayIni: dia inicial;
dayFin: dia final;
kindTask: tipo da tarefa.

Retorno: int[].
Retorna os tipos de tarefas que o colaborador possui.
Mtodo:
fillTypeTasks(String user, String password, int companyId,
String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

fillTypeTasksOfReplacement

Retorno: TaskVODto[].
Retorna os tipos de tarefas que o colaborador substituto
possui.
Mtodo:
fillTypeTasksOfReplacement(String user, String password,
int companyId, String colleagueId, String replacementId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
replacementId: matrcula do colaborador substituto.

getOpenTasksByColleagueGr
oups

Retorno: TaskVODto[].
Retorna as tarefas atribuidas a um grupo de usurios que o
colaborador participa.
Mtodo:
getOpenTasksByColleagueGroups(String
user,
password, int companyId, String colleagueId)

80

String

ECM - Webservices

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

getOpenTasksByColleagueGr
oupsOnDemand

Retorno: WorkflowTaskDto[].
Retorna as tarefas atribuidas a um grupo de usurios que o
colaborador participa, paginadas.
Mtodo:
getOpenTasksByColleagueGroupsOnDemand(String user,
String password, int companyId, String colleagueId, int limit,
int lastRowId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

getOpenTasksByColleagueRol
es

Retorno: WorkflowTaskDto[].
Retorna as tarefas atribuidas a um papel workflow que o
colaborador participa.
Mtodo:
getOpenTasksByColleagueRoles(String
user,
password, int companyId, String colleagueId)

String

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador.

getOpenTasksByColleagueRol
esOnDemand

Retorno: WorkflowTaskDto[].
Retorna as tarefas atribuidas a um papel workflow que o
colaborador participa, paginadas.
Mtodo:
getOpenTasksByColleagueRolesOnDemand(String
user,
String password, int companyId, String colleagueId, int limit,
int lastRowId)

81

ECM - Webservices

Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId: matrcula do colaborador;
limit: nmero de registros a serem retornados;
lastRowId: ltima linha retornada.

getSummaryRequests

Retorno: WorkflowTaskDto[].
Retorna os contadores de pendncias da Home.
Mtodo:
getSummaryRequests(int companyId, String user, String
password, String colleagueId)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
colleagueId: matrcula do colaborador.
Retorno: HomeRequestSummaryDto[].
Quadro 17: Mtodos da DashBoardService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosDashBoardService disponibilizada a classe
DashBoardClient.java, esta exemplifica a utilizao de todos os mtodos da
classe DashBoardService.

82

ECM - Webservices

DatasetService
Webservices responsvel por interagir com os datasets do ECM. Pode ser
utilizado para pesquisar os datasets existentes.

Mtodos
No quadro 18, mostrado todos os mtodos disponveis na classe
DatasetService.
getAvailableDatasets

Retorna todos os datasets disponveis.


Mtodo:
getAvailableDatasets(int companyId, String user, String
password)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador.

getDataset

Retorno: Object[].
Retorna as informaes de um dataset.
Mtodo:
getDataset(int companyId, String user, String password,
String
name,
String[]
fields,
SearchConstraintDto[]
constraintsDto, String[] order)
Parmetros:
companyId: cdigo da empresa;
user: login do colaborador;
password: senha do colaborador;
name: nome do dataset;
fields: campos que sero retornados do dataset;
constraintsDto: filtro dos registros que iro compor o
dataset;
order: campos utilizados para ordenar o dataset.
Retorno: DatasetDto.
Quadro 18: Mtodos da DatasetService

83

ECM - Webservices

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosDatasetService

disponibilizada
a
classe
DatasetServiceClient.java, esta exemplifica a utilizao de todos os mtodos
da classe DatasetService.

84

ECM - Webservices

BusinessPeriodService
Webservices responsvel por realizar operaes referentes aos expedientes
cadastrados no ECM. Pode ser utilizado para pesquisar os expedientes de
uma determinada empresa.

Mtodos
No quadro 19, mostrado todos os mtodos disponveis na classe
BusinessPeriodService.
getBusinessPeriods

Retorna os expedientes da empresa.


Mtodo:
getBusinessPeriods(String user, String password, int
companyId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
Retorno: BusinessPeriodDto[].

Quadro 19: Mtodos da BusinessPeriodService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosBusinessPeriodService disponibilizada a classe
BusinessPeriodServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe BusinessPeriodService.

85

ECM - Webservices

AttributionMecanismService
Webservices responsvel por realizar operaes referentes aos mecanismos
de atribuio cadastrados no ECM. Pode ser utilizado para pesquisar os
mecanismos de atribuio de uma determinada empresa.

Mtodos
No quadro 20, mostrado todos os mtodos disponveis na classe
AttributionMecanismService.
getAttributionMecanism

Retorna os mecanismos de atribuio da empresa.


Mtodo:
getAttributionMecanism(String user, String password, int
companyId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
Retorno: AttributionMecanismDto[].

Quadro 20: Mtodos da AttributionMecanismService

Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosAttributionMecanismService disponibilizada a classe
AttributionMecanismServiceClient.java, esta exemplifica a utilizao de todos
os mtodos da classe AttributionMecanismService.

86

ECM - Webservices

CardIndexService
Webservices responsvel por realizar operaes referentes aos fichrios
cadastrados no ECM.

Mtodos
No quadro 21, mostrado todos os mtodos disponveis na classe
CardIndexService.
getCardIndexesWithoutAppr
over

getFormFields

Retorna os fichrios sem aprovadores que o colaborador


tenha permisso.
Mtodo:
getCardIndexesWithoutApprover(String user, String
password, int companyId, String colleagueId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
colleagueId : matrcula do colaborador para a
verificao de permisso nos fichrios.
Retorno: DocumentDto[].
Retorna os campos do fichrio.
Mtodo:
getFormFields(String user, String password, int companyId,
int documentId)
Parmetros:
user: login do colaborador;
password: senha do colaborador;
companyId: cdigo da empresa;
documentId : numero do fichrio.
Retorno: String[].

Quadro 21: Mtodos da CardIndexService

87

ECM - Webservices
Exemplo de utilizao
No diretrio de documentao do ECM na pasta Documentos de
Customizao\Arquivos
Adicionais\Exemplos
Webservices\ExemplosCardIndexService

disponibilizada
a
classe
CardIndexServiceClient.java, esta exemplifica a utilizao de todos os
mtodos da classe CardIndexService.

88