Partilhar via


DocumentosCorePack

O DocumentsCorePack é um pacote rápido e geração simples de documentos baseada em dados do Dynamics 365. Baseado em modelos do MS Word, o DocumentsCorePack oferece-lhe um conjunto de ferramentas para criar e processar documentos de forma eficaz. Desde um assistente de geração de documentos que orienta os utilizadores através do processo até à automatização total de documentos - o DocumentsCorePack fará com que os seus documentos empresariais pareçam profissionais e ajudá-lo-á a processá-los de forma eficiente!

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Copilot Studio Premium Todas as regiões Power Automate exceto as seguintes:
     - China Cloud operado pela 21Vianet
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões Azure China
Power Apps Premium Todas as regiões Power Apps exceto as seguintes:
     - China Cloud operado pela 21Vianet
Power Automate Premium Todas as regiões Power Automate exceto as seguintes:
     - China Cloud operado pela 21Vianet
Contato
Nome mscrm-addons.com
URL https://support.mscrm-addons.com
Email support@mscrm-addons.com
Metadados do conector
Editora mscrm-addons.com ( PTM EDV Systeme )
Sítio Web https://poweraddons.com
Política de privacidade https://www.mscrm-addons.com/LegalDocuments
Categorias Produtividade; Vendas e CRM

Conector DocumentsCorePack

O DocumentsCorePack permite-lhe gerar e automatizar os seus documentos incorporando dados do Dataverse e Dynamics 365. Com base nos modelos do Microsoft Word, o Documents CorePack Connector oferece-lhe uma variedade de ações para criar e processar os seus documentos.

O DocumentsCorePack Connector traz esta funcionalidade para Azure Logic Apps, Microsoft Power Automate, Microsoft Power Apps e Microsoft Copilot Studio. Detalhes

Siga este link para ver tutoriais passo a passo, instruções e obter informações detalhadas.

Editora: PTM EDV Systeme GmbH - mscrm-addons.com Corp.

Pré-requisitos

  • Dynamics 365 ou ambiente Dataverse.
  • Serviço DocumentsCorePack (Você pode iniciar uma avaliação usando este link)

Gerar chave de API para seu ambiente

Uma chave de API pode ser gerada a partir da configuração do Serviço DocumentsCorePack (Observe que, se você não tiver um serviço, poderá iniciar uma avaliação gratuita usando este link).

Na Service-Configuration, clique em Optain the API-Key.

Se você tiver problemas, por favor, dê uma olhada no seguinte artigo ou envie um e-mail para

Documentação da API

A documentação da API pode ser encontrada aqui

Operações suportadas

Criar documento

Cria um novo documento. Para mais informações, clique aqui.

Create DocumentJob (assíncrono)

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações, clique aqui.

Criar documento Multiparte

Crie um documento composto por vários componentes. Para mais informações, clique aqui.

Create Multipart DocumentJob (assíncrono)

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações, clique aqui.

Assinar DocumentarTrabalho

Envie um documento para assinatura eletrónica.

Assinar DocumentoColeção de Empregos

Envie documentos para assinatura eletrónica.

Run One-Click-Action

Executa um One-Click-Action e aguarda o resultado. Para mais informações, clique aqui.

Run One-Click-Action (assíncrono)

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações, clique aqui.

Obtenha o resultado do DocumentJob

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Obtenha o estado do DocumentEmprego

Recupera o status de um DocumentJob.

Imprimir documento gerado por um DocumentJob.

Imprimir documento gerado por um DocumentJob. A ação NÃO espera por um resultado.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx. A ação NÃO espera por um resultado.

Anexar DocumentJob como nota

Anexe um documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Anexar ficheiro como nota

Anexe um documento de conteúdo ou ficheiro codificado em base64 como nota a um registo Dynamics 365.

Anexar o DocumentJob ao email

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email do Dynamics 365.

Anexar ficheiro ao email

Anexe um conteúdo de documento ou ficheiro codificado base64 como anexo a um email do Dynamics 365.

Concatena dois DocumentJobs

Concatene dois documentos gerados por dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Concatenar dois conteúdos de documentos ou ficheiros codificados base64 (pdf, docx)

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf, docx.

Enviar e-mail

Envie e-mail Dataverse.

Criar pasta SharePoint

Cria pastas no SharePoint na localização do documento de um registo Dynamics 365.

Batch de processos na jornada do cliente

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. Para mais informações, clique aqui.

Processamento em lote na jornada do cliente (assíncrono)

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. A ação NÃO espera por um resultado. Para mais informações, clique aqui.

Obtém o ambiente padrão para esta ApiKey

Retorna a id do ambiente para a ApiKey usada.

Obter perfis para um usuário APIKey

Recupera todas as IDs de perfil para esta ApiKey.

Obter modelos de documentos

Recupera uma lista de modelos DocumentsCorePack disponíveis.

Obter impressoras

Recupere impressoras disponíveis.

Obtenha umClick-Actions

Recupera todos os OneClick-Actions configurados em Dynamics 365.

Quem sou eu

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Obtenção de credenciais

Primeiro de tudo, você precisa criar uma conta e se inscrever para um serviço DocumentsCorePack (14 dias de testes gratuitos disponíveis).

Obtenha a chave de API para o seu ambiente:

  • Criar um serviço DocumentsCorePack
  • Optain a chave de API

Se você tiver alguma dúvida, envie um e-mail para

Problemas conhecidos e limitações

N/A

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para mais informações, consulte a visão geral Connectors para aplicações canvas - Power Apps | Microsoft Docs

Nome Tipo Description Obrigatório
Chave de API securestring A chave de API para esta api Verdade

Limites de Limitação

Nome Chamadas Período de Renovação
Chamadas de API por conexão 1200 60 segundos

Ações

Anexar arquivo ao e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o ficheiro codificado Conteúdo do Documento ou base64 como anexo a um email Dynamics 365

