Codificador – Word
O conector 'Encodian - Word' fornece uma ampla coleção de ações que facilitam a manipulação e a criação de documentos do Microsoft Word que abrangem todos os formatos de arquivo comuns. Esse conector é um dos nove conectores que formam o 'Encodian Flowr'; uma solução completa para automação de documentos de ponta a ponta usada por mais de 75.000 organizações. O 'Encodian Flowr' alimenta tudo, desde a criação de documentos modelo até a manipulação complexa de documentos.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Todas as regiões do Power Automate , exceto as seguintes: – 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 China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Standard | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Standard | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte de codificação |
| URL | https://support.encodian.com |
| support@encodian.com |
| Metadados do conector | |
|---|---|
| Publicador | Encodian |
| Site | https://www.encodian.com |
| Política de privacidade | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
| Categorias | Conteúdo e arquivos; Colaboração |
Encodian 'Flowr' Word para Power Automate
O conector 'Encodian Flowr Word' fornece nível empresarial e simples para usar ações do Power Automate para criar, mesclar, dividir e manipular documentos do Word.
O conector encodiano do Word 'Flowr' tem suporte do Power Automate, dos Aplicativos Lógicos do Azure e do Power Apps.
Registrar conta
Uma assinatura encodiana é necessária para usar o conector encodiano do Word 'Flowr'.
Preencha o formulário de inscrição para se registrar para uma avaliação de 30 dias e obter uma chave de API
Clique aqui para obter um guia passo a passo sobre como criar uma conexão codificada no Power Automate
Support
Contate o Suporte do Encodiano para solicitar assistência
A documentação da ação de codificação pode ser encontrada aqui e os fluxos de exemplo podem ser encontrados aqui
Mais Informações
Visite o site da Encodian para obter preços do plano de assinatura.
Depois que sua avaliação de 30 dias expirar, sua assinatura do Encodian será automaticamente transferida para a camada de assinatura "Gratuita" do Encodian, a menos que um plano pago tenha sido comprado.
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 | Compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | Obter uma chave de API - https://www.encodian.com/apikey/ | Verdade |
| Região | cadeia |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
Word – Adicionar cabeçalhos e rodapés
Adicionar cabeçalhos HTML e/ou rodapés ao documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/11348579020572
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Cabeçalho – Todas as Páginas
|
allPagesHeaderHtml | string |
O cabeçalho HTML a ser adicionado a todas as páginas |
|
|
Rodapé – Todas as Páginas
|
allPagesFooterHtml | string |
O rodapé HTML a ser adicionado a todas as páginas |
|
|
Cabeçalho – Primeira Página
|
firstPageHeaderHtml | string |
O cabeçalho HTML a ser adicionado à primeira página |
|
|
Cabeçalho – Páginas Pares
|
evenPageHeaderHtml | string |
O cabeçalho HTML a ser adicionado a todas as páginas pares |
|
|
Cabeçalho – Páginas ímpares
|
oddPageHeaderHtml | string |
O cabeçalho HTML a ser adicionado a todas as páginas ímpares |
|
|
Rodapé – Primeira Página
|
firstPageFooterHtml | string |
O rodapé HTML a ser adicionado à primeira página |
|
|
Rodapé – Páginas Pares
|
evenPageFooterHtml | string |
O rodapé HTML a ser adicionado a todas as páginas pares |
|
|
Rodapé – Páginas ímpares
|
oddPageFooterHtml | string |
O rodapé HTML a ser adicionado a todas as páginas ímpares |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Adicionar marca d'água da imagem
Adicionar uma marca d'água de imagem ao documento especificado do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/4411329161361
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Nome de arquivo de marca d'água
|
watermarkFilename | True | string |
O nome do arquivo de imagem da marca d'água, a extensão de arquivo é obrigatória: 'file.jpg' e não 'file' |
|
Conteúdo do arquivo de marca d'água
|
watermarkFileContent | True | byte |
O conteúdo do arquivo de imagem de marca d'água |
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
|
|
Scale
|
scale | double |
Defina o fator de escala expresso como uma fração da imagem. O valor padrão é 1, os valores válidos variam de 0 a 65,5 |
|
|
Semitransparente
|
isSemiTransparent | boolean |
Defina se a marca d'água de texto deve ser semi transparente |
|
|
Alinhar Imagem
|
alignImage | boolean |
Verifique se a imagem fornecida está alinhada às marcas de orientação EXIF |
Retornos
Word – Adicionar marca d'água de texto
Adicionar uma marca d'água de texto ao documento especificado do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/4411284008593
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Texto
|
text | True | string |
O texto a ser inserido como uma marca d'água no arquivo do Microsoft Word |
|
Orientação
|
orientation | string |
Definir a orientação da marca d'água do texto |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
|
|
Fonte
|
font | string |
Defina o tipo de fonte aplicado à marca d'água de texto, a fonte padrão é definida como Calibri |
|
|
Cor do Texto
|
textColour | string |
Defina a cor HTML aplicada à marca d'água de texto, a cor padrão é definida como nº 808080 (Cinza) |
|
|
Tamanho do Texto
|
textSize | integer |
Defina o tamanho da fonte aplicado à marca d'água de texto, o tamanho padrão é definido como 0 (Automático) |
|
|
Semitransparente
|
isSemiTransparent | boolean |
Defina se a marca d'água de texto deve ser semi transparente |
Retornos
Word – Atualizar hiperlinks
Localizar e atualizar hiperlinks contidos em um documento do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/7136687719837
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Pesquisar em
|
searchOn | True | string |
Defina se a pesquisa deve ser executada no texto do hiperlink ou no valor da URL |
|
Valor da pesquisa
|
searchValue | True | string |
O valor de URL ou texto do hiperlink a ser localizado |
|
É Expressão
|
isExpression | boolean |
Defina se o valor 'Valor de Pesquisa' deve ser avaliado como uma expressão regular, o valor padrão é 'false' |
|
|
Valor atual do texto
|
hyperlinkLabelValueCurrent | string |
O valor de texto a ser substituído, deixe em branco para substituir o valor inteiro |
|
|
Novo Valor de Texto
|
hyperlinkLabelValueNew | string |
O novo valor a ser definido |
|
|
Valor atual da URL
|
hyperlinkUrlValueCurrent | string |
O valor da URL a ser substituído, deixe em branco para substituir o valor inteiro |
|
|
Novo Valor da URL
|
hyperlinkUrlValueNew | string |
O novo valor de URL a ser definido |
|
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
Word – Atualizar o Sumário
Atualizar o 'Sumário' no documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/10594864447260
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Fuso horário
|
timezone | string |
Definir um fuso horário específico para processamento de data e hora |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Comparar
Comparar diferenças entre documentos do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/360018576278-Compare-Word-Documents
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do Arquivo – Um
|
fileContentOne | True | byte |
O conteúdo do arquivo do primeiro arquivo do Microsoft Word ou PDF a ser comparado. |
|
Conteúdo do Arquivo – Dois
|
fileContentTwo | True | byte |
O conteúdo do arquivo do segundo arquivo do Microsoft Word ou PDF a ser comparado. |
|
Autor
|
author | string |
Defina o nome do autor usado para indicar diferenças no documento de saída. |
|
|
Ignorar formatação
|
ignoreFormatting | boolean |
Especifica se as diferenças de formatação do documento devem ser ignoradas |
|
|
Não Sensível a Maiúsculas
|
caseInsensitive | boolean |
Especifica se as diferenças nos documentos não diferenciam maiúsculas de minúsculas |
|
|
Ignorar Comentários
|
ignoreComments | boolean |
Especifica se as diferenças nos comentários devem ser comparadas |
|
|
Ignorar tabelas
|
ignoreTables | boolean |
Especifica se as diferenças nos dados contidos nas tabelas devem ser comparadas |
|
|
Ignorar campos
|
ignoreFields | boolean |
Especifica se as diferenças nos campos devem ser comparadas. Por padrão, campos |
|
|
Ignorar notas de rodapé
|
ignoreFootnotes | boolean |
Especifica se as diferenças entre notas de rodapé e notas de fim devem ser comparadas |
|
|
Ignorar caixas de texto
|
ignoreTextboxes | boolean |
Especifica se as diferenças nos dados contidos nas caixas de texto devem ser comparadas |
|
|
Ignorar cabeçalhos e rodapés
|
ignoreHeadersAndFooters | boolean |
Especifica se as diferenças nos dados contidos em cabeçalhos e rodapés devem ser comparadas |
Retornos
Word – Definir metadados
Definir os metadados do documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/15942705445788
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Autor
|
author | string |
O autor do documento |
|
|
Categoria
|
category | string |
A categoria do documento |
|
|
Comments
|
comments | string |
O valor dos comentários do documento |
|
|
Empresa
|
company | string |
O valor da empresa do documento |
|
|
Criado
|
created | string |
A data em que o documento foi criado |
|
|
Base do Hiperlink
|
hyperlinkBase | string |
Definir o valor base usado para avaliar hiperlinks relativos no documento |
|
|
Palavras-chave
|
keywords | string |
As palavras-chave associadas ao documento |
|
|
Última modificação
|
lastModified | string |
A data em que o documento foi modificado |
|
|
Última modificação feita por
|
lastModifiedBy | string |
O último autor que modificou o documento |
|
|
Última Impressão
|
lastPrinted | string |
A data em que o documento foi impresso pela última vez |
|
|
Gerente
|
manager | string |
O gerente do documento |
|
|
Número de Revisão
|
revisionNumber | integer |
O número de revisão do documento |
|
|
Situação
|
status | string |
O status do documento |
|
|
Assunto
|
subject | string |
O assunto do documento |
|
|
Title
|
title | string |
O título do documento |
|
|
Tempo Total de Edição
|
totalEditingTime | integer |
O tempo total gasto editando o documento |
|
|
Propriedades personalizadas
|
customProperties | string |
Uma coleção JSON de valores de keypair para definir como entradas de metadados no documento fornecido |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Desabilitar alterações controladas
Desabilitar alterações controladas no documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/6695370804125
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do documento de origem do Microsoft Word |
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
Word – Desbloquear
Remover a segurança aplicada e a proteção do documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/19367982647068
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Senha de proteção
|
password | string |
Definir a senha usada para proteger o documento do Microsoft Word |
|
|
Proteger em Abrir Senha
|
secureOnOpenPassword | string |
Definir a senha usada para abrir o documento do Microsoft Word |
|
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
- Corpo
- DtoResponseWordUnlock
Word – Divisão
Dividir o documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/14575340646940
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word |
|
Tipo de divisão
|
splitType | True | string |
Selecione como dividir o arquivo |
|
Configuração de Divisão
|
splitConfiguration | string |
Fornecer uma configuração dividida |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Excluir Páginas
Excluir páginas especificadas do arquivo do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/14903494355996
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word |
|
Página Iniciar
|
startPage | integer |
Defina o número da página para começar a excluir páginas de |
|
|
Página Final
|
endPage | integer |
Defina o número da página para parar de excluir páginas. O valor padrão é definido como a última página do documento do Microsoft Word fornecido |
|
|
Números de Página
|
pageNumbers | string |
Uma lista separada por vírgulas de números de página das páginas a serem excluídas: 1,3,4 |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair alterações controladas
Extrair todas as alterações controladas (revisões e comentários) para o documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/6634950400669
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Incluir Comentários
|
includeComments | boolean |
Defina se os comentários devem ser incluídos nos resultados das alterações controladas |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair arquivos
Extrair arquivos do arquivo do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/22255231258524
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Página Iniciar
|
startPage | integer |
Defina o número da página do qual começar a extrair arquivos, padrão para a página 1 |
|
|
Página Final
|
endPage | integer |
Defina o número da página para parar de extrair arquivos, com o padrão de página da última página do documento |
|
|
Números de Página
|
pageNumbers | string |
Uma lista separada por vírgulas de números de página para extrair arquivos inseridos de: 1,3,4 |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair imagens
Extrair imagens especificadas do arquivo do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/15433980042908
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Página Iniciar
|
startPage | integer |
Definir o número da página para começar a extrair imagens de |
|
|
Página Final
|
endPage | integer |
Defina o número da página para parar de extrair imagens. O valor padrão é definido como a última página do documento do Microsoft Word fornecido |
|
|
Números de Página
|
pageNumbers | string |
Uma lista separada por vírgulas de números de página das páginas para extrair imagens de: 1,3,4 |
|
|
Índices de imagem
|
imageIndexes | string |
Uma lista separada por vírgulas de índices das imagens a serem extraídas: 1,3,4 |
|
|
Incluir imagens do corpo
|
includeBodyImages | boolean |
Se é necessário extrair imagens encontradas no corpo do documento do Word |
|
|
Incluir imagens de cabeçalho
|
includeHeaderImages | boolean |
Se é necessário extrair imagens encontradas nos cabeçalhos do documento do Word |
|
|
Incluir imagens do rodapé
|
includeFooterImages | boolean |
Se as imagens encontradas nos rodapés do documento do Word devem ser extraídas |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair metadados
Extrair metadados do Microsoft Word e informações relacionadas – https://support.encodian.com/hc/en-gb/articles/18211067662492
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair páginas
Extrair páginas especificadas do arquivo do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/14902696561948
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word |
|
Página Iniciar
|
startPage | integer |
Definir o número da página para começar a extrair páginas de |
|
|
Página Final
|
endPage | integer |
Defina o número da página para parar de extrair páginas. O valor padrão é definido como a última página do documento do Microsoft Word fornecido |
|
|
Números de Página
|
pageNumbers | string |
Uma lista separada por vírgulas de números de página das páginas a serem extraídas: 1,3,4 |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Extrair Texto
Extrair texto contido no arquivo do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/10583756977180
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word |
|
Página Iniciar
|
startPage | integer |
Define o número da página do qual iniciar a extração da camada de texto |
|
|
Página Final
|
endPage | integer |
Define o número da página do qual a extração da camada de texto será final. O valor padrão é definido como a última página do documento do Microsoft Word fornecido |
|
|
Remover Comentários
|
removeComments | boolean |
Defina se os comentários devem ser removidos antes de extrair texto do arquivo do Microsoft Word |
|
|
Aceitar alterações
|
acceptChanges | boolean |
Defina se as alterações controladas devem ser aceitas antes de extrair texto do arquivo do Microsoft Word |
|
|
Remover cabeçalhos e rodapés
|
removeHeadersAndFooters | boolean |
Definir se cabeçalhos e rodapés devem ser removidos do arquivo do Microsoft Word |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Gerenciar alterações controladas
Processar alterações controladas no documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/10074318228765
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
FileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
FileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Aceitar inserções
|
acceptInsertions | string |
Definir se as inserções devem ser aceitas ou rejeitadas |
|
|
Aceitar exclusões
|
acceptDeletions | string |
Definir se as exclusões devem ser aceitas ou rejeitadas |
|
|
Aceitar alterações de formato
|
acceptFormatChanges | string |
Definir se as alterações de formato devem ser aceitas ou rejeitadas |
|
|
Aceitar Movimentos
|
acceptMovements | string |
Definir se as movimentações de conteúdo devem ser aceitas ou rejeitadas |
|
|
Remover Comentários
|
removeComments | boolean |
Definir se os comentários devem ser removidos |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Habilitar alterações controladas
Habilitar alterações controladas no documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/6695385009053
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do documento de origem do Microsoft Word |
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
Word – Mesclar arquivos
Mesclar uma matriz de documentos do Microsoft Word em um único documento do Microsoft Word (DOCX) – https://support.encodian.com/hc/en-gb/articles/360023972213-Merge-document-array-to-Word
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
outputFilename | True | string |
O nome do arquivo do documento DOCX de saída |
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo de origem |
|
Posição de classificação
|
sortPosition | integer |
Definir a posição de classificação dentro da matriz de documentos |
|
|
Modo de Formato
|
wordInputFormatMode | string |
Defina como a formatação é tratada quando os documentos são mesclados no primeiro documento da matriz. |
|
|
Fuso horário
|
timezone | string |
Definir um fuso horário específico para processamento de data e hora |
|
|
Nível de conformidade
|
WordComplianceLevel | string |
Especificar qual especificação OOXML será usada ao salvar no formato DOCX |
Retornos
Word – Otimizar
Otimizar um documento do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/15275076156700
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Versão
|
version | True | string |
Especificar a versão do Microsoft Word para a qual otimizar |
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Popular
Preencher um Documento do Microsoft Word (DOCX) com os dados JSON fornecidos – https://support.encodian.com/hc/en-gb/articles/360019620578-Populate-Word-Document
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O Documento do Microsoft Word (DOCX) a ser preenchido |
|
Dados do documento
|
documentData | True | string |
Os dados JSON para preencher o Documento do Microsoft Word com |
|
Modo de Análise JSON
|
jsonParseMode | string |
Define o modo de análise JSON para valores simples (nulo, booliano, número, inteiro e cadeia de caracteres) |
|
|
Permitir valores ausentes
|
allowMissingMembers | boolean |
Define o mecanismo para permitir valores ausentes dentro dos 'Dados do Documento' |
|
|
Erros embutidos
|
inlineErrorMessages | boolean |
Produz erros no documento resultante em vez de rejeitar a solicitação com um erro HTTP 4** |
|
|
Remover parágrafos vazios
|
removeEmptyParagraphs | boolean |
Define o mecanismo para remover automaticamente todos os parágrafos vazios após a execução |
|
|
Formatos de data/hora
|
dateTimeFormat | string |
Definir um ou mais formatos de especificação para analisar valores datetime |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
|
|
Fuso horário
|
timezone | string |
Definir um fuso horário específico para processamento de data e hora |
Retornos
Word – Remover cabeçalhos e rodapés
Remover cabeçalhos e/ou rodapés do documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/11349707504540
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Remover todos os cabeçalhos
|
removeAllHeaders | boolean |
Definir para remover todos os cabeçalhos |
|
|
Remover todos os rodapés
|
removeAllFooters | boolean |
Definir para remover todos os rodapés |
|
|
Cabeçalho – Primeira Página
|
removeFirstPageHeader | boolean |
Definir para remover o cabeçalho da primeira página |
|
|
Cabeçalho – Páginas Pares
|
removeEvenPageHeader | boolean |
Definir para remover o cabeçalho de páginas pares |
|
|
Cabeçalho – Páginas ímpares
|
removeOddPageHeader | boolean |
Definir para remover o cabeçalho de páginas ímpares |
|
|
Rodapé – Primeira Página
|
removeFirstPageFooter | boolean |
Definir para remover o rodapé da primeira página |
|
|
Rodapé – Páginas Pares
|
removeEvenPageFooter | boolean |
Definido para remover o rodapé de páginas pares |
|
|
Rodapé – Páginas ímpares
|
removeOddPageFooter | boolean |
Definido para remover o rodapé de páginas ímpares |
Retornos
Word – Remover marca d'água
Remover a marca d'água do arquivo do Word fornecido – https://support.encodian.com/hc/en-gb/articles/7752587767965
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Word – Remover Sumário
Remover o 'Sumário' do documento do Microsoft Word fornecido – https://support.encodian.com/hc/en-gb/articles/14544663512860
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
|
|
Índices do Sumário
|
tableOfContentsIndexes | string |
Defina os números de índice das Tabelas de Conteúdo a serem removidas |
Retornos
Word – Seguro
Proteger e proteger um documento do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/6634150180253
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo do Microsoft Word de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | True | byte |
O conteúdo do arquivo do Microsoft Word de origem |
|
Tipo de proteção
|
wordProtectionType | string |
Definir o tipo de proteção para o documento do Microsoft Word |
|
|
Senha de proteção
|
password | string |
Definir a senha usada para proteger o documento do Microsoft Word |
|
|
Proteger em Abrir
|
secureOnOpen | boolean |
Defina se uma senha deve ser necessária para abrir o documento do Microsoft Word |
|
|
Proteger em Abrir Senha
|
secureOnOpenPassword | string |
Definir a senha usada para abrir o documento do Microsoft Word |
|
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
Word – Substituir Texto
Localizar e substituir o texto contido em um documento do Microsoft Word – https://support.encodian.com/hc/en-gb/articles/15949925002268
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
fileName | True | string |
O nome do arquivo de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
fileContent | byte |
O conteúdo do arquivo de origem |
|
|
Pesquisar Texto
|
searchText | True | string |
O texto a ser localizado e substituído pelo valor 'Texto de Substituição' |
|
É Expressão
|
isExpression | boolean |
Defina se o valor 'Texto de Pesquisa' deve ser avaliado como uma expressão regular, o valor padrão é 'false' |
|
|
Texto de substituição
|
replacementText | string |
O valor a ser substituído pelo texto 'Pesquisar Texto' |
|
|
Localizar somente palavras inteiras
|
findWholeWordsOnly | boolean |
Definir se apenas palavras inteiras devem ser encontradas |
|
|
Diferenciar maiúsculas de
|
caseSensitive | boolean |
Definir se o valor 'Texto de Pesquisa' deve ser avaliado como diferenciação de maiúsculas de minúsculas |
|
|
Fonte
|
font | string |
O nome da fonte a ser usado no 'Texto de Substituição'. Se a 'Fonte' não estiver definida, ela herdará a fonte atual usada no documento |
|
|
Fonte – Cor
|
fontColour | string |
A cor da fonte a ser usada no 'Texto de Substituição', a configuração padrão é 'Herdar' |
|
|
Fonte – Tamanho
|
fontSize | integer |
O tamanho da fonte a ser usada para o 'Texto de Substituição'. Se o tamanho da fonte não estiver definido, ele herdará o tamanho da fonte atual usado no documento |
|
|
Estilo - Cor do Plano de Fundo
|
styleBackgroundColour | string |
A cor da tela de fundo a ser usada no 'Texto de Substituição', a configuração padrão é 'Herdar' |
|
|
Estilo – Negrito
|
styleBold | string |
Defina se o 'Texto de Substituição' está definido como 'Negrito', o padrão é 'Herdar' |
|
|
Estilo – Itálico
|
styleItalic | string |
Defina se o 'Texto de Substituição' está definido como 'Itálico', o padrão é 'Herdar' |
|
|
Estilo – Tachado
|
styleStrikethrough | string |
Defina se o 'Texto de Substituição' é 'Atingido', o padrão é 'Herdar' |
|
|
Estilo – Tachado Duplo
|
styleDoubleStrikethrough | string |
Defina se o 'Texto de Substituição' é 'Double-struck Through', o padrão é 'Herdar' |
|
|
Estilo – Subscrito
|
styleSubscript | string |
Defina se o 'Texto de Substituição' é 'Subscrito', o padrão é 'Herdar' |
|
|
Estilo – Sobrescrito
|
styleSuperscript | string |
Defina se o 'Texto de Substituição' é 'Sobrescrito', o padrão é 'Herdar' |
|
|
Estilo – Sublinhado
|
styleUnderline | string |
Defina se o 'Texto de Substituição' deve ser 'Sublinhado', o valor padrão é 'Herdar' |
|
|
Espaçamento do Word
|
wordSpacing | float |
A palavra espaçamento a ser aplicada ao 'Texto de Substituição'. Se 'Espaçamento do Word' não estiver definido, ele herdará o espaçamento de palavra atual usado no documento |
|
|
Nome da cultura
|
cultureName | string |
Altere a cultura de thread usada para processar a solicitação. |
Retornos
Word – Substituir texto por imagem
Localizar e substituir o texto contido em um documento do Word por uma imagem – https://support.encodian.com/hc/en-gb/articles/15089626493340
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do Arquivo
|
FileName | True | string |
O nome do arquivo de origem, a extensão de arquivo é obrigatória: 'file.docx' e não 'file' |
|
Conteúdo do arquivo
|
FileContent | True | byte |
O conteúdo do arquivo de origem |
|
Pesquisar Texto
|
SearchText | True | string |
O texto a ser localizado e substituído pela imagem especificada |
|
Conteúdo do arquivo de imagem
|
imageFileContent | True | byte |
O conteúdo do arquivo de imagem |
|
Ignorar Primeira Página
|
skipFirstPage | boolean |
Definir se deve ignorar a primeira página ao pesquisar o fragmento de texto |
|
|
Aplicar a
|
applyTo | string |
Definir quais páginas dentro do documento pesquisar o fragmento de texto |
|
|
Números de Página
|
pageNumbers | string |
Especifique os números de página para pesquisar o fragmento de texto, essa propriedade só se aplica quando a propriedade 'Apply To' é definida como 'Specific'. |
|
|
Ignorar números de página
|
pageNumbersIgnore | string |
Especifique os números de página para não pesquisar o fragmento de texto, essa propriedade só se aplica quando a propriedade 'Apply To' é definida como 'Específica'. |
|
|
Nome da cultura
|
cultureName | string |
Alterar a cultura de thread usada para processar a solicitação |
Retornos
Definições
DocumentArray
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do Arquivo
|
fileName | string |
O nome do arquivo |
|
Conteúdo do arquivo
|
fileContent | byte |
O conteúdo do arquivo |
DtoResponseAddHtmlHeaderFooterWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseAddImageWatermarkWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseAddTextWatermarkWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseCompareWordDocuments
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseDeleteWordPages
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseDisableTrackedChanges
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseEnableTrackedChanges
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseExtractWordPages
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseGetTextFromWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Texto
|
text | string |
O texto extraído do documento de palavra fornecido |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseGetTrackedChanges
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
JSON – Alterações controladas
|
trackedChangesJson | string |
Uma cadeia de caracteres formatada em JSON que contém detalhes de alterações controladas |
|
JSON – Comentários
|
commentsJson | string |
Uma cadeia de caracteres formatada em JSON que contém comentários |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseManageTrackedChanges
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseMergeArrayOfDocumentsToWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseOptimiseWordDocument
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponsePopulateWordDocument
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseRemoveHeaderFooterWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseRemoveWatermarksFromWord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseRemoveWordTableOfContents
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseSearchAndReplaceHyperlink
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseSecureWordDocument
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseSplitWordDocument
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentArray |
A matriz de documentos a serem processados |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseUpdateWordTableOfContents
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseWordExtractFiles
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of DocumentArray |
A matriz de arquivos extraídos do documento do Word |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseWordExtractImages
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Imagens
|
Images | array of DocumentArray |
A matriz de imagens extraídas do documento do Word |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseWordExtractMetadata
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Autor
|
author | string |
O autor do documento |
|
Categoria
|
category | string |
A categoria do documento |
|
Caracteres
|
characters | integer |
Uma estimativa do número total de caracteres presentes no documento |
|
Caracteres – Incluindo espaços
|
charactersWithSpaces | integer |
Uma estimativa do número total de caracteres (incluindo espaços) presentes no documento |
|
Comments
|
comments | string |
O valor dos comentários do documento |
|
Empresa
|
company | string |
O valor da empresa do documento |
|
Tipo de conteúdo
|
contentType | string |
O tipo MIME do documento |
|
Criado
|
created | date-time |
A data em que o documento foi criado |
|
Propriedades personalizadas
|
customProperties | string |
Todas as propriedades personalizadas presentes no documento do Word como uma matriz JSON de pares chave/valor |
|
Tamanho do arquivo (MBs)
|
fileSize | string |
O tamanho do arquivo fornecido em MBs |
|
Palavras-chave
|
keywords | string |
As palavras-chave associadas ao documento |
|
Última modificação
|
lastModified | date-time |
A data em que o documento foi modificado pela última vez |
|
Última modificação feita por
|
lastModifiedBy | string |
O último autor que modificou o documento |
|
Última Impressão
|
lastPrinted | date-time |
A data em que o documento foi impresso pela última vez |
|
Linhas
|
lines | integer |
Uma estimativa do número total de linhas presentes no documento |
|
Gerente
|
manager | string |
O gerente do documento |
|
Páginas
|
pages | integer |
Uma estimativa do número total de páginas presentes no documento |
|
Parágrafos
|
paragraphs | integer |
Uma estimativa do número total de parágrafos presentes no documento |
|
Número de Revisão
|
revisionNumber | integer |
O número de revisão do documento |
|
Situação
|
status | string |
O status do documento |
|
Assunto
|
subject | string |
O assunto do documento |
|
Template
|
template | string |
O nome do modelo aplicado ao documento |
|
Title
|
title | string |
O título do documento |
|
Tempo Total de Edição
|
totalEditingTime | integer |
O tempo total gasto editando o documento |
|
Palavras
|
words | integer |
Uma estimativa do número total de palavras presentes no documento |
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
DtoResponseWordReplaceTextWithImage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseWordSearchAndReplaceText
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseWordSetMetadata
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |
DtoResponseWordUnlock
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Código de Estado HTTP
|
HttpStatusCode | integer |
O código de status HTTP para a resposta. |
|
Mensagem de status HTTP
|
HttpStatusMessage | string |
A mensagem de status HTTP para a resposta. |
|
ID da operação
|
OperationId | string |
A ID exclusiva atribuída a esta operação. |
|
Errors
|
Errors | array of string |
Uma matriz de mensagens de erro deve ocorrer um erro. |
|
Status da operação
|
OperationStatus | string |
Indica se a operação foi concluída, foi enfileirada ou falhou. |
|
Nome do Arquivo
|
Filename | string |
O nome do arquivo do documento. |
|
Conteúdo do arquivo
|
FileContent | byte |
O documento processado. |