Índice

Objetivo

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.

DocumentDto

Representa o documento e suas propriedades. A tabela abaixo contém mais informações sobre o objeto:

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
UUID	UUID (identificador Único Global) do documento.	String
documentTypeId	Tipo do arquivo físico, se retornar branco ou nulo é porque esse tipo não é conhecido pelo fluig.	String
languageId	Código do Idioma do documento.	String
iconId	Código do Ícone do documento.	int
topicId	Código do assunto do documento.	int
colleagueId	Matricula do usuário que criou o documento.	String
documentDescription	Descrição do documento.	String
additionalComments	Comentários adicionais do documento.	String
phisicalFile	Nome do arquivo físico atrelado ao documento.	String
createDate	Data de criação.	java.util.Date
approvedDate	Data de Aprovação.	java.util.Date
lastModifiedDate	Data da última modificação.	java.util.Date
documentType	Tipo do documento, onde: 0 = Pasta raiz 1 = Pasta 2 = Documento normal 3 = Documento externo 4 = Formulário 5 = Registro de formulário 7 = Anexo Workflow 8 = Novo Conteúdo 9 = Aplicativo 10 = Relatório portal = Site portalPage = Página de Site.	String
expirationDate	Data de expiração.	java.util.Date
parentDocumentId	Número da Pasta/Formulário pai.	int
relatedFiles	String com o nome do arquivo físico principal e anexos.	String
activeVersion	Propriedade que define se a versão é ativa.	boolean
versionDescription	Descrição da versão.	String
downloadEnabled	Propriedade que define se o documento permite Download	boolean
approved	Propriedade que define se o documento está em aprovação.	boolean
validationStartDate	Data a partir da qual o documento poderá ser visualizado.	java.util.Date
publisherId	Matricula do usuário que publicou o documento.	String
cardDescription	Descrição do registro de formulário, para documento do tipo 5.	String
documentPropertyNumber	Formulário que foi usado como base para criação do registro de formulário, por isso só tem um valor quando o documento é do tipo 5 (registro de formulário).	int
documentPropertyVersion	Versão do formulário em que o registro de formulário foi criado.	int
privateDocument	Propriedade que define se o documento/pasta está abaixo da pasta particular.	boolean
privateColleagueId	Se é um documento particular retorna a matricula do usuário onde este documento está alocado.	String
indexed	Propriedade que define se o documento já foi indexado.	boolean
priority	Prioridade do documento.	int
userNotify	Propriedade que define se notifica os usuários que tenham esse assunto de interesse.	boolean
expires	Propriedade que define se o documento está expirado.	boolean
volumeId	Volume onde o documento foi publicado, se estiver em branco ele utiliza o volume do pai.	String
inheritSecurity	Propriedade que define se herda segurança do pai.	boolean
updateIsoProperties	Propriedade que define se atualiza as propriedades da cópia controlada.	boolean
lastModifiedTime	Hora da última modificação em milissegundos.	String
deleted	Propriedade que define se o documento está na lixeira.	boolean
datasetName	Documento do dataset , se o documento é um formulário.	String
keyWord	Palavras chaves do documento. Cada palavra é separada por vírgula.	String
imutable	Propriedade que define se a versão/revisão é inalterável.	boolean
draft	Propriedade que define se o documento está em edição, para documento do tipo “Novo Conteúdo”.	boolean
internalVisualizer	Propriedade que define se utiliza visualizador interno.	boolean
phisicalFileSize	Tamanho físico do documento principal e anexos.	float
versionOption	Condição de versionamento do documento: 0 = Será mantida a versão 1 = Será criado nova revisão 2 = Será criado nova versão Importante lembrar que no momento da criação de um novo documento o valor sempre será 0.	int

Attachment

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 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 é o 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, 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

Objeto Attachment utilizado como parâmetro e retorno para métodos WebService.

RelatedDocumentDto

Representa os documentos relacionados com o documento.

Propriedade	Descrição	Tipo do objeto
documentId	Número do documento	int
version	Versão do documento	int
relatedDocumentId	Número do documento que está sendo relacionado	int
companyId	ID da empresa	long

DocumentSecurityConfigDto

Representa a segurança de um documento e suas propriedades. Na tabela abaixo constam mais informações sobre ele:

Função	Descrição da Função	Tipo do Retorno
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 conteúdo.	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 da permissão/restrição.	int
securityVersion	Propriedade que define se o documento utiliza a segurança desta versão nas demais.	boolean

ApproverDto

Representa os aprovadores de um documento ou pasta.

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
approverType	Tipo de aprovadores (0 = Colaboradores, 1 = Grupo)	int

ApproverWithLevelDto

Representa os aprovadores de um documento ou pasta.

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
mail	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.	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 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

Objeto ProcessAttachmentDto utilizado como parâmetro e retorno para métodos WebService.

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 = Customizado)	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	SignalPK
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