InfoShare
O InfoShare foi projetado para uso em empresas que buscam otimizar a maneira como gerenciam documentos digitais, informações, associadores e processos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte à Kendox |
| URL | https://kendox.com/en/service/support-services |
| support@kendox.com |
| Metadados do conector | |
|---|---|
| Publicador | Kendox AG |
| Site | https://www.kendox.com/en |
| Política de privacidade | https://www.kendox.com/en/about-us/data-protection |
| Categorias | Colaboração; Conteúdo e arquivos |
Conector kendox infoshare
O Kendox InfoShare fornece uma API REST poderosa e muito extensa. Usando essa API, você pode criar e gerenciar documentos e processos no InfoShare. Junto com o Conector do Kendox InfoShare Power Automate, você pode simplificar os processos de conteúdo em um cenário de aplicativo generalizado, evitando silos de informações.
Pré-requisitos
Você precisará do seguinte para continuar:
- Uma licença para usar esse conector disponível por meio de sales365@kendox.com.
- Kendox InfoShare com os pontos de extremidade de serviço do WCF acessíveis online.
- Credenciais de logon do Kendox InfoShare.
Operações com suporte
O conector dá suporte às seguintes operações:
Geral
-
Logon: faça logon no InfoShare Server -
Logon with hashed password: faça logon no InfoShare Server -
Logoff: faça logon no InfoShare Server -
Get documents and processes selection: obter documentos e processos selecionados no Cliente Web Móvel por meio de ação de botão personalizado
Documento
-
Create document (deprecated): criar um documento no InfoShare, versão preterida -
Create document (V2): criar um documento no InfoShare, versão sugerida -
Update document (deprecated): atualize o documento no InfoShare, versão preterida -
Update document (V2): atualize o documento no InfoShare, versão sugerida -
Get document properties: obter as propriedades de um documento do InfoShare -
Get file content: obter o conteúdo de um arquivo do InfoShare -
Get file content converted: converte o conteúdo de um arquivo em outro formato de arquivo (e.g. tiff em pdf). Obter conteúdo do arquivo, incluindo anotações e sobreposições -
Get document: retorna informações do documento (estrutura) do InfoShare -
Merge PDF documents: mesclar dois ou mais documentos PDF em um documento de destino
Processo
-
Create process: criar e iniciar um processo -
Update process (deprecated): atualizar um processo no InfoShare, versão preterida -
Update process (V2): atualizar um processo no InfoShare, versão sugerida -
Close an open process: feche um processo no InfoShare -
Close task and continue process: feche uma tarefa de processo no InfoShare -
Close current task and assign user to next task: feche uma tarefa de processo e atribua o usuário à próxima tarefa no InfoShare -
Get process: retorna uma lista de informações do processo (estrutura) do InfoShare -
Get process properties: obter as propriedades de um processo do InfoShare
Pesquisa
-
Document Search (deprecated): pesquisar documentos no InfoShare, versão preterida -
Document Search (V2): pesquisar documentos no InfoShare, versão sugerida -
List processes (deprecated): obter uma lista de processos no InfoShare, substituído pela ação de pesquisa de processo -
Process search: pesquisar processos no InfoShare
Tabelas de usuário
-
Create a user table: cria uma tabela de usuário -
Get rows from a user table: obtém algumas linhas de uma tabela de usuário -
Insert rows into a user table: inserir linhas em uma tabela de usuário -
Update a row in a user table: atualize uma linha em uma tabela de usuário -
Delete user table rows: exclui algumas linhas de uma tabela de usuário
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar documento (preterido) [PRETERIDO] |
Atualizar documento (preterido) |
| Atualizar documento (V2) |
Atualizar documento (V2) |
| Atualizar uma linha em uma tabela de usuário |
Atualizar uma linha em uma tabela de usuário |
| Criar documento (preterido) [PRETERIDO] |
Criar documento (preterido) |
| Criar documento (V2) |
Criar documento (V2) |
| Criar uma tabela de usuário |
Criar uma tabela de usuário |
| Excluir linhas de tabela do usuário |
Excluir linhas de tabela do usuário |
| Fechar a tarefa atual e atribuir o usuário à próxima tarefa |
Fechar a tarefa atual e atribuir o usuário à próxima tarefa |
| Fechar tarefa e continuar o processo |
Fechar tarefa e continuar o processo |
| Fechar um processo aberto |
Fechar um processo aberto |
| Inserir linhas em uma tabela de usuário |
Importar linhas de tabela para uma tabela de usuário |
| Logoff |
Logoff |
| Logon |
Logon |
| Logon com senha hash |
Logon com senha hash |
| Mesclar documentos PDF |
Mesclar dois ou mais documentos PDF em um documento |
| Obter a seleção de documentos e processos |
Obter documentos e processos selecionados no Cliente Web Móvel por meio de ação de botão personalizado |
| Obter conteúdo do arquivo |
Obter conteúdo do arquivo |
| Obter documento |
Obter documento |
| Obter linhas de uma tabela de usuário |
Obter linhas de uma tabela de usuário |
| Obter o conteúdo do arquivo convertido |
Converter o conteúdo do arquivo em um formato diferente. Adicionar anotação ou sobreposição ao conteúdo do arquivo |
| Obter processo |
Obter processo |
| Obter propriedades do documento |
Obter propriedades do documento |
| Obter propriedades do processo |
Obter propriedades do processo |
| Pesquisa de documentos (preterida) [PRETERIDA] |
Pesquisa de documentos (preterida) |
| Pesquisa de documentos (V2) |
Pesquisa de documentos (V2) |
| Pesquisa de processo |
Pesquisa de processo |
| Processo de atualização (preterido) [PRETERIDO] |
Processo de atualização (preterido) |
| Processo de atualização (V2) |
Processo de atualização (V2) |
| Processo de criação |
Processo de criação |
| Processos de lista (preteridos) [PRETERIDO] |
Processos de lista (preteridos) |
Atualizar documento (preterido) [PRETERIDO]
Atualizar documento (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
DocumentId | True | string |
ID do documento |
|
DocumentTitle
|
DocumentTitle | string |
Título do documento |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de atualização de propriedades do documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
|
|
FileContent
|
FileContent | string |
Cadeia de caracteres base64 do conteúdo do arquivo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement está ativo em alterações de arquivo |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement está ativo na exclusão |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement está ativo em alterações de índice |
|
UserId
|
abonnements.userId | string |
A ID do usuário para este abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Data de criação da anotação de postagem |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
ID de usuário do criador da anotação post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação post itálico |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
É fonte atacar fora da anotação de postagem |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is Font is underline from post it annotation |
|
Nome
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nome da fonte da anotação de postagem. Padrão = Arial |
|
Densidade
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de postagem |
|
Tamanho
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de postagem. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de postagem |
|
ID
|
annotationManager.postItAnnotations.id | string |
ID da anotação de postagem |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Data da modificação da anotação de postagem. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas da anotação de postagem |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nível de segurança para postar a anotação (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.postItAnnotations.selectable | boolean |
Define se a anotação de postagem é selecionável pelo usuário |
|
Texto
|
annotationManager.postItAnnotations.text | string |
Texto definido pelo usuário para postá-lo anotação |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação post it |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Cor
|
annotationManager.rectangleAnnotations.color | integer |
Cor do retângulo (valor ARGB de 32 bits) da anotação do retângulo Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Cor do retângulo (código hexadecimal RGB) da anotação do retângulo. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Data de criação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Altura do retângulo em pixel por polegada para 7200 DPI |
|
ID
|
annotationManager.rectangleAnnotations.Id | string |
ID da anotação do retângulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data da modificação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas da anotação do retângulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de retângulo (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define se a anotação do retângulo é selecionável pelo usuário |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
O retângulo deve ser transparente (realce) |
|
Largura
|
annotationManager.rectangleAnnotations.width | integer |
Largura do retângulo em pixel por polegada para 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação de retângulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação de retângulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Cor da tela de fundo (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Cor da tela de fundo (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
data de criação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
ID do usuário do criador da anotação de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação de texto |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
A fonte é retirada da anotação de texto |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
É sublinhado de fonte da anotação de texto |
|
Nome
|
annotationManager.textAnnotations.fontInfo.name | string |
Nome da fonte da anotação de texto. Padrão = Arial |
|
Densidade
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de texto |
|
Tamanho
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de texto. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de texto |
|
Primeiro PlanoColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Cor do primeiro plano (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Cor do primeiro plano (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Altura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
ID
|
annotationManager.textAnnotations.id | string |
ID da anotação de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Data da modificação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas da anotação de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotação em graus da anotação de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de texto (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.textAnnotations.selectable | boolean |
Define se a anotação de texto é selecionável pelo usuário |
|
Texto
|
annotationManager.textAnnotations.text | string |
Anotação de texto definida pelo usuário |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
A anotação de texto deve ser transparente |
|
Largura
|
annotationManager.textAnnotations.width | integer |
Largura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI da anotação de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI da anotação de texto |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Data em que o Blog foi criado. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
ID do usuário do blog de criação de usuário |
|
ID
|
blogs.id | string |
ID do blog |
|
Texto
|
blogs.text | string |
Texto do item de blog |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
documentData
|
documentData | array of object |
documentData |
|
ID
|
documentData.id | string |
ID dos dados do documento |
|
Nome
|
documentData.name | string |
Nome dos dados do documento |
|
Interpretações
|
documentData.renditions | array of |
Interpretações |
|
HasOverlay
|
hasOverlay | boolean |
Define se o documento deve ser exibido com uma sobreposição |
|
ID
|
id | string |
ID do documento |
|
ImportTemplateId
|
importTemplateId | string |
ID do modelo de importação deste documento |
|
InfoStoreId
|
infoStoreId | string |
ID do repositório de informações |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado do ciclo de vida do check-out |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data de término calculada do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data de início do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ID do estado do Ciclo de Vida |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Próximo estado do ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir a exclusão do documento após a expiração da proteção |
|
ID
|
lifeCycleManager.lifeCycleProtections.id | string |
ID da proteção do estado do ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Proteger contra alterações de anotação |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Proteger contra check-out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Proteger contra alteração de conteúdo |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Proteger contra exclusão |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Proteger contra alterações de propriedade |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Proteger contra alterações de segurança |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duração da proteção |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ID do Ciclo de Vida |
|
MainFileLength
|
mainFileLength | integer |
Tamanho principal do arquivo |
|
Nome
|
name | string |
Nome do documento |
|
PageCount
|
pageCount | integer |
Contagem de páginas do arquivo principal |
|
propriedades
|
properties | array of object |
propriedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto |
|
PropertyName
|
properties.propertyName | string |
Nome da propriedade |
|
PropertyTypeId
|
properties.propertyTypeId | string |
ID do tipo do campo de índice |
|
values
|
properties.values | array of string |
Valores de PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção |
|
Lembretes
|
reminders | array of object |
Lembretes |
|
Description
|
reminders.description | string |
Descrição para lembrete |
|
Intervalo
|
reminders.interval | integer |
Intervalo em dias entre lembretes |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
ID do modelo de processo para este lembrete |
|
ReminderDate
|
reminders.reminderDate | string |
Data do lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
ID do lembrete |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Define se a definição do usuário do modelo de processo será usada |
|
SigningProfileId
|
signingProfileId | string |
ID do perfil de assinatura |
|
VersionId
|
versionId | string |
ID da versão do documento |
Atualizar documento (V2)
Atualizar documento (V2)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentTitle
|
DocumentTitle | string |
Título do documento |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de atualização de propriedades do documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveDocumentProperties
|
RemoveDocumentProperties | string |
Lista de nomes ou IDs da propriedade separada ponto-e-vírgula a serem removidas do documento, como "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Departamentos" |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
|
|
DocumentId
|
DocumentId | True | string |
ID do documento |
|
ProtectionDomain
|
ProtectionDomain | string |
Nome ou ID do ProtectionDomain |
|
|
Blogue
|
Blog | string |
Adicionar uma entrada de texto do Blog no documento |
|
|
UploadMethod
|
UploadMethod | string |
Método usado para carregar o documento no InfoShare. Default = UploadFileBytesLarge |
|
|
FileContent
|
FileContent | string |
Cadeia de caracteres base64 do conteúdo do arquivo |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Desfazer o check-out de um documento. Padrão = false |
|
|
ChunkSize
|
ChunkSize | integer |
Tamanho da parte de upload de arquivo usada com os métodos de upload UploadStreamChunks e UploadFileBytesLarge, padrão 262144 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
Abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement está ativo em alterações de arquivo |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement está ativo na exclusão |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement está ativo em alterações de índice |
|
UserId
|
abonnements.userId | string |
A ID do usuário para este abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumerações de direitos de acesso |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Data de criação da anotação de postagem |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
ID de usuário do criador da anotação post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação post itálico |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
É fonte atacar fora da anotação de postagem |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is Font is underline from post it annotation |
|
Nome
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nome da fonte da anotação de postagem. Padrão = Arial |
|
Densidade
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de postagem |
|
Tamanho
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de postagem. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de postagem |
|
ID
|
annotationManager.postItAnnotations.id | string |
Anotação postá-la ID |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Data da modificação da anotação de postagem. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas da anotação de postagem |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nível de segurança para postar a anotação (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.postItAnnotations.selectable | boolean |
Define se a anotação de postagem é selecionável pelo usuário |
|
Texto
|
annotationManager.postItAnnotations.text | string |
Texto definido pelo usuário para postá-lo anotação |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação post it |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Cor
|
annotationManager.rectangleAnnotations.color | integer |
Cor do retângulo (valor ARGB de 32 bits) da anotação do retângulo Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Cor do retângulo (código hexadecimal RGB) da anotação do retângulo. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Data de criação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
ID do criador de anotação do retângulo |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Altura do retângulo em pixel por polegada para 7200 DPI |
|
ID
|
annotationManager.rectangleAnnotations.Id | string |
ID de anotação do retângulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data da modificação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas da anotação do retângulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de retângulo (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define se a anotação do retângulo é selecionável pelo usuário |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
O retângulo deve ser transparente (realce) |
|
Largura
|
annotationManager.rectangleAnnotations.width | integer |
Largura do retângulo em pixel por polegada para 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação de retângulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação de retângulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
Anotações de texto |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Cor da tela de fundo (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Cor da tela de fundo (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
data de criação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
ID do usuário do criador da anotação de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação de texto |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
A fonte é retirada da anotação de texto |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
É sublinhado de fonte da anotação de texto |
|
Nome
|
annotationManager.textAnnotations.fontInfo.name | string |
Nome da fonte da anotação de texto. Padrão = Arial |
|
Densidade
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de texto |
|
Tamanho
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de texto. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de texto |
|
Primeiro PlanoColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Cor do primeiro plano (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Cor do primeiro plano (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Altura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
ID
|
annotationManager.textAnnotations.id | string |
ID da anotação de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Data da modificação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas da anotação de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotação em graus da anotação de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de texto (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.textAnnotations.selectable | boolean |
Define se a anotação de texto é selecionável pelo usuário |
|
Texto
|
annotationManager.textAnnotations.text | string |
Anotação de texto definida pelo usuário |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
A anotação de texto deve ser transparente |
|
Largura
|
annotationManager.textAnnotations.width | integer |
Largura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI da anotação de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI da anotação de texto |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Data em que o Blog foi criado. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
ID do usuário do blog de criação de usuário |
|
ID
|
blogs.id | string |
ID do blog |
|
Texto
|
blogs.text | string |
Texto do item de blog |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
documentData
|
documentData | array of object |
Dados do documento |
|
ID
|
documentData.id | string |
ID de dados do documento |
|
Nome
|
documentData.name | string |
Nome dos dados do documento |
|
Interpretações
|
documentData.renditions | array of |
Interpretações |
|
HasOverlay
|
hasOverlay | boolean |
Define se o documento deve ser exibido com uma sobreposição |
|
ID
|
id | string |
ID do documento |
|
ImportTemplateId
|
importTemplateId | string |
ID do modelo de importação deste documento |
|
InfoStoreId
|
infoStoreId | string |
ID do repositório de informações |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado do ciclo de vida do check-out |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data de término calculada do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data de início do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ID do estado do Ciclo de Vida |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Próximo estado do ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
Próximos estados do ciclo de vida |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir a exclusão do documento após a expiração da proteção |
|
ID
|
lifeCycleManager.lifeCycleProtections.id | string |
ID da proteção do estado do ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Proteger contra alterações de anotação |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Proteger contra check-out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Proteger contra alteração de conteúdo |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Proteger contra exclusão |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Proteger contra alterações de propriedade |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Proteger contra alterações de segurança |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duração da proteção |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ID do Ciclo de Vida |
|
MainFileLength
|
mainFileLength | integer |
Tamanho principal do arquivo |
|
Nome
|
name | string |
Nome do documento |
|
PageCount
|
pageCount | integer |
Contagem de páginas do arquivo principal |
|
propriedades
|
properties | array of object |
Propriedades |
|
globalValues
|
properties.globalValues | array of object |
Valores globais |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura de valor global |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto de valor global |
|
PropertyName
|
properties.propertyName | string |
Nome da propriedade |
|
PropertyTypeId
|
properties.propertyTypeId | string |
ID do tipo do campo de índice |
|
values
|
properties.values | array of string |
Valores de tipo de propriedade |
|
ProtectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção |
|
Lembretes
|
reminders | array of object |
Lembretes |
|
Description
|
reminders.description | string |
Descrição para lembrete |
|
Intervalo
|
reminders.interval | integer |
Intervalo em dias entre lembretes |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
ID do modelo de processo para este lembrete |
|
ReminderDate
|
reminders.reminderDate | string |
Data do lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
ID do lembrete |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Define se a definição do usuário do modelo de processo será usada |
|
SigningProfileId
|
signingProfileId | string |
ID do perfil de assinatura |
|
VersionId
|
versionId | string |
ID da versão do documento |
Atualizar uma linha em uma tabela de usuário
Atualizar uma linha em uma tabela de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
Nome da tabela do usuário
|
UserTable | True | string |
Nome da tabela do usuário |
|
RowData
|
RowData | True | string |
Cadeia de caracteres que contém dados de linha a serem atualizados, separados por ponto-e-vírgula, o primeiro elemento deve ser o InternalRecord_Id da linha a ser atualizada, "100" no exemplo a seguir: 100; John; Corça; 2024-01-01; 2024-12-31 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
userTableUpdateRowResult
|
userTableUpdateRowResult | integer |
userTableUpdateRowResult |
Criar documento (preterido) [PRETERIDO]
Criar documento (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentTitle
|
DocumentTitle | True | string |
Título do documento (incl. extension) |
|
ImportTemplate
|
ImportTemplate | True | string |
Importar modelo |
|
DocumentProperties
|
DocumentProperties | string |
Formato de inserção de propriedades do documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Cultura
|
Culture | string |
A cultura na qual os nomes de propriedade são dados (de, en, fr, ...). Padrão = de |
|
|
FileContent
|
FileContent | True | string |
Cadeia de caracteres base64 do conteúdo do arquivo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
abonnements
|
abonnements | array of string |
abonnements |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Data de criação da anotação de postagem |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
ID de usuário do criador da anotação post it |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação post itálico |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
É fonte atacar fora da anotação de postagem |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is Font is underline from post it annotation |
|
Nome
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nome da fonte da anotação de postagem. Padrão = Arial |
|
Densidade
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de postagem |
|
Tamanho
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de postagem. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de postagem |
|
ID
|
annotationManager.postItAnnotations.id | string |
ID da anotação de postagem |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Data da modificação da anotação de postagem. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Número de páginas da anotação de postagem |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Nível de segurança para postar a anotação (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.postItAnnotations.selectable | boolean |
Define se a anotação de postagem é selecionável pelo usuário |
|
Texto
|
annotationManager.postItAnnotations.text | string |
Texto definido pelo usuário para postá-lo anotação |
|
X
|
annotationManager.postItAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação post it |
|
S
|
annotationManager.postItAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação post it |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Cor
|
annotationManager.rectangleAnnotations.color | integer |
Cor do retângulo (valor ARGB de 32 bits) da anotação do retângulo Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Cor do retângulo (código hexadecimal RGB) da anotação do retângulo. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Data de criação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Altura
|
annotationManager.rectangleAnnotations.height | integer |
Altura do retângulo em pixel por polegada para 7200 DPI |
|
ID
|
annotationManager.rectangleAnnotations.Id | string |
ID da anotação do retângulo |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data da modificação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Número de páginas da anotação do retângulo |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de retângulo (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.rectangleAnnotations.selectable | boolean |
Define se a anotação do retângulo é selecionável pelo usuário |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
O retângulo deve ser transparente (realce) |
|
Largura
|
annotationManager.rectangleAnnotations.width | integer |
Largura do retângulo em pixel por polegada para 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação de retângulo |
|
S
|
annotationManager.rectangleAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação de retângulo |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Cor da tela de fundo (valor ARGB de 32 bits) da anotação de texto Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Cor da tela de fundo (código hexadecimal RGB) da anotação de texto Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
data de criação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
ID do usuário do criador da anotação de texto |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
É a fonte itálica da anotação de texto |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
A fonte é retirada da anotação de texto |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
É sublinhado de fonte da anotação de texto |
|
Nome
|
annotationManager.textAnnotations.fontInfo.name | string |
Nome da fonte da anotação de texto. Padrão = Arial |
|
Densidade
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Pitch de fonte da anotação de texto |
|
Tamanho
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tamanho da fonte da anotação de texto. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Peso da fonte da anotação de texto |
|
Primeiro PlanoColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Cor do primeiro plano (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Cor do primeiro plano (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
annotationManager.textAnnotations.height | integer |
Altura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
ID
|
annotationManager.textAnnotations.id | string |
ID da anotação de texto |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Data da modificação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Número de páginas da anotação de texto |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Rotação em graus da anotação de texto |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Nível de segurança para anotação de texto (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
annotationManager.textAnnotations.selectable | boolean |
Define se a anotação de texto é selecionável pelo usuário |
|
Texto
|
annotationManager.textAnnotations.text | string |
Anotação de texto definida pelo usuário |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
A anotação de texto deve ser transparente |
|
Largura
|
annotationManager.textAnnotations.width | integer |
Largura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
X
|
annotationManager.textAnnotations.x | integer |
Coordenada X em pixel por polegada para 7200 DPI da anotação de texto |
|
S
|
annotationManager.textAnnotations.y | integer |
Coordenada Y em pixel por polegada para 7200 DPI da anotação de texto |
|
blogs
|
blogs | array of object |
blogs |
|
Blogs
|
blogs | object |
Lista de todos os itens de blog |
|
CheckOutState
|
checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
documentData
|
documentData | array of object |
documentData |
|
ID
|
documentData.id | string |
ID da representação de documento |
|
Nome
|
documentData.name | string |
Nome do documento da representação |
|
Interpretações
|
documentData.renditions | array of |
Interpretações |
|
HasOverlay
|
hasOverlay | boolean |
Define se o documento deve ser exibido com uma sobreposição |
|
ID
|
id | string |
ID do documento |
|
ImportTemplateId
|
importTemplateId | string |
ID do modelo de importação deste documento |
|
InfoStoreId
|
infoStoreId | string |
ID do repositório de informações |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Estado do ciclo de vida do check-out |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data de término calculada do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data de início do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ID do estado do Ciclo de Vida |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Próximo estado do ciclo de vida automático |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Permitir a exclusão do documento após a expiração da proteção |
|
ID
|
lifeCycleManager.lifeCycleProtections.id | string |
ID da proteção do estado do ciclo de vida |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Proteger contra alterações de anotação |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Proteger contra check-out |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Proteger contra alteração de conteúdo |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Proteger contra exclusão |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Proteger contra alterações de propriedade |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Proteger contra alterações de segurança |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duração da proteção |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ID do Ciclo de Vida |
|
MainFileLength
|
mainFileLength | integer |
Tamanho principal do arquivo |
|
Nome
|
name | string |
Nome do documento |
|
PageCount
|
pageCount | integer |
Contagem de páginas do arquivo principal |
|
propriedades
|
properties | array of object |
propriedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto |
|
PropertyTypeId
|
properties.propertyTypeId | string |
ID do tipo do campo de índice |
|
values
|
properties.values | array of string |
Valores de PropertyType |
|
ProtectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção |
|
Lembretes
|
reminders | array of object |
Lembretes |
|
Lembretes
|
reminders | object |
Lista de todos os lembretes |
|
SessionCount
|
sessionCount | integer |
Contagem de sessões |
|
SigningProfileId
|
signingProfileId | string |
ID do perfil de assinatura |
|
VersionId
|
versionId | string |
ID da versão do documento |
Criar documento (V2)
Criar documento (V2)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentTitle
|
DocumentTitle | True | string |
Título do documento (incl. extension) |
|
ImportTemplate
|
ImportTemplate | string |
Importar nome ou ID do modelo, se vazios, os valores InfoStore e ProtectionDomain deverão ser fornecidos. |
|
|
DocumentProperties
|
DocumentProperties | string |
Formato de inserção de propriedades do documento: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Blogue
|
Blog | string |
Adicionar uma entrada de texto do Blog no documento |
|
|
Cultura
|
Culture | string |
A cultura na qual os nomes de propriedade são dados (de, en, fr, ...). Padrão = de |
|
|
InfoStore
|
InfoStore | string |
O Nome ou AD do InfoStore deverá ser fornecido se ImportTemplate estiver vazio |
|
|
Ciclo de Vida
|
LifeCycle | string |
Nome ou ID do Ciclo de Vida |
|
|
ProtectionDomain
|
ProtectionDomain | string |
Nome ou ID do ProtectionDomain deve ser fornecido se ImportTemplate estiver vazio |
|
|
UploadMethod
|
UploadMethod | string |
Método usado para carregar o documento no InfoShare. Default = UploadFileBytesLarge |
|
|
OriginalFileFormat
|
OriginalFileFormat | string |
Formato de arquivo original para fins de conversão, por exemplo, 'html'. Convertido em pdf |
|
|
ChunkSize
|
ChunkSize | integer |
Tamanho da parte de upload de arquivo usada com os métodos de upload UploadStreamChunks e UploadFileBytesLarge, padrão |
|
|
FileContent
|
FileContent | True | string |
Cadeia de caracteres base64 do conteúdo do arquivo |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
nome |
|
id
|
id | string |
ID do documento |
|
versionId
|
versionId | string |
ID da versão |
|
currentVersionId
|
currentVersionId | string |
ID da versão atual |
|
protectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção |
|
infoStoreId
|
infoStoreId | string |
InfoStore Id |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId
|
checkOutUserId | string |
ID do usuário com check-out |
|
propriedades
|
properties | array of object |
Propriedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores de PropertyType |
|
globalValues
|
properties.globalValues | array of object |
Valores globais |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura de valor global |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto de valor global |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nome de PropertyType |
|
propertyName
|
properties.propertyName | string |
Nome da propriedade |
|
importTemplateId
|
importTemplateId | string |
Importar id de modelo |
|
blogs
|
blogs | array of object |
blogs |
|
createdDate
|
blogs.createdDate | string |
Data de criação do blog |
|
creatorId
|
blogs.creatorId | string |
ID do criador do blog |
|
enviar SMS
|
blogs.text | string |
Texto do blog |
|
id
|
blogs.id | string |
ID do Blog |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
Lembretes
|
reminders | array of |
Lembretes |
|
pageCount
|
pageCount | integer |
Contagem de páginas |
|
mainFileLength
|
mainFileLength | integer |
Comprimento do arquivo principal |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Texto de anotações |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of |
Retângulo de anotações |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Anotações postam |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Carimbo de anotações |
|
documentData
|
documentData | array of object |
Dados do documento |
|
id
|
documentData.id | string |
ID de dados do documento |
|
nome
|
documentData.name | string |
Nome dos dados do documento |
|
Interpretações
|
documentData.renditions | array of object |
Interpretações |
|
id
|
documentData.renditions.id | string |
ID da representação |
|
size
|
documentData.renditions.size | string |
Tamanho da representação |
|
arquivos
|
documentData.renditions.files | array of object |
arquivos |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
ID do repositório de blobs |
|
blobCaminho
|
documentData.renditions.files.blobPath | string |
Caminho do blob |
|
pageCount
|
documentData.renditions.pageCount | string |
Contagem de páginas de representação |
|
extensão
|
documentData.renditions.extension | string |
Extensão de representação |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Valor de hash de representação |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Proteções de conteúdo de representação |
|
signingProfileId
|
signingProfileId | string |
ID do perfil de assinatura |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ID do ciclo de vida |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ID do estado do ciclo de vida |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data de início do ciclo de vida |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data de término do ciclo de vida |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Próximos estados do ciclo de vida |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Confira a ID do estado do ciclo de vida |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Próxima ID do estado do ciclo de vida automático |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Proteções do ciclo de vida |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
ID de proteção do ciclo de vida |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Tiques de duração da proteção do ciclo de vida |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Check-out de proteção do ciclo de vida |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Ciclo de vida proteger alteração de conteúdo |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Alteração da propriedade de proteção do ciclo de vida |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
O ciclo de vida protege a alteração da anotação |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Ciclo de vida para proteger a alteração do domínio de proteção |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Exclusão de proteção do ciclo de vida |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Exclusão do ciclo de vida após a expiração |
|
hasOverlay
|
hasOverlay | boolean |
Tem sobreposição |
|
sessionCount
|
sessionCount | integer |
Contagem de sessões |
|
hasSignature
|
hasSignature | boolean |
Tem assinatura |
|
hasBlog
|
hasBlog | boolean |
Tem blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Tem anotação |
|
hasTempAccess
|
hasTempAccess | boolean |
Tem acesso temporário |
|
hasReminders
|
hasReminders | boolean |
Tem lembretes |
|
hasLinks
|
hasLinks | boolean |
Tem links |
|
hasAbonnement
|
hasAbonnement | boolean |
Tem abonnement |
Criar uma tabela de usuário
Criar uma tabela de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
UserTable
|
UserTable | True | string |
Nome da tabela de usuário (por exemplo: Endereço) |
|
ColumnHeaders
|
ColumnHeaders | True | string |
Uma lista de cabeçalhos de coluna (por exemplo: Firstname, Lastname, City) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela do Usuário
|
userTable | string |
Nome da tabela de usuário |
Excluir linhas de tabela do usuário
Excluir linhas de tabela do usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
UserTable
|
UserTable | True | string |
Nome da tabela de usuário |
|
WhereClause
|
WhereClause | string |
Uma lista de SQL em que os elementos da cláusula. Formato: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (por exemplo: [Firstname|Igual a|Jon|AND],[Lastname|Igual a|Doe|OR]) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |
Fechar a tarefa atual e atribuir o usuário à próxima tarefa
Fechar a tarefa atual e atribuir o usuário à próxima tarefa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
ProcessId | True | string |
ID do processo (Guid) |
|
TaskId
|
TaskId | string |
ID da tarefa (Guid) |
|
|
Comment
|
Comment | string |
Comment |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ação
|
action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data do comentário |
|
ID
|
comments.id | string |
Id de comentário |
|
Texto
|
comments.text | string |
Comentário definido pelo usuário |
|
UserId
|
comments.userId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
completedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
createdDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
ID do usuário do criador |
|
Description
|
description | string |
Descrição da tarefa |
|
Data de Conclusão
|
dueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
reminderDate | string |
Data para lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
Situação
|
statusEnum | string |
Status do status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
ID do modelo de tarefa |
Fechar tarefa e continuar o processo
Fechar tarefa e continuar o processo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
processId | True | string |
ID do processo (Guid) |
|
Comment
|
comment | string |
Comentário a ser adicionado |
|
|
TaskId
|
taskId | string |
ID da tarefa |
|
|
AssignUsers
|
assignUsers | True | boolean |
Atribuir aos usuários. Se definido como não, atribua o usuário com o processo de atualização de ação |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ação
|
action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
AssignedUserIds
|
assignedUserIds | string |
Lista de IDs de usuário atribuídas |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data do comentário |
|
ID
|
comments.id | string |
Id de comentário |
|
Texto
|
comments.text | string |
Comentário definido pelo usuário |
|
UserId
|
comments.userId | string |
Identificação de usuário |
|
CompletedDate
|
completedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
completedUserIds | string |
Lista de todas as IDs de usuário concluídas |
|
CreatedDate
|
createdDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
ID do usuário do criador |
|
Description
|
description | string |
Descrição da tarefa |
|
Data de Conclusão
|
dueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
intendedUserIds | string |
Usuários pretendidos para esta tarefa |
|
ReminderDate
|
reminderDate | string |
Data para lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
Situação
|
statusEnum | string |
Status do status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
taskTemplateId | string |
ID do modelo de tarefa |
Fechar um processo aberto
Fechar um processo aberto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
processId | True | string |
ID do processo (Guid) |
|
Comment
|
comment | string |
Comentário a ser adicionado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
ID do usuário para o qual o processo está em check-out |
|
Comments
|
CloseProcessResult.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.Comments.Date | string |
Data do comentário |
|
ID
|
CloseProcessResult.Comments.Id | string |
Id de comentário |
|
Texto
|
CloseProcessResult.Comments.Text | string |
Comentário definido pelo usuário |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
ID do usuário |
|
CompletedDate
|
CloseProcessResult.CompletedDate | string |
Data concluída do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedTasks
|
CloseProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Ação
|
CloseProcessResult.CompletedTasks.Action | string |
Texto de ação para o usuário |
|
AssignedUserIds
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
Data do comentário |
|
ID
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
Id de comentário |
|
Texto
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
Comentário definido pelo usuário |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
Data de conclusão da tarefa concluída. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
Data de criação da tarefa concluída. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
ID do usuário do criador da tarefa concluída |
|
Description
|
CloseProcessResult.CompletedTasks.Description | string |
Descrição da tarefa concluída |
|
Data de Conclusão
|
CloseProcessResult.CompletedTasks.DueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.CompletedTasks.Id | string |
ID da tarefa |
|
IntendedUserIds
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
Data para lembrete da tarefa concluída. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
Status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
ID do modelo de tarefa |
|
CreatedDate
|
CloseProcessResult.CreatedDate | string |
Data de criação do formato de data do processo: yyyy-MM-ddTHH:mm:ss |
|
Ação
|
CloseProcessResult.CurrentTask.Action | string |
Texto de ação para o usuário |
|
AssignedUserIds
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CurrentTask.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CurrentTask.Comments.Date | string |
Data do comentário |
|
ID
|
CloseProcessResult.CurrentTask.Comments.Id | string |
Id de comentário |
|
Texto
|
CloseProcessResult.CurrentTask.Comments.Text | string |
Comentário definido pelo usuário |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
CloseProcessResult.CurrentTask.CompletedDate | string |
Data de conclusão da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CurrentTask.CreatedDate | string |
Data de criação da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
ID do usuário do criador da tarefa atual |
|
Description
|
CloseProcessResult.CurrentTask.Description | string |
Descrição da tarefa atual |
|
Data de Conclusão
|
CloseProcessResult.CurrentTask.DueDate | string |
Data de conclusão da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.CurrentTask.Id | string |
ID da tarefa atual |
|
IntendedUserIds
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CurrentTask.ReminderDate | string |
Data para lembrete da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar a tarefa atual |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa na tarefa atual |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
Status da tarefa atual (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
ID do modelo de tarefa da tarefa atual |
|
CustomProperties
|
CloseProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Valor enumerado de tipo de propriedade personalizado da propriedade personalizada (String, Date, Number) |
|
Nome
|
CloseProcessResult.CustomProperties.Name | string |
Nome da propriedade personalizada |
|
Value
|
CloseProcessResult.CustomProperties.Value | string |
Valor da propriedade personalizada |
|
DocumentIds
|
CloseProcessResult.DocumentIds | array of string |
DocumentIds |
|
Data de Conclusão
|
CloseProcessResult.DueDate | string |
Data de conclusão do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ID
|
CloseProcessResult.Id | string |
ID do processo |
|
Valores
|
CloseProcessResult.Name.Values | array of object |
Valores |
|
Cultura
|
CloseProcessResult.Name.Values.Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...) |
|
Texto
|
CloseProcessResult.Name.Values.Text | string |
Nome do processo |
|
PluginStream
|
CloseProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
Prioridade do processo (Alta, Normal, Baixa) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
ID do modelo de processo |
|
Propriedades
|
CloseProcessResult.Properties | array of object |
Propriedades |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Texto
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
Texto |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
ID do tipo do campo de índice |
|
Valores
|
CloseProcessResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
ID de domínio de proteção do processo |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
Contagem de sessões |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
Status do processo (Open, InProcess, Complete, PreparedToComplete, Error) |
Inserir linhas em uma tabela de usuário
Importar linhas de tabela para uma tabela de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
UserTable
|
UserTable | True | string |
Nome da tabela de usuário |
|
Valores
|
Values | True | string |
Lista de valores de linha e coluna a serem inseridos (por exemplo: [João; Corça; Nova Iorque],[Pedro; Reunir; Bern]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
Define se todos os valores devem ser excluídos em UserTable (padrão = false) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Define se a primeira linha do parâmetro de valores contém cabeçalhos de coluna (padrão = false) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela do Usuário
|
userTable | string |
Nome da tabela de usuário |
|
Linhas Inseridas
|
insertedRows | integer |
Número de linhas inseridas |
Logoff
Logoff
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
LogoffResult
|
LogoffResult | string |
Resultado do logoff |
Logon
Logon
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
Nome de usuário
|
Username | True | string |
Nome de usuário para logon |
|
Senha
|
Password | True | string |
Senha |
|
Nome do inquilino
|
Tenantname | string |
Nome do locatário no qual fazer logon |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
Contém a ID de conexão se conectado com êxito |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
Tempo limite para conexão |
|
IsApplicationLicence
|
isApplicationLicence | string |
É o tipo de licença do aplicativo |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
É um tipo de licença simultâneo |
|
IsNamedLicence
|
isNamedLicence | string |
Erro de licença nomeado |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
O código de verificação é necessário |
|
PossibleTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
Possível tipo de autenticação bidirecional (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
O endereço de email mascarado em que twoWayAuthentication enviará emails para |
Logon com senha hash
Logon com senha hash
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
Nome de usuário
|
userName | True | string |
Nome de usuário para logon |
|
Senha com hash
|
passwordHashed | True | string |
Senha do usuário para logon (Hash SHA 512 codificado em Base64) |
|
Nome do inquilino
|
tenantName | string |
Nome do locatário no qual fazer logon |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
A ID de conexão para identificar sua conexão |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
Tempo limite da conexão em segundos |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
É o tipo de licença do aplicativo |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
É um tipo de licença simultâneo |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
É o tipo de licença nomeado |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
O código de verificação é necessário |
|
JWTToken
|
LogonResult.JWTToken | string |
O token JWT para essa conexão |
|
PossibleTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
Possível tipo de autenticação bidirecional (None, Mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
O endereço de email mascarado em que twoWayAuthentication enviará emails para |
Mesclar documentos PDF
Mesclar dois ou mais documentos PDF em um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
DocumentId | True | string |
ID do primeiro documento PDF, uma nova versão será criada com novo conteúdo mesclado |
|
DocumentIdToAppend
|
DocumentIdToAppend | True | string |
IDs de documento que serão acrescentadas (mescladas) no primeiro ponto-e-vírgula separado, ou seja, '77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df811a928' |
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Desfazer um check-out no primeiro documento PDF, conforme necessário. Padrão = false |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do documento |
|
id
|
id | string |
ID do documento |
|
versionId
|
versionId | string |
ID da versão do documento |
|
currentVersionId
|
currentVersionId | string |
Documente a ID da versão atual |
|
protectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção de documento |
|
infoStoreId
|
infoStoreId | string |
InfoStore Id |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Enumeração de estado de check-out |
|
checkOutUserId
|
checkOutUserId | string |
Confira a ID do usuário |
|
propriedades
|
properties | array of object |
Propriedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores de PropertyType |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura de valores globais |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto de valores globais |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nome de PropertyType |
|
propertyName
|
properties.propertyName | string |
Nome da propriedade |
|
importTemplateId
|
importTemplateId | string |
Importar id de modelo |
|
blogs
|
blogs | array of object |
Blogs |
|
createdDate
|
blogs.createdDate | string |
Data de criação do blog |
|
creatorId
|
blogs.creatorId | string |
ID do criador do blog |
|
enviar SMS
|
blogs.text | string |
Texto do blog |
|
id
|
blogs.id | string |
Blog Id |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumerações de direitos de acesso |
|
Lembretes
|
reminders | array of |
Lembretes |
|
pageCount
|
pageCount | integer |
Contagem de páginas |
|
mainFileLength
|
mainFileLength | integer |
Comprimento do arquivo principal |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Anotações de texto |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of |
Anotações de retângulo |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Anotações do PostIt |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Anotações de carimbo |
|
documentData
|
documentData | array of object |
Dados do documento |
|
id
|
documentData.id | string |
ID de dados do documento |
|
nome
|
documentData.name | string |
Nome dos dados do documento |
|
Interpretações
|
documentData.renditions | array of object |
Interpretações |
|
id
|
documentData.renditions.id | string |
ID da representação |
|
size
|
documentData.renditions.size | string |
Tamanho da representação |
|
arquivos
|
documentData.renditions.files | array of object |
Arquivos de representação |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
ID do repositório de blob de representação |
|
blobCaminho
|
documentData.renditions.files.blobPath | string |
Caminho do blob de representação |
|
pageCount
|
documentData.renditions.pageCount | string |
Contagem de páginas de representação |
|
extensão
|
documentData.renditions.extension | string |
Extensão de representação |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Valor de hash de representação |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Proteções de conteúdo de representação |
|
signingProfileId
|
signingProfileId | string |
ID do perfil de assinatura |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
ID do ciclo de vida |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
ID do estado do ciclo de vida |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data de início do ciclo de vida |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data de término do ciclo de vida |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Próximos estados do ciclo de vida |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Confira a ID do estado do ciclo de vida |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Próxima ID do estado do ciclo de vida automático |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Proteções do ciclo de vida |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
ID de proteção do ciclo de vida |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Tiques de duração da proteção do ciclo de vida |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Check-out da proteção do ciclo de vida |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Alteração do conteúdo da proteção do ciclo de vida |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Alteração da propriedade de proteção do ciclo de vida |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Alteração da anotação de proteção do ciclo de vida |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Alteração do domínio de proteção da proteção do ciclo de vida |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Exclusão da proteção do ciclo de vida |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Exclusão da proteção do ciclo de vida após a expiração |
|
hasOverlay
|
hasOverlay | boolean |
Tem sobreposição |
|
sessionCount
|
sessionCount | integer |
Contagem de sessões |
|
hasSignature
|
hasSignature | boolean |
Tem assinatura |
|
hasBlog
|
hasBlog | boolean |
Tem blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Tem anotação |
|
hasTempAccess
|
hasTempAccess | boolean |
Tem acesso temporário |
|
hasReminders
|
hasReminders | boolean |
Tem lembretes |
|
hasLinks
|
hasLinks | boolean |
Tem links |
|
hasAbonnement
|
hasAbonnement | boolean |
Tem abonnement |
Obter a seleção de documentos e processos
Obter documentos e processos selecionados no Cliente Web Móvel por meio de ação de botão personalizado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
SelectionId
|
SelectionId | True | string |
A ID de Seleção de documentos e processos selecionados no Cliente Web Móvel por meio de ação de botão personalizado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID de seleção |
|
id
|
parentObjectId.id | string |
Listar A ID do objeto pai no Cliente Web Móvel |
|
objectId
|
parentObjectId.objectId | string |
ID do objeto pai (Documento, Processo,...) |
|
objectTypeEnum
|
parentObjectId.objectTypeEnum | string |
ObjectTypeEnum do objeto pai - por exemplo, Documento, Processo, ... |
|
objectIds
|
objectIds | array of object |
Documentos e processos selecionados no Cliente Web Móvel |
|
id
|
objectIds.id | string |
ID de lista do cliente Web móvel |
|
objectId
|
objectIds.objectId | string |
ID de objeto do documento ou processo selecionado no Cliente Web Móvel |
|
objectTypeEnum
|
objectIds.objectTypeEnum | string |
ObjectTypeEnum do documento ou processo selecionado no Cliente Web Móvel |
|
allObjectIds
|
allObjectIds | array of object |
Documentos e processos selecionados e não selecionados no Cliente Web Móvel |
|
id
|
allObjectIds.id | string |
ID de lista do cliente Web móvel |
|
objectId
|
allObjectIds.objectId | string |
ID de objeto do documento ou processo selecionado e não selecionado no Cliente Web Móvel |
|
objectTypeEnum
|
allObjectIds.objectTypeEnum | string |
ObjectTypeEnum do documento ou processo selecionado e não selecionado no Cliente Web Móvel |
Obter conteúdo do arquivo
Obter conteúdo do arquivo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
DocumentId | True | string |
ID do documento |
|
VersionId
|
VersionId | string |
ID da versão (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
ID dos dados do documento (Guid) |
|
|
RenditionId
|
RenditionId | string |
ID da representação de documento (Guid) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
Ignorar a configuração do sistema para validação de hash. Padrão = sim |
Retornos
Conteúdo do arquivo
- Conteúdo do arquivo
- string
Obter documento
Obter documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
documentId | True | string |
A ID do documento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Abonnements
|
GetDocumentResult.Abonnements | array of object |
Abonnements |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
Abonnement está ativo em alterações de arquivo |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
Abonnement está ativo na exclusão |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
Abonnement está ativo em alterações de índice |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
A ID do usuário para este abonnnement |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
PostItAnnotations
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
PostItAnnotations |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
Data de criação da anotação de postagem |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
ID de usuário do criador da anotação post it |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
É a fonte itálica da anotação post itálico |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
É fonte atacar fora da anotação de postagem |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
Is Font is underline from post it annotation |
|
Nome
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
Nome da fonte da anotação de postagem. Padrão = Arial |
|
Densidade
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
Pitch de fonte da anotação de postagem |
|
Tamanho
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
Tamanho da fonte da anotação de postagem. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
Peso da fonte da anotação de postagem |
|
ID
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
ID da anotação de postagem |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
Data da modificação da anotação de postagem. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
Número de páginas da anotação de postagem |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
Nível de segurança para postar a anotação (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
Define se a anotação de postagem é selecionável pelo usuário |
|
Texto
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
Texto definido pelo usuário para postá-lo anotação |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação post it |
|
S
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação post it |
|
RectangleAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
RectangleAnnotations |
|
Cor
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
Cor do retângulo (valor ARGB de 32 bits) da anotação do retângulo. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
Cor do retângulo (código hexadecimal RGB) da anotação do retângulo. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
Data de criação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
Altura
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
Altura do retângulo em pixel por polegada para 7200 DPI |
|
ID
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
ID da anotação do retângulo |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
Data da modificação da anotação do retângulo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
Número de páginas da anotação do retângulo |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
Nível de segurança para anotação de retângulo (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
Define se a anotação do retângulo é selecionável pelo usuário |
|
Transparent
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
O retângulo deve ser transparente (realce) |
|
Largura
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
Largura do retângulo em pixel por polegada para 7200 DPI |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
Coordenada X em pixel por polegada para 7200 DPI de anotação de retângulo |
|
S
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
Coordenada Y em pixel por polegada para 7200 DPI de anotação de retângulo |
|
TextAnnotations
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
TextAnnotations |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
Cor da tela de fundo (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
Cor da tela de fundo (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
data de criação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
ID do usuário do criador da anotação de texto |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
É a fonte itálica da anotação de texto |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
A fonte é retirada da anotação de texto |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
É sublinhado de fonte da anotação de texto |
|
Nome
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
Nome da fonte da anotação de texto. Padrão = Arial |
|
Densidade
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
Pitch de fonte da anotação de texto |
|
Tamanho
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
Tamanho da fonte da anotação de texto.. Exemplo: Tamanho:12 é 12000. Você precisa do fator 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
Peso da fonte da anotação de texto |
|
Primeiro PlanoColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
Cor do primeiro plano (valor ARGB de 32 bits) da anotação de texto. Exemplo: Preto: -16777216 Branco: -1 Vermelho: -65536 Verde: -16744448 Azul: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
Cor do primeiro plano (código hexadecimal RGB) da anotação de texto. Exemplo: Preto: #000000 Branco: #FFFFFF Vermelho: #FF0000 Verde: #008000 Azul: #0000FF |
|
Altura
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
Altura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
ID
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
ID da anotação de texto |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
Data da modificação da anotação de texto. Formato de data: yyy-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
Número de páginas da anotação de texto |
|
Rotation
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
Rotação em graus da anotação de texto |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
Nível de segurança para anotação de texto (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Padrão = Publicamente Disponível |
|
Selecionável
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
Define se a anotação de texto é selecionável pelo usuário |
|
Texto
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
Anotação de texto definida pelo usuário |
|
Transparent
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
A anotação de texto deve ser transparente |
|
Largura
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
Largura do texto em pixel por polegada para 7200 DPI da anotação de texto |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
Coordenada X em pixel por polegada para 7200 DPI da anotação de texto |
|
S
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
Coordenada Y em pixel por polegada para 7200 DPI da anotação de texto |
|
Blogs
|
GetDocumentResult.Blogs | array of object |
Blogs |
|
CreatedDate
|
GetDocumentResult.Blogs.CreatedDate | string |
Data em que o Blog foi criado. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
ID do usuário do blog de criação de usuário |
|
ID
|
GetDocumentResult.Blogs.Id | string |
ID do blog |
|
Texto
|
GetDocumentResult.Blogs.Text | string |
Texto do item de blog |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
ID
|
GetDocumentResult.DocumentData.Id | string |
ID da representação de documento |
|
Nome
|
GetDocumentResult.DocumentData.Name | string |
Nome do documento da representação |
|
Interpretações
|
GetDocumentResult.DocumentData.Renditions | array of object |
Interpretações |
|
ContentProtections
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections |
|
Extension
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
Extension |
|
Arquivos
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
Arquivos |
|
BlobPath
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
BlobPath |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
ID
|
GetDocumentResult.DocumentData.Renditions.Id | string |
ID |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
Tamanho
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
Tamanho |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
Define se o documento deve ser exibido com uma sobreposição |
|
ID
|
GetDocumentResult.Id | string |
ID do documento |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
ID do modelo de importação deste documento |
|
InfoStoreId
|
GetDocumentResult.InfoStoreId | string |
ID do repositório de informações |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
Estado do ciclo de vida do check-out |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
Data de término calculada do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
Data de início do ciclo de vida. Formato de data: yyy-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
ID do estado do Ciclo de Vida |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
Próximo estado do ciclo de vida automático |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
Permitir a exclusão do documento após a expiração da proteção |
|
ID
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
ID da proteção do estado do ciclo de vida |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
Proteger contra alterações de anotação |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
Proteger contra check-out |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
Proteger contra alteração de conteúdo |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
Proteger contra exclusão |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
Proteger contra alterações de propriedade |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
Proteger contra alterações de segurança |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
Duração da proteção |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
ID do Ciclo de Vida |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
Tamanho principal do arquivo |
|
Nome
|
GetDocumentResult.Name | string |
Nome do documento |
|
PageCount
|
GetDocumentResult.PageCount | integer |
Contagem de páginas do arquivo principal |
|
Propriedades
|
GetDocumentResult.Properties | array of object |
Propriedades |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Texto
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
Texto |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
ID do tipo do campo de índice |
|
Valores
|
GetDocumentResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
ID do domínio de proteção |
|
Lembretes
|
GetDocumentResult.Reminders | array of object |
Lembretes |
|
Description
|
GetDocumentResult.Reminders.Description | string |
Descrição para lembrete |
|
Intervalo
|
GetDocumentResult.Reminders.Interval | integer |
Intervalo em dias entre lembretes |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
ID do modelo de processo para este lembrete |
|
ReminderDate
|
GetDocumentResult.Reminders.ReminderDate | string |
Data do lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
ID do lembrete |
|
SubjectIds
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
Define se a definição do usuário do modelo de processo será usada |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
Contagem de sessões |
|
SigningProfileId
|
GetDocumentResult.SigningProfileId | string |
ID do perfil de assinatura |
|
VersionId
|
GetDocumentResult.VersionId | string |
ID da versão do documento |
Obter linhas de uma tabela de usuário
Obter linhas de uma tabela de usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
UserTable
|
UserTable | True | string |
Nome da tabela de usuário |
|
WhereClause
|
WhereClause | string |
Uma lista de SQL em que os elementos da cláusula. Formato: [<ColumnName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (por exemplo: [Firstname|Igual a|Jon|AND],[Lastname|Igual a|Doe|AND]) |
|
|
OrderByClause
|
OrderByClause | string |
Uma lista de elementos de ordem SQL por cláusula (por exemplo: Firstname[ASC],City[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
Adiciona cabeçalhos de coluna como primeira linha (padrão = false) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
items
|
UserTableGetRecordsResult | array of string |
Obter o conteúdo do arquivo convertido
Converter o conteúdo do arquivo em um formato diferente. Adicionar anotação ou sobreposição ao conteúdo do arquivo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
DocumentId | True | string |
ID do documento |
|
VersionId
|
VersionId | string |
ID da versão (Guid)Id da versão (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
ID dos dados do documento (Guid) |
|
|
RenditionId
|
RenditionId | string |
ID da representação de documento (Guid) |
|
|
TargetFormat
|
TargetFormat | True | string |
O formato de destino (por exemplo, "png;pdf; tif;...") |
|
AddAnnotations
|
AddAnnotatins | boolean |
Define se o documento deve ser exportado com anotações. Padrão = sim |
|
|
AddOverlay
|
AddOverlay | boolean |
Define se o documento deve ser exportado com sobreposições. Padrão = sim |
Retornos
Conteúdo do arquivo convertido
- Conteúdo do arquivo
- string
Obter processo
Obter processo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
processId | True | string |
ID do processo (Guid) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
ID do usuário para o qual o processo está em check-out |
|
Comments
|
GetProcessResult.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.Comments.Date | string |
Data do comentário |
|
ID
|
GetProcessResult.Comments.Id | string |
Id de comentário |
|
Texto
|
GetProcessResult.Comments.Text | string |
Comentário definido pelo usuário |
|
UserId
|
GetProcessResult.Comments.UserId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
GetProcessResult.CompletedDate | string |
Data concluída do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedTasks
|
GetProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Ação
|
GetProcessResult.CompletedTasks.Action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
AssignedUserIds
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
Comments
|
GetProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.CompletedTasks.Comments.Date | string |
Data do comentário |
|
ID
|
GetProcessResult.CompletedTasks.Comments.Id | string |
Id de comentário |
|
Texto
|
GetProcessResult.CompletedTasks.Comments.Text | string |
Comentário definido pelo usuário |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
GetProcessResult.CompletedTasks.CompletedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
GetProcessResult.CompletedTasks.CreatedDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
ID do usuário do criador |
|
Description
|
GetProcessResult.CompletedTasks.Description | string |
Descrição da tarefa |
|
Data de Conclusão
|
GetProcessResult.CompletedTasks.DueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
GetProcessResult.CompletedTasks.ReminderDate | string |
Data para lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
Situação
|
GetProcessResult.CompletedTasks.StatusEnum | string |
Status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
ID do modelo de tarefa |
|
CreatedDate
|
GetProcessResult.CreatedDate | string |
Data de criação do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
Ação
|
GetProcessResult.CurrentTask.Action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
AssignedUserIds
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
GetProcessResult.CurrentTask.Comments | array of string |
Comments |
|
CompletedDate
|
GetProcessResult.CurrentTask.CompletedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
GetProcessResult.CurrentTask.CreatedDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
ID do usuário do criador |
|
Description
|
GetProcessResult.CurrentTask.Description | string |
Descrição da tarefa |
|
Data de Conclusão
|
GetProcessResult.CurrentTask.DueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ID
|
GetProcessResult.CurrentTask.Id | string |
ID da tarefa |
|
IntendedUserIds
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
GetProcessResult.CurrentTask.ReminderDate | string |
Data para lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
Status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
ID do modelo de tarefa |
|
CustomProperties
|
GetProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Lista de tipo de dados de propriedade personalizada (Cadeia de caracteres, data, número) |
|
Nome
|
GetProcessResult.CustomProperties.Name | string |
Nome do tipo de propriedade personalizada |
|
Value
|
GetProcessResult.CustomProperties.Value | string |
Valor do tipo de propriedade personalizada |
|
DocumentIds
|
GetProcessResult.DocumentIds | array of string |
DocumentIds |
|
Data de Conclusão
|
GetProcessResult.DueDate | string |
Data de conclusão do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
ID
|
GetProcessResult.Id | string |
ID do processo |
|
Valores
|
GetProcessResult.Name.Values | array of object |
Valores |
|
Cultura
|
GetProcessResult.Name.Values.Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...) |
|
Texto
|
GetProcessResult.Name.Values.Text | string |
Texto |
|
PluginStream
|
GetProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
Prioridade do processo (Alta, Normal, Baixa) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
ID do modelo de processo |
|
Propriedades
|
GetProcessResult.Properties | array of object |
Propriedades |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Valores
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
Valores |
|
Cultura
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultura |
|
Texto
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
Texto |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
ID do tipo de propriedade |
|
Valores
|
GetProcessResult.Properties.Values | array of string |
Valores |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
ID de domínio de proteção do processo |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
Contagem de sessões |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
Status do processo (Open, InProcess, Complete, PreparedToComplete, Error) |
Obter propriedades do documento
Obter propriedades do documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
DocumentId
|
DocumentId | True | string |
ID do documento |
|
Cultura
|
Culture | string |
A cultura na qual os nomes de propriedade são dados (de, en, fr, ...). Padrão = de |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
values
|
globalValues.values | array of object |
values |
|
cultura
|
globalValues.values.culture | string |
Cultura |
|
enviar SMS
|
globalValues.values.text | string |
Texto |
|
PropertyName
|
propertyName | string |
Nome da propriedade |
|
PropertyTypeId
|
propertyTypeId | string |
ID do tipo do campo de índice |
|
values
|
values | array of string |
values |
Obter propriedades do processo
Obter propriedades do processo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
ProcessId | True | string |
ID do processo (Guid) |
|
Cultura
|
Culture | string |
A cultura na qual os nomes de propriedade são dados (de, en, fr, ...). Padrão = de |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
PropertyName
|
propertyName | string |
Nome da propriedade process |
|
PropertyTypeId
|
propertyTypeId | string |
ID do tipo de propriedade |
|
values
|
values | array of string |
values |
Pesquisa de documentos (preterida) [PRETERIDA]
Pesquisa de documentos (preterida)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
Condições
|
Conditions | string |
Formato de condição de pesquisa: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". por exemplo: [Última verificação|Menos|2021-12-31|E],[Nome|Igual a|Pedro|E] |
|
|
Cultura
|
Culture | string |
Cultura (de,en,fr,...). Padrão = de |
|
|
FulltextWords
|
FulltextWords | string |
Palavras a serem pesquisadas com texto completo |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
Relação de palavra de texto completo (AND, OR). Padrão = E |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados da pesquisa de documentos. Padrão = 100 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of object |
Documentos |
|
Abonnements
|
documents.abonnements | string |
Lista de abonnements |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
Anotações para o arquivo de documento principal |
|
Blogs
|
documents.blogs | string |
Lista de todos os itens de blog |
|
CheckOutState
|
documents.checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
DocumentData
|
documents.documentData | string |
Lista de dados do documento |
|
HasOverlay
|
documents.hasOverlay | boolean |
Define se o documento deve ser exibido com uma sobreposição |
|
ID
|
documents.id | string |
ID do documento |
|
ImportTemplateId
|
documents.importTemplateId | string |
ID do modelo de importação deste documento |
|
InfoStoreId
|
documents.infoStoreId | string |
ID do repositório de informações |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
Informações do ciclo de vida |
|
MainFileLength
|
documents.mainFileLength | integer |
Tamanho principal do arquivo |
|
Nome
|
documents.name | string |
Nome do documento |
|
PageCount
|
documents.pageCount | integer |
Contagem de páginas do arquivo principal |
|
propriedades
|
documents.properties | array of |
propriedades |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
ID do domínio de proteção |
|
Lembretes
|
documents.reminders | string |
Lista de todos os lembretes |
|
SessionCount
|
documents.sessionCount | integer |
Contagem de sessões |
|
SigningProfileId
|
documents.signingProfileId | string |
ID do perfil de assinatura |
|
VersionId
|
documents.versionId | string |
ID da versão do documento |
|
HasMore
|
hasMore | boolean |
Indica se há mais resultados ou não. O sinalizador será definido como true se mais resultados estiverem disponíveis |
|
ResumePoint
|
resumePoint | string |
O ponto de retomada da operação de pesquisa anterior. Definir nulo para a primeira operação de pesquisa |
Pesquisa de documentos (V2)
Pesquisa de documentos (V2)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
Condições
|
Conditions | string |
Formato de condição de pesquisa: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". por exemplo: [Última verificação|Menos|2021-12-31|E],[Nome|Igual a|Pedro|E],[Data|Entre|2021-12-31; 2022-12-31|E] |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados da pesquisa de documentos. Padrão = 100 |
|
|
ResultProperties
|
ResultProperties | string |
Lista de propriedades de resultado, separada por vírgula. Pode ser a propriedade Name ou Id, como "Name, Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
|
|
Repositórios
|
Stores | string |
Lista separada por vírgulas de InfoStores para pesquisar. Pode ser nome ou ID da loja, como "Standard,9cd306e3-7e96-486c-8280-65d9f0239776" |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of object |
Resultado da pesquisa de documentos |
|
nome
|
documents.name | string |
Nome do documento |
|
id
|
documents.id | string |
ID do documento |
|
folderElementId
|
documents.folderElementId | string |
ID do elemento Folder |
|
checkOutStateEnum
|
documents.checkOutStateEnum | string |
Enumeração de estado de check-out |
|
hasSignature
|
documents.hasSignature | boolean |
Tem assinatura |
|
hasBlog
|
documents.hasBlog | boolean |
Tem blog |
|
hasAnnotation
|
documents.hasAnnotation | boolean |
Tem anotação |
|
hasLinks
|
documents.hasLinks | boolean |
Tem links |
|
propriedades
|
documents.properties | array of object |
Propriedades |
|
propertyTypeId
|
documents.properties.propertyTypeId | string |
PropertyType Id |
|
values
|
documents.properties.values | array of string |
Valores de tipo de propriedade |
|
globalValues
|
documents.properties.globalValues | array of object |
Valores globais |
|
values
|
documents.properties.globalValues.values | array of object |
values |
|
cultura
|
documents.properties.globalValues.values.culture | string |
Cultura de valores globais |
|
enviar SMS
|
documents.properties.globalValues.values.text | string |
Texto de valores globais |
|
propertyTypeName
|
documents.properties.propertyTypeName | string |
Nome de PropertyType |
|
propertyName
|
documents.properties.propertyName | string |
Nome da propriedade |
|
hasTempAccess
|
documents.hasTempAccess | boolean |
Tem acesso temporário |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
Lista de enumerações de direitos de acesso |
|
mainFileLength
|
documents.mainFileLength | integer |
Comprimento do arquivo principal |
|
versionId
|
documents.versionId | string |
ID da versão |
|
hasReminders
|
documents.hasReminders | boolean |
Tem lembretes |
|
hasAbonnement
|
documents.hasAbonnement | boolean |
Tem abonnement |
|
hasOverlay
|
documents.hasOverlay | boolean |
Sobreposição do Oas |
|
hasMore
|
hasMore | boolean |
Tem mais |
|
resumePoint
|
resumePoint | string |
Retomar ponto |
Pesquisa de processo
Pesquisa de processo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
Condições
|
Conditions | string |
Formato de condição de pesquisa: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". por exemplo: [Última verificação|Menos|2021-12-31|E],[Nome|Igual a|Pedro|E],[Data|Entre|2021-12-31; 2022-12-31|E] |
|
|
ResultProperties
|
ResultProperties | string |
Lista de propriedades de resultado, separada por vírgula. Pode ser a propriedade Name ou Id, como "Name, Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados da pesquisa de documentos. Padrão = 100 |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
Resultado da pesquisa de processo |
|
values
|
processes.name.values | array of object |
Valores de propriedade |
|
cultura
|
processes.name.values.culture | string |
Cultura da propriedade |
|
enviar SMS
|
processes.name.values.text | string |
Texto da propriedade |
|
id
|
processes.id | string |
ID do processo |
|
folderElementId
|
processes.folderElementId | string |
ID do elemento Folder |
|
checkOutStateEnum
|
processes.checkOutStateEnum | string |
Enumeração de estado de check-out |
|
propriedades
|
processes.properties | array of object |
Propriedades |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
PropertyType Id |
|
values
|
processes.properties.values | array of string |
Valores de propriedade |
|
globalValues
|
processes.properties.globalValues | array of object |
Valores globais |
|
values
|
processes.properties.globalValues.values | array of object |
values |
|
cultura
|
processes.properties.globalValues.values.culture | string |
Cultura de valor global |
|
enviar SMS
|
processes.properties.globalValues.values.text | string |
Texto de valor global |
|
propertyTypeName
|
processes.properties.propertyTypeName | string |
Nome de PropertyType |
|
propertyName
|
processes.properties.propertyName | string |
Nome da propriedade |
|
priorityEnum
|
processes.priorityEnum | string |
Enumeração de prioridade |
|
statusEnum
|
processes.statusEnum | string |
Enumeração de status |
|
data de vencimento
|
processes.dueDate | string |
Data de conclusão |
|
hasLinks
|
processes.hasLinks | boolean |
Tem links |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
Lista de enumerações de direitos de acesso |
|
hasMore
|
hasMore | boolean |
Tem mais |
|
resumePoint
|
resumePoint | string |
Retomar ponto |
Processo de atualização (preterido) [PRETERIDO]
Processo de atualização (preterido)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
ProcessId | True | string |
ID do processo (Guid) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Atribua nomes de logon do usuário à tarefa atual. (por exemplo: peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
ProcessProperties
|
ProcessProperties | string |
Formato de atualização de propriedades do processo: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Propriedades personalizadas
|
CustomProperties | string |
Propriedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por exemplo, [Fornecedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Data][InvoiceNo|4711|Número]) |
|
|
Comment
|
Comment | string |
Comment |
|
|
Cultura
|
Culture | string |
A cultura na qual os nomes de propriedade são dados (de, en, fr, ...). Padrão = de |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
values |
|
cultura
|
name.values.culture | string |
cultura |
|
enviar SMS
|
name.values.text | string |
enviar SMS |
|
values
|
description.values | array of object |
values |
|
cultura
|
description.values.culture | string |
cultura |
|
enviar SMS
|
description.values.text | string |
enviar SMS |
|
id
|
id | string |
id |
|
protectionDomainId
|
protectionDomainId | string |
protectionDomainId |
|
processTemplateId
|
processTemplateId | string |
processTemplateId |
|
propriedades
|
properties | array of object |
propriedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
propertyTypeId |
|
values
|
properties.values | array of string |
values |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
cultura |
|
enviar SMS
|
properties.globalValues.values.text | string |
enviar SMS |
|
propertyTypeName
|
properties.propertyTypeName | string |
propertyTypeName |
|
propertyName
|
properties.propertyName | string |
propertyName |
|
priorityEnum
|
priorityEnum | string |
priorityEnum |
|
pluginStream
|
pluginStream | string |
pluginStream |
|
data de vencimento
|
dueDate | string |
data de vencimento |
|
createdDate
|
createdDate | string |
createdDate |
|
completedDate
|
completedDate | string |
completedDate |
|
comments
|
comments | array of object |
comments |
|
id
|
comments.id | string |
id |
|
date
|
comments.date | string |
date |
|
userId
|
comments.userId | string |
userId |
|
enviar SMS
|
comments.text | string |
enviar SMS |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
statusEnum
|
statusEnum | string |
statusEnum |
|
customProperties
|
customProperties | array of object |
customProperties |
|
nome
|
customProperties.name | string |
nome |
|
value
|
customProperties.value | string |
value |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
customPropertyTypeEnum |
|
id
|
currentTask.id | string |
id |
|
ação
|
currentTask.action | string |
ação |
|
creatorId
|
currentTask.creatorId | string |
creatorId |
|
data de vencimento
|
currentTask.dueDate | string |
data de vencimento |
|
createdDate
|
currentTask.createdDate | string |
createdDate |
|
completedDate
|
currentTask.completedDate | string |
completedDate |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
taskTemplateId |
|
comments
|
currentTask.comments | array of |
comments |
|
reminderDate
|
currentTask.reminderDate | string |
reminderDate |
|
statusEnum
|
currentTask.statusEnum | string |
statusEnum |
|
descrição
|
currentTask.description | string |
descrição |
|
requiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
requiresAllRecipients |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
intendedUserIds |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultura
|
currentTask.nameGlobal.values.culture | string |
cultura |
|
enviar SMS
|
currentTask.nameGlobal.values.text | string |
enviar SMS |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultura
|
currentTask.descriptionGlobal.values.culture | string |
cultura |
|
enviar SMS
|
currentTask.descriptionGlobal.values.text | string |
enviar SMS |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
taskActionEnum |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
id
|
completedTasks.id | string |
id |
|
ação
|
completedTasks.action | string |
ação |
|
creatorId
|
completedTasks.creatorId | string |
creatorId |
|
data de vencimento
|
completedTasks.dueDate | string |
data de vencimento |
|
createdDate
|
completedTasks.createdDate | string |
createdDate |
|
completedDate
|
completedTasks.completedDate | string |
completedDate |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
taskTemplateId |
|
comments
|
completedTasks.comments | array of |
comments |
|
reminderDate
|
completedTasks.reminderDate | string |
reminderDate |
|
statusEnum
|
completedTasks.statusEnum | string |
statusEnum |
|
descrição
|
completedTasks.description | string |
descrição |
|
requiresAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
requiresAllRecipients |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
intendedUserIds |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultura
|
completedTasks.nameGlobal.values.culture | string |
cultura |
|
enviar SMS
|
completedTasks.nameGlobal.values.text | string |
enviar SMS |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultura
|
completedTasks.descriptionGlobal.values.culture | string |
cultura |
|
enviar SMS
|
completedTasks.descriptionGlobal.values.text | string |
enviar SMS |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
taskActionEnum |
|
documentIds
|
documentIds | array of string |
documentIds |
|
checkOutStateEnum
|
checkOutStateEnum | string |
checkOutStateEnum |
|
checkOutUserId
|
checkOutUserId | string |
checkOutUserId |
|
sessionCount
|
sessionCount | integer |
sessionCount |
Processo de atualização (V2)
Processo de atualização (V2)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessId
|
ProcessId | True | string |
ID do processo (Guid) |
|
ProcessProperties
|
ProcessProperties | string |
Formato de atualização de propriedades do processo: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveProcessProperties
|
RemoveProcessProperties | string |
Lista de nomes ou IDs da propriedade separada ponto-e-vírgula a serem removidas do processo, como "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Departamentos" |
|
|
CustomProperties
|
CustomProperties | string |
Propriedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por exemplo, [Fornecedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Data][InvoiceNo|4711|Número]) |
|
|
Comment
|
Comment | string |
Adicionar um texto de comentário de processo |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Os nomes de logon de usuário atribuídos, separados por ponto-e-vírgula, como user1; user2 |
|
|
AddDocumentIds
|
AddDocumentIds | string |
Lista separada de ponto-e-vírgula de IDs de documento a serem adicionadas ao processo, por exemplo, '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
RemoveDocumentIds
|
RemoveDocumentIds | string |
Lista separada de ponto-e-vírgula de IDs de documento a serem removidas do processo, por exemplo, '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
Data de Conclusão
|
DueDate | string |
Data de conclusão do processo. Formato de data: yyy-MM-ddTHH:mm:ss. Padrão = data atual |
|
|
Priority
|
Priority | string |
Prioridade do processo (por exemplo, Baixa, Normal, Alta). Padrão = Normal |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Forçar o processo de desfazer o check-out, se necessário |
|
|
Domínio de proteção
|
ProtectionDomain | string |
ID ou nome do domínio de proteção |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
Valores de propriedade |
|
cultura
|
name.values.culture | string |
Cultura da propriedade |
|
enviar SMS
|
name.values.text | string |
Texto da propriedade |
|
values
|
description.values | array of object |
values |
|
cultura
|
description.values.culture | string |
Cultura da propriedade |
|
enviar SMS
|
description.values.text | string |
Texto da propriedade |
|
id
|
id | string |
ID do processo |
|
protectionDomainId
|
protectionDomainId | string |
ID do domínio de proteção do processo |
|
processTemplateId
|
processTemplateId | string |
ID do modelo de processo |
|
propriedades
|
properties | array of object |
Propriedades |
|
propertyTypeId
|
properties.propertyTypeId | string |
PropertyType Id |
|
values
|
properties.values | array of string |
Valores de propriedade |
|
globalValues
|
properties.globalValues | array of object |
Valores globais |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
Cultura de valor global |
|
enviar SMS
|
properties.globalValues.values.text | string |
Texto de valor global |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nome de PropertyType |
|
propertyName
|
properties.propertyName | string |
Nome da propriedade |
|
priorityEnum
|
priorityEnum | string |
Enumeração de prioridade do processo |
|
pluginStream
|
pluginStream | string |
Fluxo de plug-in do processo |
|
data de vencimento
|
dueDate | string |
Data de conclusão do processo |
|
createdDate
|
createdDate | string |
Data de criação do processo |
|
completedDate
|
completedDate | string |
Data de conclusão do processo |
|
comments
|
comments | array of object |
Comments |
|
id
|
comments.id | string |
ID de comentário do processo |
|
date
|
comments.date | string |
Data do comentário do processo |
|
userId
|
comments.userId | string |
ID do usuário do comentário do processo |
|
enviar SMS
|
comments.text | string |
Texto do comentário do processo |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista de enumerações de direitos de acesso |
|
statusEnum
|
statusEnum | string |
Enumeração de status |
|
customProperties
|
customProperties | array of object |
Propriedades personalizadas |
|
nome
|
customProperties.name | string |
Nome da propriedade personalizada |
|
value
|
customProperties.value | string |
Valor da propriedade personalizada |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Enumeração de tipo de propriedade personalizado |
|
id
|
currentTask.id | string |
ID da tarefa atual |
|
ação
|
currentTask.action | string |
Ação da tarefa atual |
|
creatorId
|
currentTask.creatorId | string |
ID atual do criador de tarefas |
|
data de vencimento
|
currentTask.dueDate | string |
Data de conclusão da tarefa atual |
|
createdDate
|
currentTask.createdDate | string |
Data da criação da tarefa atual |
|
completedDate
|
currentTask.completedDate | string |
Data da conclusão da tarefa atual |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
ID do modelo de tarefa atual |
|
comments
|
currentTask.comments | array of |
Comentários da tarefa atual |
|
reminderDate
|
currentTask.reminderDate | string |
Data do lembrete da tarefa atual |
|
statusEnum
|
currentTask.statusEnum | string |
Enumeração de status da tarefa atual |
|
descrição
|
currentTask.description | string |
Descrição da tarefa atual |
|
requiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
A tarefa atual requer todos os destinatários |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
IDs de usuário atribuídas à tarefa atual |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
IDs de usuário concluídas pela tarefa atual |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Caixa de diálogo de tarefa de fechamento da exibição de tarefas atuais |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
IDs de usuário pretendidas da tarefa atual |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultura
|
currentTask.nameGlobal.values.culture | string |
Cultura de nome global |
|
enviar SMS
|
currentTask.nameGlobal.values.text | string |
Texto de nome global |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultura
|
currentTask.descriptionGlobal.values.culture | string |
Cultura de descrição global |
|
enviar SMS
|
currentTask.descriptionGlobal.values.text | string |
Texto de descrição global |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
IDs cc de usuário atribuídas |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
Representações de deputado |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
Enumeração de ação da tarefa |
|
completedTasks
|
completedTasks | array of object |
Tarefas concluídas |
|
id
|
completedTasks.id | string |
ID da tarefa concluída |
|
ação
|
completedTasks.action | string |
Ação da tarefa concluída |
|
creatorId
|
completedTasks.creatorId | string |
ID do criador de tarefas concluída |
|
data de vencimento
|
completedTasks.dueDate | string |
Data de conclusão da tarefa |
|
createdDate
|
completedTasks.createdDate | string |
Data de criação da tarefa concluída |
|
completedDate
|
completedTasks.completedDate | string |
Data de conclusão da tarefa concluída |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
ID do modelo de tarefa concluída |
|
comments
|
completedTasks.comments | array of |
Comentários de tarefa concluídos |
|
reminderDate
|
completedTasks.reminderDate | string |
Data de lembrete da tarefa concluída |
|
statusEnum
|
completedTasks.statusEnum | string |
Enumeração de status da tarefa concluída |
|
descrição
|
completedTasks.description | string |
descrição |
|
requiresAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
A tarefa concluída requer todos os destinatários |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
IDs de usuário atribuídas à tarefa concluída |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
IDs de usuário concluídas da tarefa |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
Caixa de diálogo concluir tarefa mostrar fechar tarefa |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
IDs de usuário pretendidas da tarefa concluída |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultura
|
completedTasks.nameGlobal.values.culture | string |
Cultura de nome global |
|
enviar SMS
|
completedTasks.nameGlobal.values.text | string |
Texto de nome global |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultura
|
completedTasks.descriptionGlobal.values.culture | string |
Cultura de descrição global |
|
enviar SMS
|
completedTasks.descriptionGlobal.values.text | string |
Texto de descrição global |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
IDs cc de usuário atribuídas à tarefa concluída |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
Representações de deputado de tarefa concluídas |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
Enumeração da ação da tarefa concluída |
|
documentIds
|
documentIds | array of string |
IDs de documento de tarefa concluídas |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Enumeração de estado de check-out de tarefa concluída |
|
checkOutUserId
|
checkOutUserId | string |
ID do usuário de check-out da tarefa concluída |
|
sessionCount
|
sessionCount | integer |
Contagem de sessões de tarefa concluída |
Processo de criação
Processo de criação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
ProcessProperties
|
ProcessProperties | string |
Formato de atualização de propriedades do processo: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
CustomProperties
|
CustomProperties | string |
Propriedades personalizadas. Formato: [<PropertyName>|<PropertyValue>|PropertyType] (por exemplo, [Fornecedor|Muster|String][InvoiceDate|2021-01-29T13:05:45 |Data][InvoiceNo|4711|Número]) |
|
|
DocumentIds
|
DocumentIds | string |
Lista de todas as IDs de documento a serem anexadas |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
Nome do modelo de processo |
|
Data de Conclusão
|
DueDate | string |
Data de conclusão do processo. Formato de data: yyy-MM-ddTHH:mm:ss. Padrão = data atual |
|
|
Priority
|
Priority | string |
Prioridade do processo (por exemplo, Baixa, Normal, Alta). Padrão = Normal |
|
|
Comment
|
Comment | string |
Comentário do processo |
|
|
Cultura
|
Culture | string |
A cultura na qual o texto é dado (de, en, fr, ...). Padrão = de |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
Confira o estado do documento (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
ID do usuário para o qual o processo está em check-out |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data do comentário |
|
ID
|
comments.id | string |
Id de comentário |
|
Texto
|
comments.text | string |
Comentário definido pelo usuário |
|
UserId
|
comments.userId | string |
Identificação de usuário |
|
CompletedDate
|
completedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
CreatedDate
|
createdDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
Ação
|
currentTask.action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
CompletedDate
|
currentTask.completedDate | string |
Data de conclusão da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
Data de criação da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
ID do usuário do criador para a tarefa atual |
|
Description
|
currentTask.description | string |
Descrição da tarefa atual |
|
Data de Conclusão
|
currentTask.dueDate | string |
Data de conclusão da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
currentTask.intendedUserIds | array of string |
intendedUserIds |
|
ReminderDate
|
currentTask.reminderDate | string |
Data para lembrete da tarefa atual. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
StatusEnum
|
currentTask.statusEnum | string |
Tarefa atual de status (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
ID do modelo da tarefa atual |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Valor de enumeração de tipo de propriedade personalizado (Cadeia de caracteres, data, número) |
|
Nome
|
customProperties.name | string |
Nome da propriedade personalizada |
|
Value
|
customProperties.value | string |
Valor da propriedade personalizada |
|
documentIds
|
documentIds | array of string |
documentIds |
|
Data de Conclusão
|
dueDate | string |
Data de conclusão do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
ID do documento como elemento de pasta |
|
HasLinks
|
hasLinks | boolean |
ID do documento como elemento de pasta |
|
ID
|
id | string |
ID do processo |
|
values
|
name.values | array of object |
values |
|
Cultura
|
name.values.culture | string |
A cultura na qual o texto é dado (de, en, fr, ...) |
|
Texto
|
name.values.text | string |
O texto deste idioma |
|
PriorityEnum
|
priorityEnum | string |
Prioridade do processo (Alta, Normal, Baixa). Padrão = Normal |
|
PluginStream
|
pluginStream | string | |
|
ProcessTemplateId
|
processTemplateId | string |
ID do modelo de processo |
|
propriedades
|
properties | array of object |
propriedades |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultura
|
properties.globalValues.values.culture | string |
cultura |
|
enviar SMS
|
properties.globalValues.values.text | string |
enviar SMS |
|
PropertyName
|
properties.propertyName | string |
Nome da propriedade do processo |
|
PropertyTypeId
|
properties.propertyTypeId | string |
ID da propriedade do processo |
|
values
|
properties.values | array of string |
values |
|
ProtectionDomainId
|
protectionDomainId | string |
ID de domínio de proteção do processo |
|
StatusEnum
|
statusEnum | string |
Status do processo (Open, InProcess, Complete, PreparedToComplete, Error) |
Processos de lista (preteridos) [PRETERIDO]
Processos de lista (preteridos)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL da API de arquivo morto (por exemplo: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
A ID de conexão para identificar sua conexão |
|
Receptor
|
Receiver | string |
Nomes de logon de receptores de processos (por exemplo: john@sample.com|megan@sample.com). Está vazio, o usuário conectado será tomado como receptor |
|
|
Situação
|
Status | string |
Status do processo. Padrão = abrir |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
Se sim, todos os processos indipendentes do receptor serão listados. Padrão = false |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Número máximo de resultados da pesquisa de processo. Padrão = 100 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
processes |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
Confira o estado do processo (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
ID do usuário para o qual o documento está em check-out |
|
comments
|
processes.comments | array of object |
comments |
|
Date
|
processes.comments.date | string |
Data do comentário |
|
ID
|
processes.comments.id | string |
Id de comentário |
|
Texto
|
processes.comments.text | string |
Comentário definido pelo usuário |
|
UserId
|
processes.comments.userId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
processes.completedDate | string |
Data concluída do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
Ação
|
processes.completedTasks.action | string |
Texto de ação para o usuário. Exibido para o usuário final |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
Date
|
processes.completedTasks.comments.date | string |
Data do comentário |
|
ID
|
processes.completedTasks.comments.id | string |
Id de comentário |
|
Texto
|
processes.completedTasks.comments.text | string |
Comentário definido pelo usuário |
|
UserId
|
processes.completedTasks.comments.userId | string |
Id do usuário, que definiu o comentário |
|
CompletedDate
|
processes.completedTasks.completedDate | string |
Data de conclusão. Formato de data: yyy-MM-ddTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
processes.completedTasks.createdDate | string |
Data de criação. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
ID do usuário do criador |
|
Description
|
processes.completedTasks.description | string |
Descrição da tarefa |
|
Data de Conclusão
|
processes.completedTasks.dueDate | string |
Data de conclusão da tarefa. Formato de data: yyy-MM-ddTHH:mm:ss |
|
intendedUserIds
|
processes.completedTasks.intendedUserIds | array of |
intendedUserIds |
|
ReminderDate
|
processes.completedTasks.reminderDate | string |
Data para lembrete. Formato de data: yyy-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
Define se todos os destinatários precisam fechar essa tarefa |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
Mostrar a caixa de diálogo fechar tarefa no final da tarefa |
|
Situação
|
processes.completedTasks.statusEnum | string |
Status da tarefa (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
ID do modelo de tarefa |
|
CreatedDate
|
processes.createdDate | string |
Data de criação do processo. Formato de data: yyy-MM-ddTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
Tarefa ativa no momento |
|
CustomProperties
|
processes.customProperties | string |
Lista de todas as propriedades personalizadas |
|
DocumentIds
|
processes.documentIds | string |
Lista de todas as IDs de documento anexadas |
|
Data de Conclusão
|
processes.dueDate | string |
Data de conclusão do formato data do processo: yyyy-MM-ddTHH:mm:ss |
|
FolderElementId
|
processes.folderElementId | string |
ID do processo como elemento de pasta |
|
HasLinks
|
processes.hasLinks | boolean |
Sinalizar se o processo tem links |
|
ID
|
processes.id | string |
ID do processo |
|
values
|
processes.name.values | array of object |
values |
|
cultura
|
processes.name.values.culture | string |
cultura |
|
enviar SMS
|
processes.name.values.text | string |
enviar SMS |
|
PriorityEnum
|
processes.priorityEnum | string |
Prioridade do processo (Alta, Normal, Baixa) |
|
PluginStream
|
processes.pluginStream | string |
Contêiner de dados para plug-ins |
|
ProcessTemplateId
|
processes.processTemplateId | string |
ID do modelo de processo |
|
propriedades
|
processes.properties | array of object |
propriedades |
|
propertyName
|
processes.properties.propertyName | string |
propertyName |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
values
|
processes.properties.values | array of string |
values |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
ID de domínio de proteção do processo |
|
StatusEnum
|
processes.statusEnum | string |
Status do processo (Open, InProcess, Complete, PreparedToComplete, Error) |
|
HasMore
|
hasMore | boolean |
Indica se há mais resultados ou não. O sinalizador será definido como true se mais resultados estiverem disponíveis |
|
ResumePoint
|
resumePoint | string |
O ponto de retomada das operações de pesquisa anteriores. Definir nulo para a primeira operação de pesquisa |