Anexar arquivo ao e-mail (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado em base64 como anexo a um email Dynamics 365.

Anexar arquivo ao e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o ficheiro codificado base64 como anexo a um email Dynamics 365

Anexar arquivo como nota (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o ficheiro codificado Document Content ou base64 como nota a uma entidade Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Anexar arquivo como nota (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado base64 como nota a um registo Dynamics 365.

Anexar arquivo como nota [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o ficheiro fornecido como base 64 string como nota a uma entidade Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Anexar DocumentJob ao e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o Conteúdo do Documento gerado por um DocumentJob como anexo a um Dynamics 365 email

Anexar DocumentJob ao e-mail (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email Dynamics 365.

Anexar DocumentJob ao e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o ficheiro gerado por um DocumentJob como anexo a um Dynamics 365 email

Anexar DocumentJob ao email (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email Dynamics 365.

Anexar DocumentJob como nota

Anexe um documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Anexar DocumentJob como nota (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexe o Conteúdo do Documento gerado por um DocumentJob como nota a uma entidade do Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Anexar DocumentJob como nota (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexar documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Anexar DocumentJob como nota (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexar documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Anexar DocumentJob como nota [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexe o ficheiro gerado por um DocumentJob como nota a uma entidade do Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Anexar ficheiro ao email

Anexe um documento de conteúdo ou ficheiro codificado base64 como anexo a um email do Dynamics 365.

Anexar ficheiro ao email (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado em base64 como anexo a um email Dynamics 365.

Anexar ficheiro como nota

Anexe um documento de conteúdo ou ficheiro codificado em base64 como nota a um registo Dynamics 365.

Anexar ficheiro como nota (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado base64 como nota a um registo Dynamics 365.

Anexar o DocumentJob ao email

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email do Dynamics 365.

Assinar DocumentarTrabalho

Envie um documento para assinatura eletrónica.

Assinar DocumentJob (sincronização) (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Envie um documento para assinatura eletrónica.

Assinar DocumentJob com base em um XML (sincronização) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Esta função assina digitalmente um DocumentJob e aguarda o resultado

Assinar DocumentoColeção de Empregos

Envie documentos para assinatura eletrónica.

Batch de processos na jornada do cliente

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. Para mais informações

Concatena dois DocumentJobs

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Concatenar dois arquivos (pdf,docx) [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois ficheiros fornecidos (pdf,docx)

Concatenar dois conteúdos do documento ou ficheiros codificados em base64 (pdf,docx) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos do documento ou ficheiros codificados base64 (pdf,docx)

Concatenar dois DocumentJobs (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois conteúdos de documentos (pdf,docx) gerados por dois DocumentJobs

Concatenar dois DocumentJobs (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Concatenar dois DocumentJobs (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Concatenar dois DocumentJobs [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois arquivos (pdf,docx) gerados por dois DocumentJobs

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Create DocumentJob (assíncrono)

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Create DocumentJob (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Create Multipart DocumentJob (assíncrono)

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

CreateSharepointFolder (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Esta função cria pastas do sharepoint

Criar DocumentJob (assíncrono) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Esta função cria um novo DocumentJob.. Atenção! A função NÃO espera por um resultado

Criar DocumentJob (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Criar DocumentJob (assíncrono) [PRETERIDO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Esta função cria um novo DocumentJob.. Atenção! A função NÃO espera por um resultado

Criar DocumentJob com base em um XML (assíncrono) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Esta função cria um novo DocumentJob. Atenção! A função NÃO espera por um resultado

Criar DocumentJob com base em um XML (assíncrono) [DEPRECATED]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Esta função cria um novo DocumentJob. Atenção! A função NÃO espera por um resultado

Criar DocumentJob com base em um XML (sincronização) [DEPRECATED]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado por até [TimeOut] segundos

Criar documento

Cria um novo documento. Para mais informações

Criar documento (sincronizar) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado por até [TimeOut] segundos

Criar documento (sincronização) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado

Criar documento (sincronização) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Cria um novo documento. Para mais informações

Criar documento (sincronização) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Cria um novo documento. Para mais informações

Criar documento com base em um XML (sincronização) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado

Criar documento com várias partes (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

Criar documento com várias partes (sincronização) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Crie um documento composto por vários componentes. Para mais informações

Criar documento Multiparte

Crie um documento composto por vários componentes. Para mais informações

Criar documento Multiparte (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

Criar documento Multiparte (sincronizado) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Crie um documento composto por vários componentes. Para mais informações

Criar pasta SharePoint

Cria pastas no SharePoint na localização do documento de um registo Dynamics 365.

Criar pasta SharePoint (V3) [OBSOLETA]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Cria pastas em SharePoint na localização do documento de um registo Dynamics 365.

Criar pasta SharePoint (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Cria pastas em SharePoint na localização do documento de um registo Dynamics 365.

Enviar e-mail

Envie e-mail Dataverse.

Enviar e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie o e-mail especificado

Enviar e-mail (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie e-mail Dataverse.

Enviar e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie o e-mail especificado

Enviar email (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie e-mail Dataverse.

Executar One-Click-Action (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Executar One-Click-Action (sync) (V3) [DEPRECATED]

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Executar OneClickAction (assíncrono) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Esta função executa um OneClickAction. Atenção! A função NÃO espera por um resultado

Executar OneClickAction (sincronização) (V2) [PRETERIDO]

Esta função executa uma OneClickAction e espera pelo resultado

Ficheiro de impressão

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Ficheiro de impressão (assíncrono)

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx. A ação NÃO espera por um resultado.

Ficheiro de impressão (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Imprimir arquivo (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo do documento ou um arquivo codificado em base64. Os formatos de ficheiro suportados são PDF e DOCX

Imprimir arquivo (v3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Imprimir arquivo [DEPRECATED]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um arquivo codificado em base64. Os formatos de ficheiro suportados são PDF e DOCX

Imprimir DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprima o Conteúdo do Documento gerado por um DocumentJob. Atenção! O trabalho do documento já deve estar concluído

Imprimir DocumentJob (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprimir documento gerado por um DocumentJob.

Imprimir DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprima um documento gerado por um DocumentJob. Atenção! O trabalho do documento já deve estar concluído

IsServiceAlive [OBSOLETO]

retorna true, se o serviço tiver sido responsivo recentemente, false, se não.

Obtenha o estado do DocumentEmprego

Recupera o status de um DocumentJob.

Obtenha o resultado do DocumentJob

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Obtenha umClick-Actions

Recupera todos os OneClick-Actions configurados em Dynamics 365.

Obter detalhes da conexão [DEPRECATED]

Verifica se o ponto de extremidade da API está acessível no momento. Não requer chave de API

Obter fornecedores de assinatura eletrónica [DEPRECATED]

Recupere todos os provedores de assinatura eletrônica disponíveis no DocumentsCorePack.

Obter fornecedores de assinatura eletrónica [DEPRECATED]

Recupere todos os provedores de assinatura eletrônica disponíveis no DocumentsCorePack.

Obter impressora DCP [PRETERIDO]

Esta ação foi preterida. Em vez disso, use Obter impressoras .

Recuperar nomes de impressora disponíveis, opcionalmente filtrados pelo usuário

Obter impressoras

Recupere impressoras disponíveis.

Obter impressoras [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter impressoras .

Recupere impressoras disponíveis.

Obter modelos [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter modelos de documento .

Esta função retorna uma lista de modelos DocumentsCorePack disponíveis

Obter modelos de documentos

Recupera uma lista de modelos DocumentsCorePack disponíveis.

Obter modelos de documentos [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter modelos de documento .

Recupera uma lista de modelos DocumentsCorePack disponíveis.

Obter o estado do DocumentJob (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob.

Obter o resultado do DocumentJob (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Obter OneClickActions [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get One-Click-Actions .

Esta função devolve todas as OneClickActions em Dynamics 365

Obter perfis para um UserAPIKey [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get Profiles for a User APIKey .

Esta função devolve todos os IDs de Perfis em Dynamics 365

Obter perfis para um usuário APIKey

Recupera todas as IDs de perfil para esta ApiKey.

Obter perfis para um usuário APIKey [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get Profiles for a User APIKey .

Recupera todas as IDs de perfil para esta ApiKey.

Obter resultado do DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de DocumentJobs. O resultado incluirá o documento de resultado, se o trabalho for concluído

Obter resultado do DocumentJob (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Obter resultado do DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de DocumentJobs. O resultado incluirá o documento de resultado, se o trabalho for concluído

Obter SignProviders [DEPRECATED]

Esta função retorna todos os SignProviders conhecidos na AutomergeSolution

Obter status do DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob. Aplicam-se as regras state/statuscode do Dynamics 365

Obter status do DocumentJob (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob.

Obter status do DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob. Aplicam-se as regras state/statuscode do Dynamics 365

Obter um-Click-Actions [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get One-Click-Actions .

Recupera todos osClick-Actions One- configurados em Dynamics 365.

Obtém o ambiente padrão para esta ApiKey

Retorna a id do ambiente para a ApiKey usada.

Obtém o ambiente padrão para esta ApiKey [DEPRECATED]

Retorna a id do ambiente para a ApiKey usada.

Print DocumentJob

Imprimir documento gerado por um DocumentJob.

Print DocumentJob (assíncrono)

Imprimir documento gerado por um DocumentJob. A ação NÃO espera por um resultado.

Print DocumentJob (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprimir documento gerado por um DocumentJob.

Processamento em lote na jornada do cliente (assíncrono)

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. A ação NÃO espera por um resultado. Para mais informações

Processamento em lote na jornada do cliente (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Process batch na customer journey (assíncrono) em vez disso.

Cria um novo documento. Para mais informações

Processamento em lote na jornada do cliente (sincronizado) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Process batch na jornada do cliente em vez disso.

Cria um novo documento. Para mais informações

Quem sou eu

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Run One-Click-Action

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Run One-Click-Action (assíncrono)

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Run One-Click-Action (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Run One-Click-Action (sincronizado) (V4) [DESCONTINUADO]

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Sign DocumentJob (sincronizado) (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Envie um documento para assinatura eletrónica.

Verifique a disponibilidade da API [DEPRECATED]

Esta ação foi preterida. Por favor, utilize antes a opção Verificar Disponibilidade da API .

Verifica se o ponto de extremidade da API está acessível no momento. Não requer chave de API

WhoAmEu [DEPRECIADO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Retorna informações sobre a chave de API usada atualmente e o serviço associado

WhoAmI (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Retorna informações sobre a chave de API usada atualmente e o serviço associado

WhoAmI (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

WhoAmI (V4) [DEPRECIADO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Anexar arquivo ao e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o ficheiro codificado Conteúdo do Documento ou base64 como anexo a um email Dynamics 365

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Mime-Type
MimeType string

Tipo mime de conteúdo para manipulação do arquivo (por exemplo, aplicativo/texto)

User
User string
EmailId
EmailId True string

O e-mail ao qual o documento deve ser anexado

Regressos

Anexar arquivo ao e-mail (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado em base64 como anexo a um email Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do arquivo do anexo.

Tipo de MIME
MimeType string

Tipo MIME do anexo (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Anexar arquivo ao e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o ficheiro codificado base64 como anexo a um email Dynamics 365

Parâmetros

Nome Chave Necessário Tipo Descrição
Documento (base64)
Document (base64) True string

Uma cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Mime-Type
Mime-Type string

Tipo mime de conteúdo para manipulação do arquivo (por exemplo, aplicativo/texto)

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
EmailId
EmailId True string

O e-mail ao qual o documento deve ser anexado

Regressos

Anexar arquivo como nota (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o ficheiro codificado Document Content ou base64 como nota a uma entidade Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Mime-Type
MimeType string

Tipo mime de conteúdo para manipulação do arquivo (por exemplo, aplicativo/texto)

User
User string
Nome do esquema
Schemaname True string
Descrição da nota
Description string

Definir este texto como Descrição das notas

Assunto da nota
Subject string

Definir este texto como assuntos do Notes

ID da entidade
EntityId True string

O Guid da entidade a anexar a nota

Regressos

Anexar arquivo como nota (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado base64 como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do ficheiro do anexo da nota.

Tipo de MIME
MimeType string

Tipo MIME de conteúdo para o tratamento do ficheiro (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar arquivo como nota [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o ficheiro fornecido como base 64 string como nota a uma entidade Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
Documento (base64)
Document (base64) True string

Uma cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Mime-Type
Mime-Type string

Tipo mime de conteúdo para manipulação do arquivo (por exemplo, aplicativo/texto)

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
Nome do esquema
Schemaname True string

O schemaname da entidade à qual anexar a nota

Description
Note description string

Definir este texto como Descrição das notas

Assunto
Note subject string

Definir este texto como assuntos do Notes

Sobre ObjectId
Entity Id True string

O Guid da entidade a anexar a nota

Regressos

Anexar DocumentJob ao e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o Conteúdo do Documento gerado por um DocumentJob como anexo a um Dynamics 365 email

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

DocumentJobId
DocumentJobId True string

O ID DocumentJob do documento gerado a ser anexado ao e-mail

User
User string
EmailId
EmailId True string

O e-mail ao qual o documento deve ser anexado

Regressos

Anexar DocumentJob ao e-mail (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a ser anexado ao e-mail.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Anexar DocumentJob ao e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o ficheiro gerado por um DocumentJob como anexo a um Dynamics 365 email

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJobId
DocumentJobId True string

O ID DocumentJob do documento gerado a ser anexado ao e-mail

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
EmailId
EmailId True string

O e-mail ao qual o documento deve ser anexado

Regressos

Anexar DocumentJob ao email (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, utilize Anexar DocumentJob ao email em vez disso.

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a ser anexado ao e-mail.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Anexar DocumentJob como nota

Anexe um documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a anexar à nota.

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar DocumentJob como nota (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexe o Conteúdo do Documento gerado por um DocumentJob como nota a uma entidade do Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

DocumentJobId
DocumentJobId True string

O ID DocumentJob do documento gerado a ser anexado à nota

User
User string
Nome do esquema
Schemaname True string
Descrição da nota
Description string

Definir este texto como Descrição das notas

Assunto da nota
Subject string

Definir este texto como assuntos do Notes

ID da entidade
EntityId True string

O Guid da entidade a anexar a nota

Regressos

Anexar DocumentJob como nota (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexar documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a anexar à nota.

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar DocumentJob como nota (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexar documento gerado por um DocumentJob como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a anexar à nota.

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar DocumentJob como nota [DEPRECATED]

Esta ação foi preterida. Por favor, use Anexar DocumentJob como nota em vez disso.

Anexe o ficheiro gerado por um DocumentJob como nota a uma entidade do Dynamics 365. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJobId
DocumentJobId True string

O ID DocumentJob do documento gerado a ser anexado à nota

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
Nome do esquema
Schemaname True string

O schemaname da entidade à qual anexar a nota

Description
Note description string

Definir este texto como Descrição das notas

Assunto
Note subject string

Definir este texto como assuntos do Notes

Sobre ObjectId
Entity Id True string

O Guid da entidade a anexar a nota

Regressos

Anexar ficheiro ao email

Anexe um documento de conteúdo ou ficheiro codificado base64 como anexo a um email do Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do arquivo do anexo.

Tipo de MIME
MimeType string

Tipo MIME do anexo (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Anexar ficheiro ao email (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Anexar ficheiro ao email em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado em base64 como anexo a um email Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do arquivo do anexo.

Tipo de MIME
MimeType string

Tipo MIME do anexo (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Anexar ficheiro como nota

Anexe um documento de conteúdo ou ficheiro codificado em base64 como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do ficheiro do anexo da nota.

Tipo de MIME
MimeType string

Tipo MIME de conteúdo para o tratamento do ficheiro (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar ficheiro como nota (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Anexar ficheiro como nota em vez disso.

Anexe o conteúdo de um documento ou ficheiro codificado base64 como nota a um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Nome do ficheiro do anexo da nota.

Tipo de MIME
MimeType string

Tipo MIME de conteúdo para o tratamento do ficheiro (por exemplo, aplicação/pdf).

User
User string

Escolha o usuário para executar esta operação.

Nome da tabela
Schemaname True string

Escolha a tabela à qual anexar a nota.

Descrição da nota
Description string

Texto da nota.

Assunto da nota
Subject string

Assunto da nota.

ID da Linha
EntityId True string

Identificador único do registo ao qual anexar a nota.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Anexar o DocumentJob ao email

Anexe o conteúdo do documento gerado por um DocumentJob como anexo a um email do Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

DocumentJob ID
DocumentJobId True string

Identificador exclusivo do DocumentJob a ser anexado ao e-mail.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

ID de E-mail
EmailId True string

Identificador único do e-mail ao qual o documento deve ser anexado.

Regressos

Assinar DocumentarTrabalho

Envie um documento para assinatura eletrónica.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

ID da Linha
EntityId True string

Identificador único do registo ao qual o registo eSign será anexado.

Nome da tabela
Schemaname True string

Nome da tabela do registo ao qual o registo eSign será anexado.

DocumentJob ID
DocumentJob True uuid

Identificador exclusivo do DocumentJob a assinar.

User
User string

Escolha o usuário para executar esta operação.

Provedor de assinatura
SignProvider True integer

Escolha o provedor de assinatura eletrônica.

Assunto padrão do e-mail
Subject string

Assunto padrão no e-mail de solicitação de assinatura.

Mensagem padrão de e-mail
Message string

Mensagem padrão no e-mail de solicitação de assinatura.

Nome
Name True string

O nome para exibição do signatário.

Email
Email True string

O endereço de e-mail do signatário.

Presencial
InPerson True boolean

Gera um link para iniciar o processo de assinatura.

Assunto
Subject string

Assunto personalizado na assinatura de e-mail de solicitação.

Message
Message string

Mensagem personalizada no e-mail de solicitação de assinatura.

Número de telefone
TelNr string

Número de telefone dos signatários para autenticação por SMS (somente DocuSign).

Nome do host DocuSign
HostName string

Nome dos hosts de assinatura para assinatura inPerson (somente DocuSign).

E-mail do anfitrião
Hostemail string

A assinatura hospeda o endereço de e-mail para assinatura inPerson (somente DocuSign).

Código de Acesso
AccessCode string

A confirmar.

HasAccessCode
HasAccessCode boolean

A confirmar.

OTP
OTP string

A confirmar.

HasSMSAuth
HasSMSAuth boolean

A confirmar.

Nome
Name string

A confirmar.

Utilizações
Uses string

A confirmar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Assinar DocumentJob (sincronização) (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Envie um documento para assinatura eletrónica.

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True string

Identificador único do registo ao qual o registo eSign será anexado.

Nome da tabela
Schemaname True string

Nome da tabela do registo ao qual o registo eSign será anexado.

DocumentJob ID
DocumentJob True uuid

Identificador exclusivo do DocumentJob a assinar.

User
User string

Escolha o usuário para executar esta operação.

Provedor de assinatura
SignProvider True integer

Escolha o provedor de assinatura eletrônica.

Assunto padrão do e-mail
Subject string

Assunto padrão no e-mail de solicitação de assinatura.

Mensagem padrão de e-mail
Message string

Mensagem padrão no e-mail de solicitação de assinatura.

Nome
Name True string

O nome para exibição do signatário.

Email
Email True string

O endereço de e-mail do signatário.

Presencial
InPerson True boolean

Gera um link para iniciar o processo de assinatura.

Assunto
Subject string

Assunto personalizado na assinatura de e-mail de solicitação.

Message
Message string

Mensagem personalizada no e-mail de solicitação de assinatura.

Número de telefone
TelNr string

Número de telefone dos signatários para autenticação por SMS (somente DocuSign).

Nome do host DocuSign
HostName string

Nome dos hosts de assinatura para assinatura inPerson (somente DocuSign).

E-mail do anfitrião
Hostemail string

A assinatura hospeda o endereço de e-mail para assinatura inPerson (somente DocuSign).

Código de Acesso
AccessCode string

A confirmar.

HasAccessCode
HasAccessCode boolean

A confirmar.

OTP
OTP string

A confirmar.

HasSMSAuth
HasSMSAuth boolean

A confirmar.

Nome
Name string

A confirmar.

Utilizações
Uses string

A confirmar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Assinar DocumentJob com base em um XML (sincronização) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Esta função assina digitalmente um DocumentJob e aguarda o resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

EntityId
EntityId True string

O Guid da Entidade ao qual o registo eSign será anexado

Nome do esquema
Schemaname True string

O Schemaname da Entidade à qual o registro eSign será anexado

DocumentJob
DocumentJob True uuid

DocumentJobId que contém o documento a assinar

User
User string
Provedor de assinatura
SignProvider True integer

O provedor que deve ser usado para assinar este documento

Assunto padrão do e-mail
Subject string

Assunto padrão no e-mail de solicitação de assinatura

Mensagem padrão de e-mail
Message string

Mensagem padrão no e-mail de solicitação de assinatura

Nome
Name True string

O nome para exibição do signatário.

Email
Email True string

O endereço de e-mail do signatário.

Presencial
InPerson True boolean

Gera um link para iniciar o processo de assinatura.

Assunto
Subject string

Assunto personalizado na assinatura de e-mail de solicitação.

Message
Message string

Mensagem personalizada no e-mail de solicitação de assinatura.

Número de telefone
TelNr string

Número de telefone dos signatários para autenticação por SMS (somente DocuSign).

Nome do host DocuSign
HostName string

Nome dos hosts de assinatura para assinatura inPerson (somente DocuSign).

E-mail do anfitrião
Hostemail string

A assinatura hospeda o endereço de e-mail para assinatura inPerson (somente DocuSign).

Código de Acesso
AccessCode string

A confirmar.

HasAccessCode
HasAccessCode boolean

A confirmar.

OTP
OTP string

A confirmar.

HasSMSAuth
HasSMSAuth boolean

A confirmar.

Nome
Name string

A confirmar.

Utilizações
Uses string

A confirmar.

Regressos

Assinar DocumentoColeção de Empregos

Envie documentos para assinatura eletrónica.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

ID da Linha
EntityId True string

Identificador único do registo ao qual o registo eSign será anexado.

Nome da tabela
Schemaname True string

Nome da tabela do registo ao qual o registo eSign será anexado.

Coleção DocumentJob ID
DocumentJobCollection True array of uuid

Identificadores únicos de DocumentJobs para assinar.

User
User string

Escolha o usuário para executar esta operação.

Provedor de assinatura
SignProvider True integer

Escolha o provedor de assinatura eletrônica.

Assunto padrão do e-mail
Subject string

Assunto padrão no e-mail de solicitação de assinatura.

Mensagem padrão de e-mail
Message string

Mensagem padrão no e-mail de solicitação de assinatura.

Nome
Name True string

O nome para exibição do signatário.

Email
Email True string

O endereço de e-mail do signatário.

Presencial
InPerson True boolean

Gera um link para iniciar o processo de assinatura.

Assunto
Subject string

Assunto personalizado na assinatura de e-mail de solicitação.

Message
Message string

Mensagem personalizada no e-mail de solicitação de assinatura.

Número de telefone
TelNr string

Número de telefone dos signatários para autenticação por SMS (somente DocuSign).

Nome do host DocuSign
HostName string

Nome dos hosts de assinatura para assinatura inPerson (somente DocuSign).

E-mail do anfitrião
Hostemail string

A assinatura hospeda o endereço de e-mail para assinatura inPerson (somente DocuSign).

Código de Acesso
AccessCode string

A confirmar.

HasAccessCode
HasAccessCode boolean

A confirmar.

OTP
OTP string

A confirmar.

HasSMSAuth
HasSMSAuth boolean

A confirmar.

Nome
Name string

A confirmar.

Utilizações
Uses string

A confirmar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Batch de processos na jornada do cliente

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

[Tabela]
EntitySchemaName True string

Escolha a tabela para executar este documento.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Template
Template True uuid

Escolha o modelo para este DocumentJob.

Viagem
Journey True uuid

Escolha a jornada do cliente para este DocumentJob.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

BatchDelay
BatchDelay integer

Intervalo entre processos documentais em horas.

BatchSize
BatchSize integer

Número de itens necessários para acionar o processamento de documentos.

Coluna Ordenar
SortField string

Especifique um valor de classificação para os registros no documento.

Direção da Ordenação
SortDirection integer

Ordenar a ordem das colunas.

Guardar localização
SaveLocationUri string

Defina um local de salvamento personalizado (Blob ou Sharepoint).

Impressora
DCPPrinterName string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Concatena dois DocumentJobs

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Primeira ID do DocumentJob
DocumentJob1 True uuid

Identificador exclusivo do primeiro DocumentJob.

Segunda ID do DocumentJob
DocumentJob2 True uuid

Identificador exclusivo do segundo DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Concatenar dois arquivos (pdf,docx) [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois ficheiros fornecidos (pdf,docx)

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeiro nome do arquivo
First Filename True string

O nome do ficheiro do primeiro documento

Primeiro Mime-Type
First Mime-Type True string

Tipo de mímica de conteúdo para o tratamento do primeiro documento (por exemplo, aplicação/pdf)

Primeiro documento (base64)
First Document (base64) True string

Uma cadeia de caracteres codificada em base64 que representa o primeiro conteúdo do documento

Segundo nome do arquivo
Second Filename True string

O nome do arquivo do segundo documento

Segundo Mime-Type
Second Mime-Type True string

Conteúdo mime-type para o tratamento do segundo documento (por exemplo, aplicação/pdf)

Segundo documento (base64)
Second Document (base64) True string

Uma cadeia de caracteres codificada em base64 que representa o conteúdo do segundo documento

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
CombineType
CombineType True integer

Selecione como os arquivos devem ser combinados

OutputFileType
OutputFileType True integer

Selecione um tipo de arquivo para o resultado da concationation

Regressos

Concatenar dois conteúdos do documento ou ficheiros codificados em base64 (pdf,docx) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos do documento ou ficheiros codificados base64 (pdf,docx)

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Primeiro nome do arquivo
FileName_1 True string

O nome do ficheiro do primeiro documento

Primeiro Mime-Type
MimeType_1 True string

Tipo de mímica de conteúdo para o tratamento do primeiro documento (por exemplo, aplicação/pdf)

Conteúdo do primeiro documento
base64_1 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Segundo nome do arquivo
FileName_2 True string

O nome do arquivo do segundo documento

Segundo Mime-Type
MimeType_2 True string

Conteúdo mime-type para o tratamento do segundo documento (por exemplo, aplicação/pdf)

Conteúdo do segundo documento
base64_2 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

User
User string
CombineType
CombineType True integer

Selecione como os arquivos devem ser combinados

OutputFileType
OutputFileType True integer

Selecione um tipo de arquivo para o resultado da concationation

Regressos

Concatenar dois DocumentJobs (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois conteúdos de documentos (pdf,docx) gerados por dois DocumentJobs

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Primeiro DocumentJob
DocumentJob1 True uuid

Primeiro DocumentJobId de ConcatenationJob

Segundo DocumentJob
DocumentJob2 True uuid

Segundo DocumentJobId de ConcatenationJob

User
User string
CombineType
CombineType True integer

Selecione como os arquivos devem ser combinados

OutputFileType
OutputFileType True integer

Selecione um tipo de arquivo para o resultado da concationation

Regressos

Concatenar dois DocumentJobs (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeira ID do DocumentJob
DocumentJob1 True uuid

Identificador exclusivo do primeiro DocumentJob.

Segunda ID do DocumentJob
DocumentJob2 True uuid

Identificador exclusivo do segundo DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Concatenar dois DocumentJobs (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois DocumentJobs. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeira ID do DocumentJob
DocumentJob1 True uuid

Identificador exclusivo do primeiro DocumentJob.

Segunda ID do DocumentJob
DocumentJob2 True uuid

Identificador exclusivo do segundo DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Concatenar dois DocumentJobs [DEPRECATED]

Esta ação foi preterida. Por favor, use em vez disso Concatenar dois DocumentJobs .

Concatenar dois arquivos (pdf,docx) gerados por dois DocumentJobs

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeiro DocumentJob
First DocumentJob True uuid

Primeiro DocumentJobId de ConcatenationJob

Segundo DocumentJob
Second DocumentJob True uuid

Segundo DocumentJobId de ConcatenationJob

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

UserId
UserId string
CombineType
CombineType True integer

Selecione como os arquivos devem ser combinados

OutputFileType
OutputFileType True integer

Selecione um tipo de arquivo para o resultado da concationation

Regressos

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Primeiro nome do arquivo
FileName_1 True string

Nome do ficheiro do primeiro documento.

Primeiro Mime-Type
MimeType_1 True string

Tipo MIME do primeiro documento (por exemplo, candidatura/pdf).

Conteúdo do primeiro documento
base64_1 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Segundo nome do arquivo
FileName_2 True string

Nome do arquivo do segundo documento.

Segundo Mime-Type
MimeType_2 True string

Tipo MIME do segundo documento (por exemplo, pedido/pdf).

Conteúdo do segundo documento
base64_2 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeiro nome do arquivo
FileName_1 True string

Nome do ficheiro do primeiro documento.

Primeiro Mime-Type
MimeType_1 True string

Tipo MIME do primeiro documento (por exemplo, candidatura/pdf).

Conteúdo do primeiro documento
base64_1 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Segundo nome do arquivo
FileName_2 True string

Nome do arquivo do segundo documento.

Segundo Mime-Type
MimeType_2 True string

Tipo MIME do segundo documento (por exemplo, pedido/pdf).

Conteúdo do segundo documento
base64_2 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx [DEPRECATED]

Esta ação foi preterida. Por favor, use Concatenar dois documentos. Tipos de ficheiros suportados: pdf, docx em vez disso.

Concatena dois conteúdos de documentos ou ficheiros codificados em base64. Tipos de ficheiros suportados: pdf,docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Primeiro nome do arquivo
FileName_1 True string

Nome do ficheiro do primeiro documento.

Primeiro Mime-Type
MimeType_1 True string

Tipo MIME do primeiro documento (por exemplo, candidatura/pdf).

Conteúdo do primeiro documento
base64_1 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Segundo nome do arquivo
FileName_2 True string

Nome do arquivo do segundo documento.

Segundo Mime-Type
MimeType_2 True string

Tipo MIME do segundo documento (por exemplo, pedido/pdf).

Conteúdo do segundo documento
base64_2 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

User
User string

Escolha o usuário para executar esta operação.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

CombineType
CombineType True integer

Escolha o tipo de combinação.

Tipo de arquivo de saída
OutputFileType True integer

Escolha o tipo de arquivo para o resultado.

Regressos

Create DocumentJob (assíncrono)

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Create DocumentJob (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Create Multipart DocumentJob (assíncrono)

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

CreateSharepointFolder (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Esta função cria pastas do sharepoint

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Enumeração de nome de pasta
FolderNames array of string

Forneça todos os nomes de pastas para criar

Sobre ObjectId
EntityId True string

O Guid da entidade para criar as pastas para

Dynamics Schemaname
Schemaname True string

O schemaname da entidade para a qual criar as pastas

User
User string
Localização do Documento
DocumentLocation string

Regressos

Criar DocumentJob (assíncrono) (V2) [DEPRECATED]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Esta função cria um novo DocumentJob.. Atenção! A função NÃO espera por um resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

Template
Template True uuid

Selecione o modelo para este DocumentJob

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

FileType
FileType True string

Selecione um tipo de arquivo para o resultado do documento

User
User string

Opcional, o usuário para executar esta operação

SaveToSharepoint
SaveToSharepoint boolean

Opcional, salvar documento no sharepoint

DCPPrinterName
DCPPrinterName string

Opcional, selecione a impressora para uma operação PrintDocument

AttachToEmail
AttachToEmailId uuid

Especifica o e-mail ao qual anexar o trabalho

AttachToEntity
AttachToEntityId uuid

Especifica o entityId ao qual anexar o trabalho

AttachToEntity - Nome do Esquema
AttachToEntitySchemaName string

Especifica o nome do esquema de entidade ao qual anexar o DocumentJob

Regressos

Criar DocumentJob (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Cria um novo documento. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar DocumentJob (assíncrono) [PRETERIDO]

Esta ação foi preterida. Por favor, use o Create DocumentJob (assíncrono) em vez disso.

Esta função cria um novo DocumentJob.. Atenção! A função NÃO espera por um resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
TemplateId
TemplateId True uuid

Selecione o modelo para este DocumentJob

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

FileType
FileType True string

Selecione um tipo de arquivo para o resultado do documento

UserId
UserId string

Opcional, o usuário para executar esta operação

SaveToSharepoint
SaveToSharepoint boolean

Opcional, salvar documento no sharepoint

DCPPrinterName
DCPPrinterName string

Opcional, selecione a impressora para uma operação PrintDocument

Regressos

Criar DocumentJob com base em um XML (assíncrono) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Esta função cria um novo DocumentJob. Atenção! A função NÃO espera por um resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

MultiPartXml
MultiPartXml True string

Documento XML com várias partes para o DocumentJob

User
User string

Regressos

Criar DocumentJob com base em um XML (assíncrono) [DEPRECATED]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Esta função cria um novo DocumentJob. Atenção! A função NÃO espera por um resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Tempo Limite
TimeOut integer

Tempo limite para a criação de documentos

MultiPartXml
MultiPartXml True string

Documento XML com várias partes para o DocumentJob

User
User string

Regressos

Criar DocumentJob com base em um XML (sincronização) [DEPRECATED]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado por até [TimeOut] segundos

Parâmetros

Nome Chave Necessário Tipo Descrição
DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Tempo Limite
TimeOut integer

Tempo limite para a criação de documentos

MultiPartXml
MultiPartXml True string

Documento XML com várias partes para o DocumentJob

User
User string

Regressos

Criar documento

Cria um novo documento. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento (sincronizar) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado por até [TimeOut] segundos

Parâmetros

Nome Chave Necessário Tipo Descrição
TemplateId
TemplateId True uuid

Selecione o modelo para este DocumentJob

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

FileType
FileType True string

Selecione um tipo de arquivo para o resultado do documento

Tempo Limite
TimeOut integer

Máx. Tempo de espera pelo documento

UserId
UserId string

Opcional, forneça o nome de domínio ou id dos utilizadores do Dynamics 365

SaveToSharepoint
SaveToSharepoint boolean

Opcional, salvar documento no sharepoint

DCPPrinterName
DCPPrinterName string

Opcional, selecione a impressora DCP para uma operação PrintDocument

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Regressos

Criar documento (sincronização) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

Template
Template True uuid

Selecione o modelo para este DocumentJob

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

FileType
FileType True string

Selecione um tipo de arquivo para o resultado do documento

User
User string

Opcional, forneça o nome de domínio ou id dos utilizadores do Dynamics 365

SaveToSharepoint
SaveToSharepoint boolean

Opcional, salvar documento no sharepoint

DCPPrinterName
DCPPrinterName string

Opcional, selecione a impressora DCP para uma operação PrintDocument

AttachToEmail
AttachToEmailId uuid

Especifica o e-mail ao qual anexar o trabalho

AttachToEntity
AttachToEntityId uuid

Especifica o entityId ao qual anexar o trabalho

AttachToEntity - Nome do Esquema
AttachToEntitySchemaName string

Especifica o nome do esquema de entidade ao qual anexar o DocumentJob

Regressos

Criar documento (sincronização) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Cria um novo documento. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento (sincronização) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar documento em vez disso.

Cria um novo documento. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Template
Template True uuid

Escolha o modelo para este DocumentJob.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

Anexar ao e-mail
AttachToEmailId uuid

Identificador exclusivo do e-mail ao qual anexar o documento.

Impressora
DCPPrinterName string

Escolha impressora.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Nome
Name string

Nome/ID do prompt.

Valor
Value string

Valor do prompt.

IsValid
IsValid boolean
Fonte de dados JSON
JSONDataSource string

Use esses dados JSON para a criação de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento com base em um XML (sincronização) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Esta função cria um novo DocumentJob e aguarda o resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

MultiPartXml
MultiPartXml True string

Documento XML com várias partes para o DocumentJob

User
User string

Regressos

Criar documento com várias partes (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento com várias partes (sincronização) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Crie um documento composto por vários componentes. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento Multiparte

Crie um documento composto por vários componentes. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento Multiparte (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar DocumentJob Multiparte (assíncrono) em vez disso.

Crie um documento composto por vários componentes. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar documento Multiparte (sincronizado) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar Documento Multiparte em vez disso.

Crie um documento composto por vários componentes. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
XML com várias partes
MultiPartXml True string

Definição XML de várias partes para o DocumentJob.

User
User string

Escolha o usuário para executar esta operação.

Usar armazenamento externo
SaveToTempRecord boolean

Poupe apenas em localização alternativa.

Guardar localização
SaveLocation string

SharePoint externo ou URL de Blob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar pasta SharePoint

Cria pastas no SharePoint na localização do documento de um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Nomes de pastas
FolderNames array of string

Forneça todos os nomes de pastas a serem criados.

ID da Linha
EntityId True string

Identificador exclusivo do registro para o qual criar as pastas.

Nome da tabela
Schemaname True string

Tablename do registro para o qual criar as pastas.

User
User string

Escolha o usuário para executar esta operação.

ID de DocumentLocalização
DocumentLocation string

Escolha um local do documento para criar as pastas.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar pasta SharePoint (V3) [OBSOLETA]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Cria pastas em SharePoint na localização do documento de um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Nomes de pastas
FolderNames array of string

Forneça todos os nomes de pastas a serem criados.

ID da Linha
EntityId True string

Identificador exclusivo do registro para o qual criar as pastas.

Nome da tabela
Schemaname True string

Tablename do registro para o qual criar as pastas.

User
User string

Escolha o usuário para executar esta operação.

ID de DocumentLocalização
DocumentLocation string

Escolha um local do documento para criar as pastas.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Criar pasta SharePoint (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Criar SharePoint pasta em vez disso.

Cria pastas em SharePoint na localização do documento de um registo Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Nomes de pastas
FolderNames array of string

Forneça todos os nomes de pastas a serem criados.

ID da Linha
EntityId True string

Identificador exclusivo do registro para o qual criar as pastas.

Nome da tabela
Schemaname True string

Tablename do registro para o qual criar as pastas.

User
User string

Escolha o usuário para executar esta operação.

ID de DocumentLocalização
DocumentLocation string

Escolha um local do documento para criar as pastas.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Enviar e-mail

Envie e-mail Dataverse.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

E-mail para enviar
EmailToSend True string

Identificador exclusivo do e-mail a enviar.

User
User string

Escolha o usuário para executar esta operação.

Remetente (ID da linha)
SenderId uuid

Identificador exclusivo do remetente do e-mail.

Remetente (Nome da tabela)
SenderLogicalName string

Nome da tabela do remetente, o padrão é systemuser.

Em relação a (ID da linha)
RegardingObjectId uuid

Identificador exclusivo da tabela a ser definida em relação a.

Em relação a (Nome da tabela)
RegardingObjectLogicalName string

Nome da tabela a ser definido como relativo.

ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Enviar e-mail (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie o e-mail especificado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

EmailToSend
EmailToSend True string

Guid de e-mail para enviar

User
User string
Remetente (userid)
SenderId uuid

GUID do remetente do e-mail

Remetente (Schemaname)
SenderLogicalName string

Nome do esquema do remetente, o padrão é systemuser

Em relação a (id)
RegardingObjectId uuid

Guid da entidade a definir em relação

Em relação a (Schemaname)
RegardingObjectLogicalName string
Id
Id uuid
Nome do esquema
Schemaname string
Id
Id uuid
Nome do esquema
Schemaname string
Id
Id uuid
Nome do esquema
Schemaname string

Regressos

Enviar e-mail (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie e-mail Dataverse.

Parâmetros

Nome Chave Necessário Tipo Descrição
E-mail para enviar
EmailToSend True string

Identificador exclusivo do e-mail a enviar.

User
User string

Escolha o usuário para executar esta operação.

Remetente (ID da linha)
SenderId uuid

Identificador exclusivo do remetente do e-mail.

Remetente (Nome da tabela)
SenderLogicalName string

Nome da tabela do remetente, o padrão é systemuser.

Em relação a (ID da linha)
RegardingObjectId uuid

Identificador exclusivo da tabela a ser definida em relação a.

Em relação a (Nome da tabela)
RegardingObjectLogicalName string

Nome da tabela a ser definido como relativo.

ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Enviar e-mail [DEPRECATED]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie o e-mail especificado

Parâmetros

Nome Chave Necessário Tipo Descrição
DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

EmailToSend
EmailToSend True string

Guid de e-mail para enviar

User
User string
Remetente (userid)
Sender (userid) uuid

GUID do remetente do e-mail

Remetente (Schemaname)
Sender (Schemaname) string

Nome do esquema do remetente, o padrão é systemuser

Em relação a (id)
Regarding (Id) uuid

Guid da entidade a definir em relação

Em relação a (Schemaname)
Regarding (Schemaname) string
Id
Id uuid
Nome do esquema
Schemaname string
Id
Id uuid
Nome do esquema
Schemaname string
Id
Id uuid
Nome do esquema
Schemaname string

Regressos

Enviar email (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Enviar e-mail em vez disso.

Envie e-mail Dataverse.

Parâmetros

Nome Chave Necessário Tipo Descrição
E-mail para enviar
EmailToSend True string

Identificador exclusivo do e-mail a enviar.

User
User string

Escolha o usuário para executar esta operação.

Remetente (ID da linha)
SenderId uuid

Identificador exclusivo do remetente do e-mail.

Remetente (Nome da tabela)
SenderLogicalName string

Nome da tabela do remetente, o padrão é systemuser.

Em relação a (ID da linha)
RegardingObjectId uuid

Identificador exclusivo da tabela a ser definida em relação a.

Em relação a (Nome da tabela)
RegardingObjectLogicalName string

Nome da tabela a ser definido como relativo.

ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
ID da Linha
Id uuid
Nome da tabela
Schemaname string
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Executar One-Click-Action (assíncrono) (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Regressos

Executar One-Click-Action (sync) (V3) [DEPRECATED]

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Regressos

Executar OneClickAction (assíncrono) (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Esta função executa um OneClickAction. Atenção! A função NÃO espera por um resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

OneClickAction
OneClickAction True uuid

Id do OneClickAction a aplicar

User
User string

Recuperar apenas modelos acessíveis a este utilizador

Regressos

Executar OneClickAction (sincronização) (V2) [PRETERIDO]

Esta função executa uma OneClickAction e espera pelo resultado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

EntityId
EntityId True uuid

Id de registo fonte Dynamics 365

OneClickAction
OneClickAction True uuid

Id do OneClickAction a aplicar

User
User string

Recuperar apenas modelos acessíveis a este utilizador

Regressos

Ficheiro de impressão

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Escolha o nome do arquivo.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Ficheiro de impressão (assíncrono)

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx. A ação NÃO espera por um resultado.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Escolha o nome do arquivo.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Ficheiro de impressão (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Escolha o nome do arquivo.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Imprimir arquivo (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo do documento ou um arquivo codificado em base64. Os formatos de ficheiro suportados são PDF e DOCX

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Selecione o ambiente para sua operação

Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Impressora
DCPPrinterName True string

Regressos

Imprimir arquivo (v3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um conteúdo de documento ou um arquivo codificado em base64. Tipos de ficheiros suportados: pdf, docx.

Parâmetros

Nome Chave Necessário Tipo Descrição
Conteúdo do documento
base64 True byte

Um objeto de conteúdo ou cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos.

Nome do arquivo
Filename True string

Escolha o nome do arquivo.

Impressora
DCPPrinterName True string

Escolha impressora.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Imprimir arquivo [DEPRECATED]

Esta ação foi preterida. Por favor, use Imprimir ficheiro em vez disso.

Imprime um arquivo codificado em base64. Os formatos de ficheiro suportados são PDF e DOCX

Parâmetros

Nome Chave Necessário Tipo Descrição
DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Documento (base64)
Document (base64) True string

Uma cadeia de caracteres codificada em base64 que representa o conteúdo dos arquivos

Nome do ficheiro
Filename True string

O nome do arquivo a ser usado para armazenar o arquivo

Impressora
DCPPrinterName True string

Regressos

Imprimir DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprima o Conteúdo do Documento gerado por um DocumentJob. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

DocumentJobId
DocumentJobId True uuid

GUID do DocumentJob Id para imprimir

DCPPrinterName
DCPPrinterName True string

DCP Nome da impressora a ser usada

Regressos

Imprimir DocumentJob (V3) [DEPRECATED]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprimir documento gerado por um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob a imprimir.

Impressora
DCPPrinterName True string

Escolha impressora.

Meio Ambiente
Environment string

Escolha o ambiente.

Regressos

Imprimir DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprima um documento gerado por um DocumentJob. Atenção! O trabalho do documento já deve estar concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJobId
DocumentJobId True uuid

GUID do DocumentJob Id para imprimir

DCPPrinterName
DCPPrinterName True string

DCP Nome da impressora a ser usada

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Regressos

IsServiceAlive [OBSOLETO]

retorna true, se o serviço tiver sido responsivo recentemente, false, se não.

Regressos

Obtenha o estado do DocumentEmprego

Recupera o status de um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob para recuperar o status de.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obtenha o resultado do DocumentJob

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obtenha umClick-Actions

Recupera todos os OneClick-Actions configurados em Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obter detalhes da conexão [DEPRECATED]

Verifica se o ponto de extremidade da API está acessível no momento. Não requer chave de API

Regressos

Obter fornecedores de assinatura eletrónica [DEPRECATED]

Recupere todos os provedores de assinatura eletrônica disponíveis no DocumentsCorePack.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obter fornecedores de assinatura eletrónica [DEPRECATED]

Recupere todos os provedores de assinatura eletrônica disponíveis no DocumentsCorePack.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obter impressora DCP [PRETERIDO]

Esta ação foi preterida. Em vez disso, use Obter impressoras .

Recuperar nomes de impressora disponíveis, opcionalmente filtrados pelo usuário

Parâmetros

Nome Chave Necessário Tipo Descrição
envId
envId True integer

Especificar ambiente

User
User string

Opcional, forneça o nome de domínio ou id dos utilizadores do Dynamics 365

Regressos

Obter impressoras

Recupere impressoras disponíveis.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

User
User string

Opcional, liste apenas as impressoras acessíveis a este utilizador.

Regressos

Obter impressoras [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter impressoras .

Recupere impressoras disponíveis.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

User
User string

Opcional, liste apenas as impressoras acessíveis a este utilizador.

Regressos

Obter modelos [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter modelos de documento .

Esta função retorna uma lista de modelos DocumentsCorePack disponíveis

Parâmetros

Nome Chave Necessário Tipo Descrição
EntityName
EntityName string

Filtrar por Entidade (etc ou etn). Curinga opcional [etn]

TemplateNameFilter
TemplateNameFilter string

Filtrar por nome de modelo. Curinga opcional [nome]

GroupFilter
GroupFilter string

Filtrar por nome de grupo. Curinga opcional [nome]

UserId
UserId string

Recuperar apenas modelos acessíveis a este utilizador

envId
envId integer

Especificar ambiente

Regressos

Obter modelos de documentos

Recupera uma lista de modelos DocumentsCorePack disponíveis.

Parâmetros

Nome Chave Necessário Tipo Descrição
Nome da tabela
EntityName string

Filtrar por Entidade (etc ou etn). Curinga opcional [etn]

Filtro de modelo
TemplateNameFilter string

Filtrar por nome de modelo. Curinga opcional [nome]

Filtro de Grupo
GroupFilter string

Filtrar por nome de grupo. Curinga opcional [nome]

User
UserId string

Recuperar apenas modelos acessíveis a este utilizador

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obter modelos de documentos [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Obter modelos de documento .

Recupera uma lista de modelos DocumentsCorePack disponíveis.

Parâmetros

Nome Chave Necessário Tipo Descrição
Nome da tabela
EntityName string

Filtrar por Entidade (etc ou etn). Curinga opcional [etn]

Filtro de modelo
TemplateNameFilter string

Filtrar por nome de modelo. Curinga opcional [nome]

Filtro de Grupo
GroupFilter string

Filtrar por nome de grupo. Curinga opcional [nome]

User
UserId string

Recuperar apenas modelos acessíveis a este utilizador

Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obter o estado do DocumentJob (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob para recuperar o status de.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obter o resultado do DocumentJob (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obter OneClickActions [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get One-Click-Actions .

Esta função devolve todas as OneClickActions em Dynamics 365

Parâmetros

Nome Chave Necessário Tipo Descrição
envId
envId True integer

Especificar ambiente

Regressos

Obter perfis para um UserAPIKey [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get Profiles for a User APIKey .

Esta função devolve todos os IDs de Perfis em Dynamics 365

Regressos

Obter perfis para um usuário APIKey

Recupera todas as IDs de perfil para esta ApiKey.

Regressos

Obter perfis para um usuário APIKey [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get Profiles for a User APIKey .

Recupera todas as IDs de perfil para esta ApiKey.

Regressos

Obter resultado do DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de DocumentJobs. O resultado incluirá o documento de resultado, se o trabalho for concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

DocumentJobId
DocumentJobId True uuid

Guid do DocumentJob Id para recuperar o resultado de

Regressos

Obter resultado do DocumentJob (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de um DocumentJob. O resultado incluirá o documento gerado.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obter resultado do DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, use o resultado do Get DocumentJob em vez disso.

Recupera informações de status de DocumentJobs. O resultado incluirá o documento de resultado, se o trabalho for concluído

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJobId
DocumentJobId True uuid

Identificador exclusivo do DocumentJob para recuperar o resultado de

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Regressos

Obter SignProviders [DEPRECATED]

Esta função retorna todos os SignProviders conhecidos na AutomergeSolution

Parâmetros

Nome Chave Necessário Tipo Descrição
envId
envId True integer

Especificar ambiente

Regressos

Obter status do DocumentJob (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob. Aplicam-se as regras state/statuscode do Dynamics 365

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

DocumentJobId
DocumentJobId True uuid

GUID do DocumentJob Id para recuperar o status de

Regressos

Obter status do DocumentJob (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob para recuperar o status de.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Obter status do DocumentJob [DEPRECATED]

Esta ação foi preterida. Por favor, utilize antes o estado Get DocumentJob .

Recupera o status de um DocumentJob. Aplicam-se as regras state/statuscode do Dynamics 365

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJobId
DocumentJobId True uuid

Identificador exclusivo do DocumentJob para recuperar o status de

DesativarOnTimeout
DeactivateOnTimeout boolean

Desativa o item de trabalho em um tempo limite, impedindo a geração de documentos

Regressos

Obter um-Click-Actions [DEPRECATED]

Esta ação foi preterida. Em vez disso, use Get One-Click-Actions .

Recupera todos osClick-Actions One- configurados em Dynamics 365.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o Ambiente para esta operação.

Regressos

Obtém o ambiente padrão para esta ApiKey

Retorna a id do ambiente para a ApiKey usada.

Regressos

Obtém o ambiente padrão para esta ApiKey [DEPRECATED]

Retorna a id do ambiente para a ApiKey usada.

Regressos

Imprimir documento gerado por um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob a imprimir.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
Copies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente.

Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Regressos

Imprimir documento gerado por um DocumentJob. A ação NÃO espera por um resultado.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob a imprimir.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
Copies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente.

Regressos

Esta ação foi preterida. Por favor, use Print DocumentJob em vez disso.

Imprimir documento gerado por um DocumentJob.

Parâmetros

Nome Chave Necessário Tipo Descrição
DocumentJob ID
DocumentJobId True uuid

Identificador exclusivo do DocumentJob a imprimir.

Impressora
DCPPrinterName True string

Escolha impressora.

Imprimir cópias
Copies integer

Número de cópias de documentos.

Meio Ambiente
Environment string

Escolha o ambiente.

Regressos

Processamento em lote na jornada do cliente (assíncrono)

Crie e processe documentos em lote para registros dentro de uma jornada do cliente. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
[Tabela]
EntitySchemaName True string

Escolha a tabela para executar este documento.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Template
Template True uuid

Escolha o modelo para este DocumentJob.

Viagem
Journey True uuid

Escolha a jornada do cliente para este DocumentJob.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

BatchDelay
BatchDelay integer

Intervalo entre processos documentais em horas.

BatchSize
BatchSize integer

Número de itens necessários para acionar o processamento de documentos.

Coluna Ordenar
SortField string

Especifique um valor de classificação para os registros no documento.

Direção da Ordenação
SortDirection integer

Ordenar a ordem das colunas.

Guardar localização
SaveLocationUri string

Defina um local de salvamento personalizado (Blob ou Sharepoint).

Impressora
DCPPrinterName string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Processamento em lote na jornada do cliente (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Process batch na customer journey (assíncrono) em vez disso.

Cria um novo documento. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
[Tabela]
EntitySchemaName True string

Escolha a tabela para executar este documento.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Template
Template True uuid

Escolha o modelo para este DocumentJob.

Viagem
Journey True uuid

Escolha a jornada do cliente para este DocumentJob.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

BatchDelay
BatchDelay integer

Intervalo entre processos documentais em horas.

BatchSize
BatchSize integer

Número de itens necessários para acionar o processamento de documentos.

Coluna Ordenar
SortField string

Especifique um valor de classificação para os registros no documento.

Direção da Ordenação
SortDirection integer

Ordenar a ordem das colunas.

Guardar localização
SaveLocationUri string

Defina um local de salvamento personalizado (Blob ou Sharepoint).

Impressora
DCPPrinterName string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Processamento em lote na jornada do cliente (sincronizado) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use o Process batch na jornada do cliente em vez disso.

Cria um novo documento. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
[Tabela]
EntitySchemaName True string

Escolha a tabela para executar este documento.

ID da Linha
EntityId True uuid

Identificador exclusivo do registro para o qual executar este modelo.

Template
Template True uuid

Escolha o modelo para este DocumentJob.

Viagem
Journey True uuid

Escolha a jornada do cliente para este DocumentJob.

Tipo de Arquivo:
FileType True string

Escolha o tipo de arquivo.

User
User string

Escolha o usuário para executar esta operação.

Guardar no SharePoint
SaveToSharepoint boolean

Guarde o documento no SharePoint.

BatchDelay
BatchDelay integer

Intervalo entre processos documentais em horas.

BatchSize
BatchSize integer

Número de itens necessários para acionar o processamento de documentos.

Coluna Ordenar
SortField string

Especifique um valor de classificação para os registros no documento.

Direção da Ordenação
SortDirection integer

Ordenar a ordem das colunas.

Guardar localização
SaveLocationUri string

Defina um local de salvamento personalizado (Blob ou Sharepoint).

Impressora
DCPPrinterName string

Escolha impressora.

Imprimir cópias
PrintCopies integer

Número de cópias de documentos.

Anexar a [ID da linha]
AttachToEntityId uuid

Identificador único do registo ao qual anexar este documento.

Anexar a [Tabela]
AttachToEntitySchemaName string

Escolha a tabela à qual anexar este documento.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Quem sou eu

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Body
WhoAmiV5

Run One-Click-Action

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Sincronização. Recordação
RequestSynchronousCallback boolean

Usa processamento síncrono quando aceitar/retentar depois não for suportado.

Regressos

Run One-Click-Action (assíncrono)

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Regressos

Run One-Click-Action (assíncrono) (V4) [OBSOLETO]

Esta ação foi preterida. Por favor, use Run One-Click-Action (assíncrono) em vez disso.

Executa uma ação de um clique. A ação NÃO espera por um resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Regressos

Run One-Click-Action (sincronizado) (V4) [DESCONTINUADO]

Executa um One-Click-Action e aguarda o resultado. Para mais informações

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True uuid

Identificador exclusivo do registro para executar o One-Click-Action for

Um IDClick-Action
OneClickAction True uuid

Identificador único do One-Click-Action a aplicar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

User
User string

Recuperar apenas umClick-Actions acessível a este usuário.

Regressos

Sign DocumentJob (sincronizado) (V4) [DESCONTINUADO]

Esta ação foi preterida. Por favor, use Sign DocumentJob em vez disso.

Envie um documento para assinatura eletrónica.

Parâmetros

Nome Chave Necessário Tipo Descrição
ID da Linha
EntityId True string

Identificador único do registo ao qual o registo eSign será anexado.

Nome da tabela
Schemaname True string

Nome da tabela do registo ao qual o registo eSign será anexado.

DocumentJob ID
DocumentJob True uuid

Identificador exclusivo do DocumentJob a assinar.

User
User string

Escolha o usuário para executar esta operação.

Provedor de assinatura
SignProvider True integer

Escolha o provedor de assinatura eletrônica.

Assunto padrão do e-mail
Subject string

Assunto padrão no e-mail de solicitação de assinatura.

Mensagem padrão de e-mail
Message string

Mensagem padrão no e-mail de solicitação de assinatura.

Nome
Name True string

O nome para exibição do signatário.

Email
Email True string

O endereço de e-mail do signatário.

Presencial
InPerson True boolean

Gera um link para iniciar o processo de assinatura.

Assunto
Subject string

Assunto personalizado na assinatura de e-mail de solicitação.

Message
Message string

Mensagem personalizada no e-mail de solicitação de assinatura.

Número de telefone
TelNr string

Número de telefone dos signatários para autenticação por SMS (somente DocuSign).

Nome do host DocuSign
HostName string

Nome dos hosts de assinatura para assinatura inPerson (somente DocuSign).

E-mail do anfitrião
Hostemail string

A assinatura hospeda o endereço de e-mail para assinatura inPerson (somente DocuSign).

Código de Acesso
AccessCode string

A confirmar.

HasAccessCode
HasAccessCode boolean

A confirmar.

OTP
OTP string

A confirmar.

HasSMSAuth
HasSMSAuth boolean

A confirmar.

Nome
Name string

A confirmar.

Utilizações
Uses string

A confirmar.

Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Verifique a disponibilidade da API [DEPRECATED]

Esta ação foi preterida. Por favor, utilize antes a opção Verificar Disponibilidade da API .

Verifica se o ponto de extremidade da API está acessível no momento. Não requer chave de API

Regressos

WhoAmEu [DEPRECIADO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Retorna informações sobre a chave de API usada atualmente e o serviço associado

Regressos

Body
WhoAmi

WhoAmI (V2) [PRETERIDO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Retorna informações sobre a chave de API usada atualmente e o serviço associado

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment True integer

Especifica a conexão a ser usada para uma APIKey por usuário

Regressos

Body
WhoAmi

WhoAmI (V3) [PRETERIDO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Body
WhoAmi

WhoAmI (V4) [DEPRECIADO]

Esta ação foi preterida. Por favor, use Quem sou eu em vez disso.

Recupere informações sobre a chave de API usada e o serviço DocumentsCorePack associado.

Parâmetros

Nome Chave Necessário Tipo Descrição
Meio Ambiente
Environment string

Escolha o ambiente para esta operação.

Regressos

Body
WhoAmi

Definições

DocumentJobStatusResponse

Nome Percurso Tipo Descrição
Sucesso
Success boolean
Valor de retorno
Return value string
Valor de retorno 2
Return value 2 string
DocumentJobId
DocumentJobId string

JSONCreateNoteResponse

Nome Percurso Tipo Descrição
AnnotationID
annotationid string
Sucesso
Success boolean
Valor de retorno
Return value string
Valor de retorno 2
Return value 2 string

DocumentJobResponse

Nome Percurso Tipo Descrição
Nome do ficheiro
File name string
Tamanho do ficheiro
File size integer
Documento (codificado em Base64)
Document (Base64 encoded) string
Mime-Type
Mime-Type string
ID de registro temporário
Temporary Record Id string
Sucesso
Success boolean
Valor de retorno
Return value string
Valor de retorno 2
Return value 2 string
DocumentJobId
DocumentJobId string

DocumentJobResponseV2

Nome Percurso Tipo Descrição
Nome do ficheiro
File name string
Tamanho do ficheiro
File size integer
Conteúdo do documento
Document content byte
Mime-Type
Mime-Type string
ID de registro temporário
Temporary Record Id string
Sucesso
Success boolean
Valor de retorno
Return value string
Valor de retorno 2
Return value 2 string
DocumentJobId
DocumentJobId string

JSONDCPTemplate

Nome Percurso Tipo Descrição
ptm_mscrmaddons_dcptemplatesid
ptm_mscrmaddons_dcptemplatesid string
ptm_name
ptm_name string
ptm_entitytype
ptm_entitytype string

JSONEnvironment

Nome Percurso Tipo Descrição
NomeDoAmbiente
EnvironmentName string
Identificação do ambiente
EnvironmentId integer

JSONEnvironmentV3

Nome Percurso Tipo Descrição
NomeDoAmbiente
EnvironmentName string
Identificação do ambiente
EnvironmentId string

JSONOneClickAction

Nome Percurso Tipo Descrição
Nome de Exibição
DisplayName string
OcaID
OcaID uuid
@odata.etag
@odata.etag string
ptm_entity
ptm_entity string
ptm_position
ptm_position integer
_owningbusinessunit_value
_owningbusinessunit_value string
ptm_mscrmaddonscomoneclickactionid
ptm_mscrmaddonscomoneclickactionid string
ptm_name
ptm_name string
código de estado
statecode integer
código de estado
statuscode integer
_createdby_value
_createdby_value string
ptm_oca
ptm_oca string
_ownerid_value
_ownerid_value string
modificado em
modifiedon date-time
_owninguser_value
_owninguser_value string
_modifiedby_value
_modifiedby_value string
número da versão
versionnumber integer
criado em
createdon date-time
_ptm_groupid_value
_ptm_groupid_value string

JSONPrinterResponse

Nome Percurso Tipo Descrição
DCPPrinterName
DCPPrinterName string

JSONSignProvider

Nome Percurso Tipo Descrição
SignProviderName
SignProviderName string
OptionValue
OptionValue integer

Mensagem de usuário

Nome Percurso Tipo Descrição
Message
Message string

WhoAmi

Nome Percurso Tipo Descrição
ApiKey
ApiKey string
ApiProprietário
ApiOwner string
Meio Ambiente
Environment integer

WhoAmiV5

Nome Percurso Tipo Descrição
ApiKey
ApiKey string
ApiProprietário
ApiOwner string
Meio Ambiente
Environment integer
ServiceAlive
ServiceAlive boolean
ApiVersion
ApiVersion string