Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Índice
maxLevel3
outlinetrue
exclude.*ndice
stylenone

 


Objetivo

...

O objetivo deste documento é descrever as propriedades dos objetos utilizados em múltiplos métodos WebService webservice. A utilidade de cada um dos parâmetros pode variar de método para método dependendo da necessidade da propriedade


Pré-requisitos

...

Para compreender melhor os conceitos dessa página, é necessário conhecer as funcionalidades da Utilização de Webservices. 


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

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.

Informações
titleData de Criação

A data de criação é informada automaticamente no evento em que o documento é criado no sistema.

java.util.Date

approvedDate

Data de Aprovação.

java.util.Date

lastModifiedDate

Data da última modificação.

Informações
titleData da última modificação

A data da última modificação é informada automaticamente no evento em que o documento sofre algum tipo de alteração, havendo alteração de versão, revisão ou mantendo a versão/revisão.

java.

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

...

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.

...

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.

...

attach

...

Se é anexo do documento, valor true para documentos que não são os principais do documento.

...

Boolean

...

inheritApproversHerda aprovadores do pai?boolean
convertDocumentType Armazenar por longo prazo (Apenas para pasta)int
notificationDays  Período de Notificação de Expiraçãoint
quotaCota (MB) (Apenas para pasta)int
publicDocument Compartilhar externamente?boolean


DocumentEditDto

...

Este objeto representa as propriedades editáveis de um documento, na tabela abaixo consta mais informações sobre ele:

PropriedadeDescriçãoTipo
version

Versão do documento

Nota
titleAtenção

Essa propriedade somente terá efeito quando for um novo documento e estiver habilitado o Controle manual de versão inicial

int
keyWordPalavras chaves do documento. Cada palavra é separada por vírgula.String
expires

...

Propriedade que define se o documento

...

está expirado.

...

boolean

...

expirationDateData de expiração.java.util.Date
validationStartDateData a partir da qual o documento poderá ser visualizado.java.util.Date


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 podendo conter outros anexos complementares.

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

 

RelatedDocumentDto

Representa os documentos relacionados com o documento.

...

PropriedadeDescriçãoTipo do objeto

...

fileName

...

Nome do

...

arquivo físico

...

String

...

pathName

...

Versão do documento

...

int

...

companyId

...

ID da empresa

...

long

 

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 FluigString
fullPatchCaminho 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 FluigString
fileSizeTamanho do arquivo físico em bytesString
iconPathCaminho do ícone representativo do documento, caso vazio aparecerá o ícone padrãoString
attachSe é anexo do documento, valor true para documentos que não são os principais do documentoBoolean
principalSe é arquivo principal, mutuamente exclusivo com a propriedade attachBoolean
descriptorPropriedade que define se o documento é um descritorBoolean
editingSe o anexo está em edição, o padrão é falseBoolean
fileSelectedArquivos selecionados, apenas para controle, não preencherAttachment[]
filecontentConteúdo do arquivo em Base64, caso queira que o arquivo seja transferido por streambyte
mobileSe o arquivo foi adicionado por um dispositivo mobileBoolean
Painel
  • Objeto Attachment utilizado como parâmetro e retorno para métodos WebService.


RelatedDocumentDto

...

Representa os documentos relacionados com o documento.

PropriedadeDescriçãoTipo do objeto
DocumentIdNúmero do documentoint
versionVersão do documentoint
relatedDocumentIdNúmero do documento que está sendo relacionadoint
companyIdID da empresalong


DocumentSecurityConfigDto

...

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

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.

...

PropriedadeDescriçãoTipo do objeto

...

companyId

...

ID da empresa

...

long

...

colleagueId

...

Matrícula do usuário

...

String

documentIdNúmero do documentoint
version

...

Número da versão do documentoint

...

levelId

...

Nível de aprovação

...

int

...

companyIdCó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
showContentPropriedade que define se lista o documentoboolean
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
sequenceSequência de permissão/restriçãoint
securityVersionPropriedade que define se o documento utiliza a segurança desta versão nas demaisboolean


