Histórico da Página
...
Propriedade | Descrição | Tipo do objeto |
companyId | ID da empresa | long |
colleagueId | Matrícula do usuário | String |
documentId | Número do documento | int |
version | Versão do documento | int |
levelId | Nível de aprovação | int |
ApprovalLevelDto
Representa os níveis de aprovação de um documento ou pasta.
Propriedade | Descrição | Tipo do objeto |
levelId | Nível de aprovação | int |
levelDescription | Descrição do nível de aprovação | String |
approvalMode | Modo de aprovação (1 = OU, 2 = E, 3 = ÚNICO) | int |
ColleagueDto
Representa as propriedades do usuário. A tabela abaixo contém mais informações sobre o objeto:
Propriedade | Descrição | Tipo do objeto |
companyId | ID da empresa | long |
colleagueId | Matrícula do usuário | String |
colleagueName | Nome do usuário | String |
| E-mail do usuário | String | |
| extensionNr | Ramal do usuário | String |
| currentProject | Projeto do usuário | String |
| especializationArea | Área de especialização | String |
| login | Login do usuário | String |
| passwd | Senha do usuário | String |
| active | Status do usuário | Boolean |
| homePage | Depreciado | String |
| photoPath | Caminho para foto de perfil | String |
| area1Id | Depreciado | int |
| area2Id | Depreciado | int |
| area3Id | Depreciado | int |
| area4Id | Depreciado | int |
| area5Id | Depreciado | int |
| emailHtml | Utiliza o e-mail em html | Boolean |
| adminUser | Usuário administrador | Boolean |
| groupId | Grupo de trabalho workflow | String |
| sessionId | Sessão do usuário | String |
| defaultLanguage | Idioma padrão de documentos | String |
| menuConfig | Configuração de menu | int |
| dialectId | Idioma do usuário | String |
| gedUser | Usuário GED | Boolean |
| volumeId | Volume físico | String |
| colleaguebackground | Depreciado | String |
| nominalUser | Depreciado | Boolean |
| guestUser | Depreciado | Boolean |
| maxPrivateSize | Espaço disponível (Meus Documentos) | Float |
| usedSpace | Espaço utilizado | Float |
ProcessAttachmentDto
Objeto que representa um anexo de processo, contendo informações sobre a solicitação e sobre o documento o qual representa, bem como os documentos anexados nele próprio. Em resumo é uma representação global de um anexo, constituído por outros subobjetos como suas próprias propriedades que representam os anexos propriamente ditos.
Propriedade | Descrição | Tipo do objeto |
attachmentSequence | Código sequencial do anexo. | int |
attachments | Objetos representando os anexos físicos. | |
colleagueId | Matrícula do usuário anexando o documento. | String |
| colleagueName | Nome do usuário anexando o documento. | String |
| companyId | Código da empresa. | long |
| crc | Cyclic Redundancy Check, calculado automaticamente, não informar. | long |
| createDate | Data de criação do anexo. | Date |
| createDateTimestamp | Data da criação do anexo em milisegundos. | long |
| deleted | Se o arquivo fora deletado dos anexos. | Boolean |
| description | Descrição do anexo. | String |
| documentId | Código do documento no GED. | int |
| DocumentType | Tipo de Documento (2 se é um anexo direto do GED e 7 se é um anexo de processo sem vínculo atual). Utilizar o tipo 7 e publicá-lo após a movimentação caso o deseje no GED. | String |
| fileName | Nome do arquivo físico. | String |
| newAttach | Se é um anexo novo (anexado nesta movimentação). | Boolean |
| originalMovementSequence | Código da movimentação na qual o anexo foi inserido. | int |
| permission | Permissões sobre o anexo específico (é recomendado controlar tais permissões pelas propriedades do processo). | String |
| processInstanceId | Código da solicitação. | int |
| size | Tamanho somado de todos os arquivos em anexo. | float |
| version | Versão do documento. | int |
KeyValueDto
Objeto responsável por informar valores nos campos de formulário.
Propriedade | Descrição | Tipo do objeto |
key | Valor do parâmetro "name" definido no campo do formulário | String |
| value | Valor a ser preenchido no campo definido na propriedade "key" | String |
ProcessTaskAppointmentDto
Objeto responsável informar apontamento na atividade de uma solicitação Workflow.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| processInstanceId | Código da solicitação. | int |
| movementSequence | Sequencia da movimentação. | int |
| colleagueId | Matricula do usuário que criou o documento. | String |
| transferenceSequence | Sequencia de transferencia da atividade (histórico de movimentações) | int |
| appointmentSequence | Sequencia de apontamento. | int |
| appointmentDate | Data para o apontamento. | Date |
| appointmentSeconds | Segundos para o apontamento. | int |
| colleagueName | Nome do usuário para o apontamento. | String |
AttributionMecanismDto
Objeto responsável por retornar informações de Mecanismo de Atribuição.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| attributionMecanismId | Código do Mecanismo de atribuição | String |
| name | Nome do Mecanismo de atribuição | String |
| controlClass | Classe em que o Mecanismo de atribuição está referenciando | String |
| preSelectionClass | Sequencia de transferencia da atividade (histórico de movimentações) | String |
| configurationClass | Sequencia de apontamento. | String |
| description | Descrição do Mecanismo de atribuição | String |
| assignmentType | Tipo do Mecanismo de atribuição (0 = Interno; 1 = CustomizadoPersonalizado) | int |
| attributionMecanismDescription | Descrição do Mecanismo de atribuição | String |
BusinessPeriodDto
Objeto responsável por retornar informações do expediente.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| periodId | Código do Expediente | String |
| periodInfos | Períodos do Expediente | BusinessPeriodInfoDto[] |
BusinessPeriodInfoDto
Objeto responsável por retornar informações de um período de um expediente.
Propriedade | Descrição | Tipo do objeto |
weekDay | Dia da semana: 1 - Domingo 2 - Segunda 3 - Terça 4 - Quarta 5 - Quinta 6 - Sexta 7 - Sábado | int |
| sequence | Código do período: 1 - Manhã 2 - Tarde | int |
| initialHour | Hora inicial do período | int |
| finalHour | Hora final do período | int |
ColleagueReplacementDto
Objeto responsável por retornar informações de substituto.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | long |
| colleagueId | Código do usuário substituído | String |
| replacementId | Código do usuário substituto | String |
| validationStartDate | Data inicial da substituição | Date |
| validationFinalDate | Data final da substituição | Date |
| viewWorkflowTasks | Substituto dos processo | Boolean |
| viewGEDTasks | Substituto dos documentos | Boolean |
Signal
Objeto responsável por retornar informações do Sinal.
Propriedade | Descrição | Tipo do objeto |
signalPK | Chave primária do Sinal | |
| description | Descrição do Sinal | String |
SignalPK
Objeto responsável por retornar o PK do Sinal
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | long |
| signalId | Código do Sinal | int |
DeadLineDto
Objeto responsável por retornar Data e Hora de uma atividade
Propriedade | Descrição | Tipo do objeto |
date | Data (Tipo String no formato "yyyy-MM-dd"). | String |
| hora | Hora | int |
ProcessDefinitionDto
Objeto responsável por retornar informações do processo.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| processId | Código do processo | String |
| processDescription | Descrição do processo | String |
| active | Processo ativo ou não | Boolean |
ProcessDefinitionVersionDto
Objeto responsável por retornar informações da versão do processo.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| processId | Código do processo | String |
| version | Versão do processo | int |
| versionDescription | Descrição da versão do processo | String |
| categoryStructure | Categoria do processo | String |
| fullCategoryStructure | Categoria completa do processo, incluindo seu código | String |
| processDescription | Descrição do processo | String |
| favorite | Se o processo está nos favoritos do usuário | Boolean |
| mobileReady | Se o processo está disponível no Mobile | Boolean |
| formId | Código do formulário vinculado ao processo | String |
| formVersion | Versão do formulário vinculado ao processo | String |
| initialProcessState | Descrição do processo | ProcessStateDto |
| relatedDatasets | Descrição do processo | String[] |
| counterSign | Se o processo assina digitalmente | Boolean |
ProcessStateDto
Objeto responsável por retornar informações do estado do processo.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| sequence | Sequência do processo | int |
| stateName | Nome do estado do processo | String |
| stateDescription | Descrição do estado do processo | String |
| counterSign | Se o processo assina digitalmente | Boolean |
AvailableUsersDto
Objeto responsável por retornar usuários de uma atividade
Propriedade | Descrição | Tipo do objeto |
willShowUsers | Utilizado para exibir a tela de seleção de usuários | Boolean |
| isCollectiveTask | Se a atividade é conjunta | Boolean |
| users | Informações do usuário | ColleagueDto[] |
ProcessHistoryDto
Objeto responsável por retornar informações do histórico de uma solicitação
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | long |
| processInstanceId | Número da solicitação | int |
| movementSequence | Número da movimentação | int |
| active | Se o processo está ativo | Boolean |
| movementDate | Data de movimentação | Date |
| movementHour | Hora de movimentação | String |
| stateSequence | Sequencia da movimentação | int |
| subProcessId | Número do subprocesso se disponível | int |
| 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. | int |
| previousMovementSequence | Número da movimentação anterior | int |
| conversionSequence | Sequencia quando a solicitação foi convertida | int |
| isReturn | Se possui fluxo de retorno | Boolean |
| labelActivity | Descrição da atividade | String |
| labelLink | Link da atividade | String |
| tasks | Atividades | ProcessTaskDto[] |
ProcessTaskDto
Objeto responsável por retornar informações de uma atividade
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | long |
| processInstanceId | Número da solicitação | int |
| movementSequence | Número da movimentação | int |
| transferredSequence | Número da sequência quando transferido | int |
| colleagueId | Matrícula do usuário da atividade | String |
| status | Status da atividade | Boolean |
| active | Se a atividade está ativa | Boolean |
| isComplement | Se é um complemento | Boolean |
| choosedSequence | Sequência escolhida | String |
| choosedColleagueId | Matrícula do usuário escolhido | String |
| taskObservation | Observação da atividade | String |
| taskCompletionDate | Data de conclusão da atividade | String |
| taskCompletionHour | Hora de conclusão da atividade | int |
| completeColleagueId | Usuário que completou a atividade | String |
| completeType | Tipo de conclusão: 0 - Gestor 1 - Substituto 2 - Substituto do gestor | int |
| taskSigned | Se a atividade foi assinada | Boolean |
| deadlineText | Texto de atraso | String |
| colleagueName | Nome do usuário | String |
| historTaskObservation | Histórico de observações na atividade | String |
| historCompleteColleague | Histórico de conclusões da atividade | String |
| statusConsult | Status da atividade para consulta | int |
| canCurrentUserTakeTask | Se o usuário logado pode assumir a atividade | Boolean |
WorkflowTaskDto
Objeto responsável por retornar informações da tarefa.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa. | long |
| taskId | Código da tarefa | int |
| owner | Dono da tarefa | String |
| description | Descrição da tarefa | String |
| deadline | Prazo da tarefa | int |
| creationDate | Data de criação da tarefa | Date |
| creationTime | Hora de criação da tarefa | int |
| taskStatus | Status da tarefa: 0 - Pendente 1 - Pendente de consenso 2 - Completada 3 - Transferida 4 - Cancelada | int |
| expectedConclusionDate | Data de conclusão experada | Date |
| actualConclusionDate | Data atual de conclusão | Date |
| actualConclusionTime | Hora atual de conclusão | int |
| processInstanceId | Número da solicitação | int |
| movementSequence | Número da movimentação | int |
WorkflowRoleDto
Objeto responsável por retornar informações do Papel
Propriedade | Descrição | Tipo do objeto |
roleId | Código do Papel | String |
| companyId | Código da empresa | long |
| roleDescription | Descrição do Papel | String |
TaskVODto
Objeto responsável por retornar informações da Tarefa
Propriedade | Descrição | Tipo do objeto |
taskId | Código da Tarefa | String |
| type | Tipo | long |
| iconset | Ícone | String |
| state | Estado da Tarefa | String |
| iconPath | Caminho do ícone | String |
| description | Descrição da Tarefa | String |
| children | Tarefas filhas | TaskVODto[] |
HomeRequestSummaryDto
Objeto responsável por retornar os números de pendências do usuário
Propriedade | Descrição | Tipo do objeto |
numberOfWorkflowPendingRequests | Quantidade de solicitações iniciadas que estão pendentes | int |
| numberOfWorkflowUnderDeadlineRequests | Quantidade de solicitações iniciadas que estão no prazo | int |
| numberOfWorkflowDelayedRequests | Quantidade de solicitações iniciadas que estão atrasadas | int |
| numberOfOpenRequests | Quantidade de solicitações abertas | int |
| numberOfPoolGroupRequests | Quantidade de solicitações em Pool para um Grupo | int |
| numberOfPoolRoleRequests | Quantidade de solicitações em Pool para um Papel | int |
| numberOfDocumentApprovalPending | Quantidade de documentos pendentes de aprovação | int |
| numberOfDocumentAwaitingApproval | Quantidade de documentos aguardando aprovação | int |
| numberOfLearningTasks | Quantidade de Tarefas de Aprendizagem | int |
| replacementId | Matrícula do usuário substituído | String |
WorkflowProcessDto
Objeto responsável por retornar informações do Processo Workflow
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | long |
| processInstanceId | Número da solicitação | int |
| processId | Código do processo | String |
| version | Versão do processo | int |
| requesterId | Matrícula do usuário requisitante | String |
| requesterName | Nome do usuário requisitante | String |
| active | Se o processo está ativo | Boolean |
| attachmentSeqId | Sequência de anexo da atividade | int |
| stateId | ID do estado | int |
| stateDescription | Matrícula do usuário substituído | String |
| processDescription | Descrição do processo | String |
| deadlineDate | Prazo da atividade | Date |
| deadlineText | Texto de atraso da atividade | String |
| documentDescription | Descrição do documento | String |
| colleagueName | Nome do usuário | String |
| movementSequence | Número de movimento | int |
| mainAttachmentDocumentId | Código do documento principal | int |
| mainAttachmentDocumentVersion | Versão do documento principal | int |
| counterSign | Se o processo assina digitalmente | Boolean |
| movementHour | Hora da movimentação | String |
| startupHour | Hora que foi iniciado | String |
| mobileReady | Se está disponível no Mobile | Boolean |
| canCancel | Se usuário pode cancelar | Boolean |
| canTake | Se usuário pode assumir | Boolean |
| url | URL de acesso ao processo | String |
| code | Código do processo | String |
| relatedDatasets | Datasets relacionados ao processo | String[] |
WebServiceMessageArray
Objeto responsável por retornar informações do documento documento.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | int |
documentDescription | Descrição do documento | String |
documentId | Código do documento | int |
version | Versão do documento | int |
webServiceMessage | Mensagem de retorno | String |
CardEventDtoArray
Objeto responsável por retornar evento de documento
Propriedade | Descrição | Tipo do objeto |
eventId | Código do evento | int |
eventDescription | Descrição do evento | String |
eventVersAnt | Versão anterior do evento | Boolean |
CustomFieldsDto
Objeto responsável por retornar informações do campo customizado
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | int |
customFieldDescription | Descrição do campo customizado | String |
customFieldId | Código do campo customizado | int |
DocumentCustomFieldsDto
Objeto responsável por retornar informações do documento com campo customizado customizado.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | int |
customFieldDescription | Descrição do campo customizado | String |
customFieldId | Código do campo customizado | int |
DocumentApprovementHistoryDto
Objeto responsável por retornar Histórico Histórico de aprovação de documentos documentos.
Propriedade | Descrição | Tipo do objeto |
colleagueId | Código do usuário | String |
documentVersion | Versão do documento | int |
iterationSequence | Sequencia de interação | int |
levelId | Nivel do ID | int |
movementSequence | Sequencia da movimentação | String |
observation | Observação | String |
signed | Documento assinado | Boolean |
status | Status do documento | int |
DocumentApprovalStatusDto
Objeto responsável por retornar informações do Status de Aprovação do Documento Documento.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | int |
documentId | Código do documento | int |
version | Versão do documento | int |
status | Status do documento | int |
RelatedDocumentDto
Objeto responsável por retornar informações do Documento relacionado relacionado.
Propriedade | Descrição | Tipo do objeto |
companyId | Código da empresa | int |
documentId | Código do documento | int |
relatedDocumentId | Código do documento relacionado | int |
version | Versão do documento | int |
WorkflowRoleDto
Objeto responsável por retornar informações do Papel Papel.
Propriedade | Descrição | Tipo do objeto |
roleId | Código do Papel | String |
companyId | Código da empresa | long |
roleDescription | Descrição do Papel | String |
TaskVODto
Objeto responsável por retornar informações da Tarefa Tarefa.
Propriedade | Descrição | Tipo do objeto |
taskId | Código da Tarefatarefa | String |
type | Tipo | long |
iconset | Ícone | String |
state | Estado da Tarefatarefa | String |
iconPath | Caminho do ícone | String |
description | Descrição da Tarefatarefa | String |
children | Tarefas filhas |
HomeRequestSummaryDto
Objeto responsável por retornar os números de pendências do usuário usuário.
Propriedade | Descrição | Tipo do objeto |
numberOfWorkflowPendingRequests | Quantidade de solicitações iniciadas que estão pendentes | int |
numberOfWorkflowUnderDeadlineRequests | Quantidade de solicitações iniciadas que estão no prazo | int |
numberOfWorkflowDelayedRequests | Quantidade de solicitações iniciadas que estão atrasadas | int |
numberOfOpenRequests | Quantidade de solicitações abertas | int |
numberOfPoolGroupRequests | Quantidade de solicitações em Pool para um Grupo | int |
numberOfPoolRoleRequests | Quantidade de solicitações em Pool para um Papel | int |
numberOfDocumentApprovalPending | Quantidade de documentos pendentes de aprovação | int |
numberOfDocumentAwaitingApproval | Quantidade de documentos aguardando aprovação | int |
numberOfLearningTasks | Quantidade de Tarefas de Aprendizagemtarefas de Aprendizagem | int |
replacementId | Matrícula do usuário substituído | String |
SearchResultDto
Objeto responsável por retornar informações da busca do documento documento.
Propriedade | Descrição | Tipo do objeto |
colleagueId | Matricula do usuário que criou o documento. | String |
companyId | Código da empresa | int |
crc | Crc do documento | long |
documentDescription | Nome do documento | String |
documentId | Código do documento | int |
documentType | Tipo do documento | String |
folderName | Nome da Pastapasta | String |
iconId | ID do ícone | int |
inheritApprovers | Herda aprovadores | Boolean |
lastModifiedDate | Última data modificada | Date |
parentDocumentId | ID do documento pai | int |
phisicalFile | Nome do arquivo de download | String |
phisicalFileSize | Tamanho do arquivo | String |
privateDocument | Documento privado | Boolean |
publisherId | ID do publicador do documento | String |
publisherName | Nome do publicador do documento | String |
topicId | ID do assunto do documento | int |
version | Versão do documento | int |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas