Histórico da Página
...
O objetivo deste documento é descrever as propriedades dos objetos utilizados em múltiplos métodos webservice. A utilidade de cada um dos parâmetros pode variar de método para método dependendo da necessidade da propriedade.
...
São as representações físicas dos anexos que compõem um documento por completo. Suas propriedades representam as informações de um documento específico dentro do grupo que representa o documento como um todo para o GED, que por si só é composto por um anexo principal e pode podendo conter outros anexos complementares.
Propriedade | Descrição | Tipo do objeto |
---|---|---|
fileName | Nome do arquivo físico | String |
pathName | Caminho absoluto do arquivo completo na máquina (sem o nome do arquivo em si), caso o arquivo esteja no mesmo local onde está o servidor fluig | String |
fullPatch | Caminho absoluto do arquivo completo na máquina (com o nome do arquivo em si), caso o arquivo esteja no mesmo local onde está o servidor fluig | String |
fileSize | Tamanho do arquivo físico em bytes | String |
iconPath | Caminho do ícone representativo do documento, caso vazio aparecerá o ícone padrão | String |
attach | Se é anexo do documento, valor true para documentos que não são os principais do documento | Boolean |
principal | Se é arquivo principal, mutuamente exclusivo com a propriedade attach | Boolean |
descriptor | Propriedade que define se o documento é um descritor | Boolean |
editing | Se o anexo está em edição, o padrão é false | Boolean |
fileSelected | Arquivos selecionados, apenas para controle, não preencher | Attachment[] |
filecontent | Conteúdo do arquivo em Base64, caso queira que o arquivo seja transferido por stream | byte |
mobile | Se o arquivo foi adicionado por um dispositivo mobile | Boolean |
Painel |
---|
|
RelatedDocumentDto
...
Representa os documentos relacionados com o documento.
...
Propriedade | Descrição | Tipo do objeto |
---|---|---|
documentId | Número do documento | int |
version | Número da versão do documento | int |
companyId | Código da empresa em que o documento foi publicado | int |
attributionValue | Matricula de um usuário ou o código do grupo que está na segurança deste documento. É possível saber se vai retornar um usuário ou um grupo pelo tipo da segurança. Obs.: Retorna em branco quando o tipo é todos os usuários | String |
attributionType | Tipo da segurança, onde: 1 = Usuário; 2 = Grupo; 3 = Todos os usuários. | int |
permission | Propriedade que define se é uma permissão Obs.: Se não é uma permissão, é uma restrição | boolean |
showContent | Propriedade que define se lista o documento | boolean |
securityLevel | Nível de permissão/restrição onde: -1 = Sem permissão/restrição (nega acesso); 0 = Leitura; 1 = Gravação; 2 = Modificação; 3 = Total. | int |
sequence | Sequência de permissão/restrição | int |
securityVersion | Propriedade que define se o documento utiliza a segurança desta versão nas demais | boolean |
ApproverDto
...
Rpresenta Representa os aprovadores de um documento ou pasta.
...
Propriedade | Descrição | Tipo do objeto |
---|---|---|
attachmentSequence | Código sequencial do anexo | int |
attachments | Objetos representando os anexos físicos | Attachment[] |
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 / 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 arquivo físico | String |
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 |
Painel |
---|
|
KeyValueDto
...
Objeto responsável por informar valores nos campos de formulário.
...
Objeto responsável por informar apontamento da 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 |
movimentSequence | Sequencia da movimentação | int |
colleagueId | Matrícula do usuário que criou o documento | String |
transferenceSequence | Sequencia de transferência da atividade (histórico de movimentações) | int |
appoimentDate | Data para o apontamento | Date |
appoimentSeconds | Segundos para o apontamento | int |
colleagueName | Nome do usuário para o apontamento | String |
...
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 |
...
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 |
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 |
...
Objeto responsável por retornar os números do de pendências do usuário.
Propriedade | Descrição | Tipo do objeto |
---|---|---|
numberOfWorkflowPendingRequests | Quantidade de solicitações iniciadas que estão pendentes | int |
numberOfWorkflowUnderDeadlineRequest | 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 |
...
Objeto responsável por retornar informações da busca do de 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 de pasta | 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 |
...