calculateDeadLineHours | Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas.
Método: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- userId - Matrícula do usuário
- data - data (Tipo String no formato "yyyy-MM-dd").
- segundos - Quantidade de segundos após a meia noite
- prazo - Prazo que será aplicado em horas (Variável int).
- periodId - Código de Expediente
Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.
Estrutura de retorno com sucesso <result>
<date>2015-05-08</date>
<hora>43201</hora>
</result> |
Estrutura de retorno com erro <faultstring>NOK Não foi encontrado expediente para o código informado: Default*</faultstring> |
| calculateDeadLineTime | Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos.
Método: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- userId - Matrícula do usuário
- data - data (Tipo String no formato "yyyy-MM-dd").
- segundos - Quantidade de segundos após a meia noite
- prazo - Prazo que será aplicado em minutos (Variável int).
- periodId - Código de Expediente
Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.
Estrutura de retorno com sucesso <result>
<date>2015-03-20</date>
<hora>32400</hora>
</result> |
Estrutura de retorno com erro <faultstring>NOK Não foi encontrado expediente para o código informado: Default*</faultstring> |
| cancelInstance | Cancela uma solicitação.
Método: cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- userId: mátricula do usuário.
- cancelText: comentários do cancelamento.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <result>Processo não encontrado.</result> |
| cancelInstanceByReplacement | Cancela uma solicitação utilizando usuário substituto.
Método: cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- userId: mátricula do usuário.
- cancelText: comentários do cancelamento.
- replacementId: matrícula do usuário substituto.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <result>Processo não encontrado.</result> |
| createWorkFlowProcessVersion | Cria nova versão do processo workflow.
Método: createWorkFlowProcessVersion(String user, String password, int companyId, int processId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: número da solicitação.
Retorno: String.
Estrutura de retorno com sucesso <result>{swimlane=Nova Versão das SwimLanes, processLinkAssoc=Nova Versão das Associações, conditionProcessState=Nova Versão das Condições das Atividades Automáticas, ok=true, flow=Nova Versão dos Fluxos do Processo, end=Versão criada com sucesso, processComponGraf=Nova Versão dos Componentes Gráficos, activity=Nova Versão das Atividades, begin=Criando versão '2' do processo 'Solicitação de férias'}</result> |
Estrutura de retorno com erro <result>{error=Processo não existente}</result> |
| exportProcess | Retorna o processo selecionado em uma String.
Método: exportProcess (String username, String password, int companyId, String processId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- processId - Código do processo
Retorno: String que contém a definição do processo. | exportProcessInZipFormat | Retorna o processo selecionado no formato zip.
Método: exportProcessInZipFormat(String username, String password, int companyId, String processId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- processId - Código do processo
Retorno: byte[] que contém a definição do processo. | getActualThread | Retorna a sequência da thread de uma solicitação.
Método: getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- stateSequence: sequência do estado.
Retorno: int. | getAllActiveStates | Retorna o número da atividade em que uma solicitação esta.
Método: getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processInstanceId: número da solicitação.
Retorno: Integer[]. | getAllProcessAvailableToExport | Retorna uma lista de processos disponíveis para serem exportados.
Método: getAllProcessAvailableToExport (String username, String password, int companyId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
Retorno: ProcessDefinitionDto[]. | getAllProcessAvailableToImport | Retorna uma lista de processos disponíveis para serem importados.
Método: getAllProcessAvailableToImport (String username, String password, int companyId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
Retorno: ProcessDefinitionDto[] | getAttachments | Retorna os anexos de uma solicitação.
Método: getAttachments(String user, String password, int companyId, String userId, int processInstanceId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processInstanceId: número da solicitação.
Retorno: ProcessAttachmentDto[]. | getAvailableProcess | Retorna os processos que o usuário pode iniciar uma solicitação.
Método: getAvailableProcess(String username, String password, int companyId, String userId)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
Retorno: ProcessDefinitionVersionDto[]. | getAvailableProcessOnDemand | Retorna os processos que o usuário pode iniciar uma solicitação, paginados.
Método: getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- limit: número de registros a serem retornados.
- lastRowId: última linha retornada.
Retorno: ProcessDefinitionVersionDto[]. | getAvailableStates | Retorna o número da próxima atividade de uma solicitação.
Método: getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- processInstanceId: número da solicitação.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: Integer[]. | getAvailableStatesDetail | Retorna detalhes das atividades disponíveis para seleção... Caso haja necessidade de utilizar este método na primeira instância do processo, favor consultar a hAPI. |
Método: getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- processInstanceId: número da solicitação.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: ProcessStateDto[]. | getAvailableUsers | Retorna os usuários que podem executar a tarefa corrente de uma solicitação.
Método: getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- state: número da atividade.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: String[]. | getAvailableUsersOnDemand | Retorna os usuários que podem executar a tarefa corrente de uma solicitação, paginados e com busca.
Método: getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId, int state, int threadSequence, int limit, int initialUser, String userSearch)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- state: número da atividade.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- limit: número de registros a serem retornados.
- initialUser: última linha retornada.
- userSearch: texto a ser buscado.
Retorno: AvailableUsersDto. | getAvailableUsersStart | Retorna os usuários disponíveis na abertura de uma solicitação.
Método: getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- state: número da atividade.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: String[]. | getAvailableUsersStartOnDemand | Retorna os usuários disponíveis na abertura de uma solicitação, paginados e com busca.
Método: getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence, int limit, int initialUser, String userSearch)
Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- state: número da atividade.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- limit: número de registros a serem retornados.
- initialUser: última linha retornada.
- userSearch: texto a ser buscado.
Retorno: AvailableUsersDto. | getCardValue | Retorna o valor de um campo do registro de formulário.
Método: getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- userId: mátricula do usuário.
- cardFieldName: nome do campo do registro de formulário.
Retorno: String. | getHistories | Retorna lista de históricos de um processo.
Método: getHistories (String username, String password, int companyId)
Parâmetros: - username - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- userId - Matrícula do usuário
- processInstanceId - número da solicitação workflow
Retorno: ProcessHistoryDto[].
| getInstanceCardData | Retorna o valor dos campos do registro de formulário de uma solicitação.
Método: getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processInstanceId: número da solicitação.
Retorno: String[][]. | getProcessFormId | Retorna o código do formulário vinculado ao processo.
Método: getProcessFormId(String user, String password, int companyId, string processId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
Retorno: int. | getWorkFlowProcessVersion | Retorna a versão de um processo.
Método: getWorkFlowProcessVersion(String user, String password, int companyId, int processId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: número da solicitação.
Retorno: int. | importProcess | Importa processos workflow.
Método: importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- file: arquivo a ser importado.
- newProcess: indica se deve ser criado um processo ou atualizado o existente.
- overWrite: indica se as atividades e fluxos do processo existentes devem ser sobrescritas.
- colleagueId : matrícula do usuário.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <faultstring>Não foi possível importar os dados do arquivo: Solicitação de férias</faultstring> |
| importProcessWithCard | Importa processos workflow e formulário.
Método: importProcessWithCard(String user, String password, int companyId, String processId, Attachment[] processAttachs, boolean newProcess, boolean overWrite, String colleagueId, int parentDocId, String docDescription, String cardDescription, String datasetName, Attachment[] cardAttachs, CardEventDto[] customEvents, boolean update)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- processAttachs: anexos do processo.
- newProcess: indica se deve ser criado um processo ou atualizado o existente.
- overWrite: indica se as atividades e fluxos do processo existentes devem ser sobrescritas.
- colleagueId : matrícula do usuário.
- parentDocId: número do formulário.
- docDescription: descrição.
- cardDescription: nome.
- datasetName: nome do dataset.
- cardAttachs: arquivo anexo.
- customEvents: eventos.
- update: caso verdadeiro ('true'), informa que será uma atualização.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <faultstring>Não foi possível importar os dados do arquivo: Solicitação de férias</faultstring> |
| releaseProcess | Libera processos workflow.
Método: releaseProcess(String user, String password, int companyId, String processId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
Retorno: String. Estrutura de retorno com sucesso
<result>{activityError=[], subProcess=[Sub-processos], subProcessError=[], attachmentSecurityError=[], attachmentSecurity=[Segurança de Anexos], ok=true, flow=[Fluxos], flowError=[], activity=[Atividades], end=Versão liberada para utilização., begin=Liberação da versão 2 do processo Solicitação de férias}</result> |
Estrutura de retorno com erro <result>Login e senha inválidos</result> |
| saveAndSendTask | Movimenta solicitação para próxima atividade. Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o valor. |
Método: saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- choosedState: número da atividade.
- colleagueIds: usuário que receberá a tarefa.
- comments: comentários.
- userId: matrícula do usuário que vai executar a tarefa.
- completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
- attachments: anexos da solicitação.
- cardData: dados do registro de formulário.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta executando a tarefa como gestor do processo.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: String[][].
Estrutura de retorno com sucesso <result>
<item>
<item>iTask</item>
<item>4</item>
</item>
<item>
<item>cDestino</item>
<item>[adm]</item>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<item>ERROR:</item>
<item>Erro ao salvar/completar a tarefa: Usuário destino não foi informado!</item>
</item>
</result> |
| saveAndSendTaskByReplacement | Movimenta solicitação para próxima atividade utilizando usuário substituto. Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o valor. |
Método: saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- choosedState: número da atividade.
- colleagueIds: usuário que receberá a tarefa.
- comments: comentários.
- userId: matrícula do usuário que vai executar a tarefa.
- completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
- attachments: anexos da solicitação.
- cardData: dados do registro de formulário.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta executando a tarefa como gestor do processo.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- replacementId: matrícula do usuário substituto.
Retorno: String[][].
Estrutura de retorno com sucesso <result>
<item>
<item>iTask</item>
<item>4</item>
</item>
<item>
<item>cDestino</item>
<item>[adm]</item>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<item>ERROR:</item>
<item>Erro ao salvar/completar a tarefa: Usuário destino não foi informado!</item>
</item>
</result> |
| saveAndSendTaskClassic | Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor. Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o valor. |
Método: saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- choosedState: número da atividade.
- colleagueIds: usuário que receberá a tarefa.
- comments: comentários.
- userId: matrícula do usuário que vai executar a tarefa.
- completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
- attachments: anexos da solicitação.
- cardData: dados do registro de formulário.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta executando a tarefa como gestor do processo.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Estrutura mínima para movimentação com anexo <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.workflow.ecm.technology.totvs.com/">
<soapenv:Header/>
<soapenv:Body>
<ws:saveAndSendTaskClassic>
<username>adm</username>
<password>adm</password>
<companyId>1</companyId>
<processInstanceId>48</processInstanceId>
<choosedState>2</choosedState>
<colleagueIds>
<item>al01</item>
</colleagueIds>
<comments>movimentação com anexo</comments>
<userId>adm</userId>
<completeTask>true</completeTask>
<attachments>
<item>
<attachmentSequence>0</attachmentSequence>
<attachments>
<attach>true</attach>
<editing>true</editing>
<fileName>pdf_para_teste.pdf</fileName>
<principal>true</principal>
</attachments>
<colleagueId>adm</colleagueId>
<colleagueName>adm</colleagueName>
<companyId>1</companyId>
<deleted>false</deleted>
<description>pdf usado para teste</description>
<documentType>pdf</documentType>
<newAttach>true</newAttach>
<processInstanceId>47</processInstanceId>
</item>
</attachments>
<cardData>
</cardData>
<appointment>
</appointment>
<managerMode>false</managerMode>
<threadSequence>0</threadSequence>
</ws:saveAndSendTaskClassic>
</soapenv:Body>
</soapenv:Envelope> |
O exemplo de movimentação com anexo foi criado considerando do uso da pasta de upload do volume. Sendo assim, o arquivo para transferência deverá estar contido na pasta de upload do usuário. Considerando o exemplo acima, o arquivo pdf_para_teste.pdf deverá estar contido na pasta do usuário, que fica localizada dentro do diretório upload no volume do fluig. Caso não queira utilizar este tipo de transferência para anexo e sim a transferência via Bytes, devem ser adicionadas à estrutura, abaixo da tag <fileName>, as seguintes tags: <fileSize> = para indicar o tamanho do arquivo <filecontent> = que deverá conter os bytes referentes ao arquivo Adicionando estas tags será ignorada a busca no diretório de upload do usuário, sendo considerado o arquivo contido na tag <filecontent>. |
Retorno: KeyValueDto[].
Estrutura de retorno com sucesso <result>
<item>
<item>iTask</item>
<item>4</item>
</item>
<item>
<item>cDestino</item>
<item>[adm]</item>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<item>ERROR:</item>
<item>Erro ao salvar/completar a tarefa: Usuário destino não foi informado!</item>
</item>
</result> |
| searchProcess | Busca processo disponíveis para inicialização.
Método: searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)
Parametros
- user - Usuário de Integração
- password - Senha de Integração
- companyId - Código da empresa
- colleagueId - Matrícula do usuário
- content – nome do processo a ser pesquisado
- favorite – busca da lista de processos favoritos ou da listagem padrão.
Retorno: ProcessDefinitionVersionDto[] | setAutomaticDecisionClassic | Seleciona usuário(s) e avança atividade automática.
Método: setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId, int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId, boolean managerMode, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- iTaskAutom: número da atividade automática.
- iTask: número da atividade atual.
- condition: número da condição da atividade automática.
- colleagueIds: usuário que receberá a tarefa.
- comments: comentários.
- userId: matrícula do usuário que vai executar a tarefa.
- managerMode: indica se usuário esta executando a tarefa como gestor do processo.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: KeyValueDto[]
Estrutura de retorno com sucesso <result>
<item>
<item>iTask</item>
<item>4</item>
</item>
<item>
<item>cDestino</item>
<item>[adm]</item>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<key>ERROR</key>
<value>Nenhum colaborador foi informado.</value>
</item>
</result> |
| setDueDate | Altera a data de prazo da tarefa.
Método: setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- userId: matrícula do usuário. Quando é Para um Grupo ou Para um Papel deve ser passado da seguinte forma:
Papel: "Pool:Role:CodigoDoPapel"; Grupo: "Pool:Group:CodigoDoGrupo". - threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- newDueDate: nova data de prazo da tarefa. Exemplo: "2014-08-20".
- timeInSeconds: quantidade de segundos após a meia noite. Exemplo: "32000".
Retorno: String.
Estrutura de retorno com sucesso <result>Data da solicitação: 26 do usuário: adm da empresa: 1 foi alterada com sucesso!</result> |
Estrutura de retorno com erro <result>Não foi possível encontrar histórico de processo para empresa 1 solicitação 263 thread 0</result> |
| setTasksComments | Altera os comentários da tarefa.
Método: setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação.
- userId: mátricula do usuário.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- comments: comentários.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <result>Não foi possível encontrar histórico de processo para empresa 1 solicitação 263 thread 0</result> |
| simpleStartProcess | Inicia uma solicitação simples.
Método: simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- comments: comentários.
- attachments: anexos da solicitação.
- cardData: dados do registro de formulário.
Retorno: String[].
Estrutura de retorno com sucesso <result>
<item>iTask=2</item>
<item>WDNrVersao=1000</item>
<item>WDNrDocto=0</item>
<item>iProcess=28</item>
<item>cDestino=[adm]</item>
</result> |
Estrutura de retorno com erro <faultstring>Versão do processo não encontrada. processId: 263</faultstring> |
Para utilização do método, acesse o exemplo a seguir: Exemplo. | startProcess | Inicia uma solicitação.
Método: 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)
Parâmetros:
Retorno: String[][].
Estrutura de retorno com sucesso <result>
<item>
<item>iTask</item>
<item>2</item>
</item>
<item>
<item>WDNrVersao</item>
<item>1000</item>
</item>
<item>
<item>WDNrDocto</item>
<item>0</item>
</item>
<item>
<item>iProcess</item>
<item>29</item>
</item>
<item>
<item>cDestino</item>
<item>[adm]</item>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<item>ERROR</item>
<item>Processo informado não foi encontrado.</item>
</item>
</result> |
Para utilização do método, acesse o exemplo a seguir: Exemplo. | startProcessClassic | Inicia uma solicitação e retorna um array de objeto com chave e valor.
Método: startProcessClassic(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processId: código do processo.
- choosedState: número da atividade.
- colleagueIds: usuário que receberá a tarefa.
- comments: comentários.
- userId: matrícula do usuário que vai iniciar a solicitação.
- completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
- attachments: anexos da solicitação.
- cardData: dados do registro de formulário.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.
Retorno: String[][].
Estrutura de retorno com sucesso <result>
<item>
<key>iTask</key>
<value>2</value>
</item>
<item>
<key>WDNrVersao</key>
<value>1000</value>
</item>
<item>
<key>WDNrDocto</key>
<value>0</value>
</item>
<item>
<key>iProcess</key>
<value>30</value>
</item>
<item>
<key>cDestino</key>
<value>[adm]</value>
</item>
</result> |
Estrutura de retorno com erro <result>
<item>
<key>ERROR</key>
<value>Processo informado não foi encontrado.</value>
</item>
</result> |
Para utilização do método, acesse o exemplo a seguir: Exemplo. | takeProcessTask | Assume uma tarefa.
Método: takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processInstanceId: número da solicitação.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <result>Tarefa não encontrada</result> |
| takeProcessTaskByReplacement | Assume uma tarefa utilizando usuário substituto.
Método: takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence, String replacementId)
Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processInstanceId: número da solicitação.
- threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
- replacementId: matrícula do usuário substituto.
Retorno: String.
Estrutura de retorno com sucesso
Estrutura de retorno com erro <result>Usuário não possui permissão para assumir a tarefa</result> |
| updateWorkflowAttachment | Atualiza um documento do tipo 7. Retorna uma string contendo a descrição de sucesso ou falha da operação. Método: updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach) Parâmetros: - username: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- processInstanceId: número da solicitação workflow.
- usuario: usuário responsável pela edição do documento.
- documents: documento ou documentos que serão publicados.
- attachments: arquivo(s) anexado(s) na publicação.
Retorno: String.
Estrutura de retorno com sucesso <result>Documento editado com sucesso</result> |
Estrutura de retorno com erro <result>DOCUMENTO NÃO É ANEXO WORKFLOW</result> |
|
Quadro 24: Métodos da WorkflowEngineService
|