Histórico da Página

Cria um registro de formulário.

Método:

create(int companyId, String user, String password, CardDto[] carddtos)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• carddtos: formulário que será criado.

Retorno: WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

Exclui um formulário e envia para a lixeira.

Método:

deleteCard(int companyId, String user, String password, int cardId)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardId: número do formulário.

Retorno: WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

Altera os metadados de um formulário.

Método:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardDtos: formulário que será alterado.
• attachs: anexos do formulário.
• docsecurity: segurança do formulário.
• docapprovers: aprovadores do formulário.
• reldocs: documentos relacionados do formulário.

Retorno: WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

Altera os campos de um formulário.

Método:

updateCardDataupdateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)

Parâmetros:

• companyId: código da empresa.
• user: login do usuário.
• password: senha do usuário.
• cardId: número do formulário.
• cardData: campos do formulário que serão alterados.

Retorno: WebServiceMessageArray.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

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

Estrutura de retorno com erro

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

Estrutura de retorno com erro

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

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

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

Estrutura de retorno com erro

Retorna detalhes das atividades disponíveis para seleção...

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[].

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

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

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.
  
  

Movimenta solicitação para próxima atividade.

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

Estrutura de retorno com erro

Movimenta solicitação para próxima atividade utilizando usuário substituto.

Método:

saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)

Parâmetros:

• user: login do 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

Estrutura de retorno com erro

Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor.

Método:

saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)

Parâmetros:

• user: login do 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

<fileSize> = para indicar o tamanho do arquivo

<filecontent> = que deverá conter os bytes referentes ao arquivo

Retorno: KeyValueDto[].

Estrutura de retorno com sucesso

Estrutura de retorno com erro

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

Estrutura de retorno com erro

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

Estrutura de retorno com erro

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

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

Estrutura de retorno com erro

Para utilização do método, acesse o exemplo a seguir:

Exemplo.

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:

• 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. Caso a solicitação esteja sendo atribuída "Para um Papel" ou "Para um Grupo", o parâmetro colleagueIds deve ser informado da seguinte forma:
  Papel: Pool:Role:Nome_do_papel
  Grupo: Pool:Group:Nome_do_grupo
• 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

Estrutura de retorno com erro

Para utilização do método, acesse o exemplo a seguir:

.

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

Estrutura de retorno com erro

Para utilização do método, acesse o exemplo a seguir:

Exemplo.

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

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

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

Estrutura de retorno com erro