ApproverDto

...

Representa os aprovadores de um documento ou pasta.

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:

...

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula do usuárioString

...

documentId

...

Número do

...

documento

...

int

...

version

...

Versão do

...

documento

...

int

...

levelId

...

Nível de aprovação

...

int

...

approverTypeTipo de aprovação (0 = Colaboradores / 1 = Grupo)int


ApproverWithLevelDto

...

Representa os aprovadores de um documento ou pasta.

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula

...

do usuárioString

...

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 um documento ou pasta.

PropriedadeDescriçãoTipo do objeto
levelIdNível de aprovaçãoint
levelDescriptionDescrição do nível de aprovaçãoString
approvalModeModo de aprovação (1 = OU / 2 = E / 3 = ÚNICOint


ColleagueDto

...

Representa as propriedades do usuário. A tabela abaixo contém mais informações sobre o objeto.

PropriedadeDescriçãoTipo do objeto
companyIdID da empresalong
colleagueIdMatrícula do usuárioString
colleagueNameNome do usuárioString
mailE-mail do usuárioString
extensionNrRamal do usuárioString
currentProjectProjeto do usuárioString
especializationAreaÁrea de especializaçãoString
loginLogin do usuárioString
passwdSenha do usuárioString
activeStatus do usuárioBoolean
homePageDepreciadoString
photoPathCaminho para foto de perfilString
area1IdDepreciadoint
area2IdDepreciadoint
area3IdDepreciadoint
area4IdDepreciadoint
area5IdDepreciadoint
emailHtmlUtiliza o e-mail em htmlBoolean
adminUserUsuário administradorBoolean
groupIdGrupo de trabalho workflowString
sessionIdSessão do usuárioString
defaultLanguageIdioma padrão de documentosString
menuConfigConfiguração do menuint
dialectIdIdioma do usuárioString
gedUserUsuário GEDBoolean
volumeIdVolume físicoString
colleaguebackgroundDepreciadoString
nominalUserDepreciadoBoolean
guestUserDepreciadoBoolean
maxPrivateSizeEspaço disponível (Meus Documentos)Float
usedSpaceEspaço utilizadoFloat


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 subprojetos como suas próprias prioridades que representam os anexos propriamente ditos.

PropriedadeDescriçãoTipo do objeto
attachmentSequenceCódigo sequencial do anexoint
attachmentsObjetos representando os anexos físicosAttachment[]
colleagueIdMatrícula do usuário anexando o documentoString
colleagueNameNome do usuário anexando o documentoString
companyIdCódigo da empresalong
crcCyclic Redundancy Check, calculado automaticamente, não informarlong
createDateData de criação do anexoDate
createDateTimestampData da criação do anexo em milisegundoslong
deletedSe o arquivo fora deletado dos anexosBoolean
descriptionDescrição do anexoString
documentIdCódigo do documento no GEDint
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
fileNameNome do arquivo físicoString
newAttachSe é um arquivo físicoString
originalMovementSequenceCódigo da movimentação na qual o anexo foi inseridoint
permissionPermissões sobre o anexo específico (é recomendado controlar tais permissões pelas propriedades do processo)String
processInstanceIdCódigo da solicitaçãoint
sizeTamanho somado de todos os arquivos em anexofloat
versionVersão do documentoint
Painel
  • Objeto ProcessAttachmentDto utilizado como parâmetro e retorno para métodos Webservice.


KeyValueDto

...

Objeto responsável por informar valores nos campos de formulário.

PropriedadeDescriçãoTipo do objeto
keyValor do parâmetro 'name' definido no campo do formulárioString
valueValor a ser preenchido no campo definido na propriedade 'key'String


ProcessTaskAppoimentDto

...

Objeto responsável por informar apontamento da atividade de uma solicitação workflow.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdCódigo da solicitaçãoint
movimentSequenceSequencia da movimentaçãoint
colleagueIdMatrícula do usuário que criou o documentoString
transferenceSequenceSequencia de transferência da atividade (histórico de movimentações)int
appoimentDateData para o apontamentoDate
appoimentSecondsSegundos para o apontamentoint
colleagueNameNome do usuário para o apontamentoString


AttributionMecanismDto

...

Objeto responsável por retornar informações de Mecanismo de atribuição.

PropriedadeDescriçãoTipo do obejto
companyIdCódigo da empresalong
attributionMecanismIdCódigo do mecanismo de atribuiçãoString
nameNome do mecanismo de atribuiçãoString
controlClassClasse em que o mecanismo de atribuição está referenciadoString
preSelectionClassSequencia de transferência da atividade (histórico de movimentações)String
configurationClassSequencia de apontamentoString
descriptionDescrição do mecanismo de atribuiçãoString
assignmentTypeTipo do mecanismo de atribuição ( 0 = Inteiro / 1 = Personalizado)int
attributionMecanismDescriptionDescrição do mecanismo de atribuiçãoString


BusinessPeriodInfoDto

...

Objeto responsável por retornar informações de um período de expediente.

PropriedadeDescriçãoTipo do objeto
sequence

Código do período:

1 - Manhã

2 - Tarde

int
initialHourHora inicial do períodoint
finalHourHora final do períodoint


ColleagueReplacementDto

...

Objeto responsável por retornar informações de usuário substituto.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
colleagueIdCódigo do usuário substituídoString
replacementIdCódigo do usuário substitutoString
validationStartDateData inicial da substituição. Exemplo: 2017-08-18T00:00:00-03:00Date
viewWorkflowtasksSubstituto dos processosBoolean
viewGEDTasksSubstituto dos documentosBoolean


Signal

...

Objeto responsável por retornar informações do Sinal.

PropriedadeDescriçãoTipo do objeto
sginalPKChave primária do SinalSignalPK[]
descriptionDescrição do SinalString


SignalPK

...

Objeto responsável por retornar o PK do Sinal.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
signalIdCódigo do sinalint


DeadLineDto

...

Objeto responsável por retornar Data e Hora de uma atividade.

PropriedadeDescriçãoTipo do objeto
dateData (Tipo String no formato "yyy-MM-dd")String
horaHoraint


ProcessDefinitionDto

...

Objeto responsável por retornar informações do processo.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processIdCódigo do processoString
processDescriptionDescrição do processoString
activeProcesso ativo ou nãoBoolean


ProcessDefinitionVersionDto

...

Objeto responsável por retornar informações da versão do processo.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processIdCódigo do processoString
versionVersão do processoint
versionDescriptionDescrição da versão do processoString
fullCategoryStructureCategoria completa do processo, incluindo seu códigoString
processDescriptionDescrição do processoString
favoriteSe o processo está nos favoritos do usuárioBoolean
mobileReadySe o processo está disponível no MobileBoolean
formIdCódigo do formulário vinculado ao processoString
formVersionVersão do formulário vinculado ao processoString
initialProcessStateDescrição do processoProcessStateDto
relatedDatasetsDescrição do processoString[]
counterSignSe o processo assina digitalmenteBoolean


ProcessStateDto

...

Objeto responsável por retornar informações do estado do processo.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
sequenceSequência do processoint
stateNameNome do estado do processo

String

stateDescriptionDescrição do estado do processoString
counterSignSe o processo assina digitalmenteBoolean


AvailableUsersDto

...

Objeto responsável por retornar usuários de uma atividade.

PropriedadeDescriçãoTipo do objeto
willShowUsersUtilizado para exibir a tela de seleção de usuáriosBoolean
isCollectiveTaskSe a atividade é conjuntaBoolean
usersinformações do usuárioColleagueDto[]


ProcessHistoryDto

...

Objeto responsável por retornar informações do histórico de uma solicitação.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da movimentaçãoint
activeSe o processo está ativoBoolean
movementDateData de movimentaçãoDate
movementHourHora de movimentaçãoString
stateSequenceSequencia da movimentaçãoint
subProcessIdNúmero do subprocesso se disponívelint
threadSequenceIndica se existe atividade paralela no processo. Se existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade da atividade paralelas existentes no processo.int
previousMovementSequenceNúmero da movimentação anteriorint
conversionSequenceSequencia quando a solicitação foi convertidaint
isReturmSe possui fluxo de retornoBoolean
labelActivityDescrição da atividadeString
labelLinkLink da atividadeString
tasksAtividadesProcessTaskDto[]


ProcessTaskDto

...

Objeto responsável por retornar informações de uma atividade.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da sequência quando transferidoint
transferredSequenceNúmero da sequência quando transferidoint
colleagueIdMatrícula do usuário da atividadeString
statusStatus da atividadeBoolean
activeSe a atividade está ativaBoolean
isComplementSe é um complementoBoolean
choosedSequenceSequência escolhidaString
ChoosedColleagueIdMatrícula do usuário escolhidoString
taskObservationObservação da atividadeString
taskCompletionDateData de conclusão da atividadeString
taskCompletionHourHora de conclusão da atividadeint
completeColleagueIdUsuário que completou a atividadeString
completeType

Tipo de conclusão:

0 - Gestor

1 - Substituto

2 - Substituto do gestor

int
taskSignedSe a atividade foi assinadaBoolean
deadlineTextTexto de atrasoString
colleagueNameNome do usuárioString
historTaskObservationHistórico de observações na atividadeString
historCompleteColleagueHistórico de conclusões da atividadeString
statusConsultStatus da atividade para consultaint
canCurrentUserTakeTaksSe o usuário pode assumir a atividadeBoolean


WorkflowTaskDto

...

Objeto responsável por retornar informações da tarefa.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
taskIdCódigo da tarefaint
ownerdono da tarefaString
descriptionDescrição da tarefaString
deadlinePrazo da tarefaint
creationDateData de criação da tarefaDate
creationTimeHora de criação da tarefaint
taskStatus

Status da tarefa:

0 - Pendente

1 - Pendente de consenso

2 - Completada

3 - Transferida

4 - Cancelada

int
expectedConclusionDateData de conclusão experadaDate
actualConclusionDateData atual de conclusãoDate
actualConclusionTimeHora atual de conclusãoint
processInstanceIdNúmero da solicitaçãoint
movementSequenceNúmero da movimentaçãoint


WorkflowRoleDto

...

Objeto responsável por retornar informações do Papel.

PropriedadeDescriçãoTipo do objeto
roleIdCódigo do papelString
companyIdCódigo da empresalong
roleDescriptionDescrição do papelString


TaskVODto

...

Objeto responsável por retornar informações da tarefa.

PropriedadeDescriçãoTipo do objeto
taskIdCódigo da tarefaString
typeTipolong
iconsetÍconeString
stateEstado da tarefaString
iconPathCaminho do íconeString
descriptionDescrição da tarefaString
childrenTarefas filhasTaskVODto[]


HomeRequestSummaryDto

...

Objeto responsável por retornar os números de pendências do usuário.

PropriedadeDescriçãoTipo do objeto
numberOfWorkflowPendingRequestsQuantidade de solicitações iniciadas que estão pendentesint
numberOfWorkflowUnderDeadlineRequestsQuantidade de solicitações iniciadas que estão no prazoint
numberOfWorkflowDelavedRequestsQuantidade de solicitações iniciadas que estão atrasadasint
numberOfOpenRequestsQuantidade de solicitações abertasint
numberOfPoolGroupRequestsQuantidade de solicitações em Pool para um Grupoint
numberOfPoolRoleRequestsQuantidade de solicitações em Pool para um Papelint
numberOfDocumentApprovalPendingQuantidade de documentos pendentes de aprovaçãoint
numberOfDocumentAwaitingApprovalQuantidade de documentos aguardando aprovaçãoint
numberOfLearningTasksQuantidade de Tarefas em aprendizagemint
replacementIdMatrícula do usuário substituídoString


WorkflowProcessDto

...

Objeto responsável por retornar informações do processo Workflow.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresalong
processInstanceIdNúmero da solicitaçãoint
processIdCódigo do processoString
versionVersão do processoint
requesterIdMatrícula do usuário requisitanteString
requesterNameNome do usuário requisitanteStirng
activeSe o processo está ativoBoolean
attachmentSeqIdSequência de anexo da atividadeint
processDescriptionMatrícula do usuário substituídoString
deadlineDatePrazo da atividadeDate
deadlineTextTexto de atraso da atividadeString
documentDescriptionDescrição do documentoString
colleagueNameNome do usuárioString
movementSequenceNúmero de movimentoint
mainAttachmentDocumentIdCódigo do documento principalint
mainAttachmentDocumentVersionVersão do documento principalint
counterSignSe o processo assina digitalmenteBoolean
movementHourHora da movimentaçãoString
startupHourHora que foi iniciadoString
mobileReadySe está disponível no mobileBoolean
canCancelSe o usuário pode cancelarBoolean
canTakeSe o usuário pode assumirBoolean
urlURL de acesso ao processoString
relatedDatasetsDatasets relacionados ao processoString[]


WebServiceMessageArray

...

Objeto responsável por retornar informações do documento.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresaint
documentDescriptionDescrição do documentoString
documentIdCódigo do documentoint
versionVersão do documentoint
webServiceMessageMensagem de retornoString


CardEventDtoArray

...

PropriedadeDescriçãoTipo do objeto
eventIdCódigo do eventoint
eventDescriptionDescrição do eventoString
eventVersAntVersão anterior do eventoBoolean


CustomFieldsDto

...

Objeto responsável por retornar informações do campo personalizado.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresaint
customFieldDescriptionDescrição do campo personalizadoString
customFieldIdCódigo do campo personalizadoint


DocumentCustomFieldsDto

...

Objeto responsável por retornar informações do documento com campo personalizado.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresaint
customFieldDescriptionDescrição do campo personalizadoString
customFieldIdCódigo do campo personalizadoint


DocumentApprovementHistoryDto

...

Objeto responsável por retornar Histórico de aprovação de documentos.

PropriedadeDescriçãoTipo do objeto
colleagueIdCódigo do usuárioString
documentVersionVersão do documentoint
iterationSequenceSequencia de interaçãoint
levelIdNível do IDint
movementSequenceSequencia de movimentaçãoString
observationObservaçãoString
signedDocumento assinadoBoolean
statusStatus do documentoint


DocumentApprovalStatusDto

...

Objeto responsável por retornar informações do Status de aprovação de documentos.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresaint
documentIdCódigo do documentoint
versionVersão do documentoint
statusStatus do documentoint


RelatedDocumentDto

...

Objeto responsável por retornar informações do Documento relacionado.

PropriedadeDescriçãoTipo do objeto
companyIdCódigo da empresaint
documentIdCódigo do documentoint
relatedDocumentIdCódigo do documento relacionadoint
versionVersão do documentoint


WorkflowRoleDto

...

Objeto responsável por retornar informações do Papel.

PropriedadeDescriçãoTipo do objeto
roleIdCódigo do papelString
companyIdCódigo da empresalong
roleDescriptionDescrição do papelString


TaskVODto

...

Objeto responsável por retornar informações da Tarefa.

PropriedadeDescriçãoTipo do objeto
taskIdCódigo da tarefaString
typeTipolong
iconsetÍconeString
stateEstado da tarefaString
icoPathCaminho do íconeString
descriptionDescrição da tarefaString
childrenTarefas filhasTaskVODto[]


HomeRequestSummaryDto

...

Objeto responsável por retornar os números de pendências do usuário.

PropriedadeDescriçãoTipo do objeto
numberOfWorkflowPendingRequestsQuantidade de solicitações iniciadas que estão pendentesint
numberOfWorkflowUnderDeadlineRequestQuantidade de solicitações iniciadas que estão no prazoint
numberOfWorkflowDelayedRequestsQuantidade de solicitações iniciadas que estão atrasadasint
numberOfOpenRequestsQuantidade de solicitações abertasint
numberOfPoolGroupRequestsQuantidade de solicitações em Pool para um Grupoint
numberOfPoolRoleRequestsQuantidade de solicitações em Pool para um Papelint
numberOfDocumentApprovalPendingQuantidade de documentos pendentes de aprovaçãoint
numberOfDocumentAwaitingApprovalQuantidade de documentos aguardando aprovaçãoint
numberOfLearningTasksQuantidade de tarefas de Aprendizagemint
replacementIdMatrícula do usuário substituídoString


SearchResultDto

...

Objeto responsável por retornar informações da busca de documento.

PropriedadeDescriçãoTipo do objeto
colleagueIdMatricula do usuário que criou o documentoString
companyIdCódigo da empresaint
crcCrc do documentolong
documentDescriptionNome do documentoString
documentIdCódigo do documentoint
documentTypeTipo do documentoString
folderNameNome de pastaString
iconIdID do íconeint
inheritApproversHerda aprovadoresBoolean
lastModifiedDateÚltima data modificadaDate
parentDocumentIdID do documento paiint
phisicalFileNome do arquivo de downloadString
phisicalFileSizeTamanho do arquivoString
privateDocumentDocumento privadoBoolean
publisherIdID do publicador do documentoString
publisherNameNome do publicador do documentoString
topicIdID do assunto do documentoint
versionVersão do documentoint


DatasetDto

...

Objeto responsável por retornar as colunas e os valores do dataset executado.

PropriedadeDescriçãoTipo do objeto
columnsLista as colunas do datasetString[]
valuesLista os valores retornados em cada colunaValuesDto[]


ValuesDto

...

Objeto responsável por retornar os valores do dataset executado, referente à cada coluna.

PropriedadeDescriçãoTipo do objeto
valueValor retornado em cada colunaObject[]


GroupDto

...

Objeto responsável por retornar as informações do grupo.

PropriedadeDescriçãoTipo do objeto
groupDescriptionDescrição do grupoString
groupIdCódigo do grupoString
companyIdCódigo da empresalong


cardData

...

Responsável pelos dados do registro de formulário.

Bloco de código
<cardData>
   <item>
      <item>campo1</item>
      <item>valor do campo id campo1</item>
   </item>
   <item>
      <item>campo2</item>
      <item>valor do campo id campo2</item>
   </item>
   <item>
      <item>column1___1</item>
      <item>valor do campo em um campo múltiplos registros (pai x filho) com id column1 e na primeira linha</item>
   </item>
   <item>
      <item>column1___2</item>
      <item>valor do campo em um campo múltiplos registros (pai x filho) com id column1 e na segunda linha</item>
   </item>
</cardData>

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

colleagueNameNome do usuário anexando o documento.String
companyIdCódigo da empresa.long
crcCyclic Redundancy Check, calculado automaticamente, não informar.long
createDateData de criação do anexo.Date
createDateTimestampData da criação do anexo em milisegundos.long
deletedSe o arquivo fora deletado dos anexos.Boolean
descriptionDescrição do anexo.String
documentIdCó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
fileNameNome do arquivo físico.String
newAttachSe é um anexo novo (anexado nesta movimentação).Boolean
originalMovementSequenceCódigo da movimentação na qual o anexo foi inserido.int
permissionPermissões sobre o anexo específico (é recomendado controlar tais permissões pelas propriedades do processo).String
processInstanceIdCódigo da solicitação.int
sizeTamanho somado de todos os arquivos em anexo.float
versionVersã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
movementSequenceSequencia da movimentação.int
colleagueIdMatricula do usuário que criou o documento.String
transferenceSequence######### 
appointmentSequence############ 
appointmentDateData para o apontamento.Date
appointmentSecondsSegundos para o apontamento.Date
colleagueName############## 

 

 

 

...