Adobe Acrobat Sign Sandbox
Adobe è il servizio di accesso al documento digitale più attendibile al mondo. Con Adobe Acrobat Sign, è possibile trasformare i processi manuali in esperienze digitali complete. Incorporare le funzionalità di Adobe Acrobat Sign nelle applicazioni preferite per creare, inviare e monitorare lo stato dei contratti.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Normale | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Normale | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Normale | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Supporto per Adobe Acrobat Sign |
| URL | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
| support@echosign.zendesk.com |
| Metadati del connettore | |
|---|---|
| Editore | Adobe Inc. |
| Sito web | https://acrobat.adobe.com/us/en/sign.html |
| Informativa sulla privacy | https://www.adobe.com/privacy/policy.html |
| Categorie | Sito web |
Adobe Acrobat Sign Sandbox
Adobe Acrobat Sign Sandbox è un account di livello enterprise modificato in un ambiente discreto dall'ambiente di produzione. Lo scopo della sandbox è consentire agli amministratori di testare le configurazioni delle impostazioni, le chiamate API, i modelli di libreria, i flussi di lavoro personalizzati e le nuove funzionalità che si avvicinano al rilascio.
Editore: Adobe, Inc.
Prerequisiti
È necessario l'account Adobe Acrobat Sign.
Come ottenere le credenziali
N/A
Introduzione al connettore
N/A
Problemi noti e limitazioni
N/A
Errori e rimedi comuni
N/A
Domande frequenti
Guida per l'utente del connettore https://helpx.adobe.com/sign/using/adobesign-sandbox.html
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 250 | 60 secondi |
Azioni
| Annullare un contratto |
Annulla il contratto identificato da agreementId nel percorso. |
| Caricare un documento e ottenere un ID documento |
Questa operazione carica un documento nell'account Adobe Acrobat Sign e restituisce un ID documento. Questo documento viene archiviato temporaneamente in Adobe Acrobat Sign e l'ID documento può essere usato per ulteriori operazioni come la creazione di un contratto. |
| Caricare un documento e ottenere un ID documento (precedente) [DEPRECATO] |
Questa operazione carica un documento nell'account Adobe Acrobat Sign e restituisce un ID documento. Questo documento viene archiviato temporaneamente in Adobe Acrobat Sign e l'ID documento può essere usato per ulteriori operazioni come la creazione di un contratto. |
| Creare un contratto da un contenuto di file e inviare per la firma |
Questa operazione crea un contratto da un file in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un contratto da un documento caricato e inviare la firma (precedente) [DEPRECATO] |
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un contratto da un documento caricato e inviare per la firma |
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un contratto da un flusso di lavoro e inviare per la firma |
Questa operazione crea un contratto da un flusso di lavoro in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un contratto da un modello di libreria e inviare la firma (precedente) [DEPRECATO] |
Questa operazione crea un contratto da un modello archiviato nella libreria Adobe Acrobat Sign dell'utente e lo invia per la firma. |
| Creare un contratto da un modello di libreria e inviarlo per la firma |
Questa operazione crea un contratto da un modello archiviato nella libreria Adobe Acrobat Sign dell'utente e lo invia per la firma. |
| Creare un contratto da un URL del documento e inviare la firma (precedente) [DEPRECATO] |
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un contratto da un URL del documento e inviarlo per la firma |
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma. |
| Creare un modello di raccolta da un documento caricato |
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un documento caricato. Usare questo modello per l'invio di contratti. |
| Creare un modello di raccolta da un documento caricato (precedente) [DEPRECATO] |
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un documento caricato. Usare questo modello per l'invio di contratti. |
| Creare un modello di raccolta da un URL del documento |
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un URL di documento. Usare questo modello per l'invio di contratti |
| Creare un modello di raccolta da un URL del documento (precedente) [DEPRECATO] |
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un URL di documento. Usare questo modello per l'invio di contratti |
| Ottenere i dati dei campi modulo del contratto (precedente) [DEPRECATO] |
Recupera i dati immessi nei campi del modulo interattivo del contratto. |
| Ottenere i dati del campo modulo del contratto in formato CSV |
Recupera i dati immessi nei campi del modulo interattivo del contratto. |
| Ottenere i dati del campo modulo del contratto in formato JSON |
Recupera i dati immessi nei campi del modulo interattivo del contratto. |
| Ottenere le informazioni dettagliate del flusso di lavoro |
Questa operazione recupera informazioni dettagliate sul flusso di lavoro. |
| Ottenere lo stato di un contratto |
Questa operazione recupera tutte le informazioni correnti di un contratto, ad esempio lo stato. |
| Ottenere lo stato di un contratto [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Ottieni lo stato di un contratto .
|
| Ottenere un documento da un contratto |
Questa operazione recupera il flusso di file di un documento specifico dell'accordo. |
| Ottenere un documento da un contratto [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Ottieni un documento da un contratto .
|
| Ottenere un elenco di tutti gli ID documento da un contratto |
Questa operazione recupera gli ID di tutti i documenti e i documenti di supporto di un contratto. |
| Ottenere un elenco di tutti gli ID documento da un contratto [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Get a list of all the document ID from an agreement (Ottieni un elenco di tutti gli ID documento da un contratto ).
|
| Ottenere un elenco di tutti i contratti |
Questa operazione recupera l'elenco di tutti i contratti dell'utente. |
| Ottenere un elenco di tutti i contratti (old) [DEPRECATO] |
Questa operazione recupera l'elenco di tutti i contratti dell'utente. |
| Ottenere un elenco di tutti i contratti in base ai criteri di ricerca |
Questa operazione cerca i contratti in base a criteri quali ID flusso di lavoro e così via. |
| Ottenere un elenco di tutti i flussi di lavoro |
Questa operazione recupera l'elenco di tutti i flussi di lavoro dell'utente. |
| Ottenere un elenco di tutti i gruppi a cui appartiene l'utente |
Questa operazione recupera l'elenco di tutti i gruppi a cui appartiene l'utente. |
| Ottenere un elenco di tutti i modelli di libreria |
Questa operazione recupera l'elenco di tutti i documenti archiviati come modelli nella raccolta Adobe Acrobat Sign dell'utente. |
| Ottenere un elenco di tutti i modelli di libreria (precedente) [DEPRECATO] |
Questa operazione recupera l'elenco di tutti i documenti archiviati come modelli nella raccolta Adobe Acrobat Sign dell'utente. |
| Ottenere un elenco di tutti i web form |
Questa operazione recupera l'elenco di tutti i web form dell'utente. |
| Ottenere un PDF dell'audit trail del contratto |
Questa operazione recupera il flusso di file PDF del audit trail dell'accordo. Si noti che il flusso di file deve essere archiviato con un nome file che termina con .pdf estensione di file. |
| Ottenere un PDF di un contratto firmato |
Questa operazione recupera il flusso di file PDF del contratto combinato o firmato. Si noti che il flusso di file deve essere archiviato con un nome file che termina con .pdf estensione di file. |
| Ottenere un PDF di un contratto firmato [DEPRECATO] |
Questa azione è stata deprecata. Usare invece Get a PDF of a signed agreement (Ottieni un PDF di un contratto firmato ).
|
| Recuperare l'URL di firma |
Questa operazione recupera l'URL della pagina di firma elettronica per i firmatari correnti di un contratto. |
Annullare un contratto
Annulla il contratto identificato da agreementId nel percorso.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto che deve essere annullato. |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Stato di agrement
|
state | string |
Lo stato in cui l'accordo dovrebbe atterrare. |
|
|
Comment
|
comment | string |
Commento facoltativo che descrive il motivo dell'annullamento ai destinatari. |
|
|
Altri
|
notifyOthers | boolean |
Indica se si desidera che i destinatari vengano informati. |
Caricare un documento e ottenere un ID documento
Questa operazione carica un documento nell'account Adobe Acrobat Sign e restituisce un ID documento. Questo documento viene archiviato temporaneamente in Adobe Acrobat Sign e l'ID documento può essere usato per ulteriori operazioni come la creazione di un contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome del file
|
File-Name | True | string |
Nome del documento da caricare, con estensione |
|
Contenuto del file
|
File | True | contentOnly |
Flusso di file del documento da caricare |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
JSON che contiene l'ID del documento caricato
Caricare un documento e ottenere un ID documento (precedente) [DEPRECATO]
Questa operazione carica un documento nell'account Adobe Acrobat Sign e restituisce un ID documento. Questo documento viene archiviato temporaneamente in Adobe Acrobat Sign e l'ID documento può essere usato per ulteriori operazioni come la creazione di un contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome del file
|
File-Name | True | string |
Nome del documento da caricare, con estensione |
|
Contenuto del file
|
File | True | contentOnly |
Flusso di file del documento da caricare |
Restituisce
JSON che contiene l'ID del documento caricato
Creare un contratto da un contenuto di file e inviare per la firma
Questa operazione crea un contratto da un file in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
Nome
|
fileName | True | string |
Nome del documento da caricare, con estensione |
|
Content
|
formData | True | byte |
Flusso di file del documento da caricare |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere- firma elettronica o scritta |
|
Messaggio di posta elettronica del partecipante
|
True | string |
Messaggio di posta elettronica del partecipante |
|
|
Authentication
|
authenticationMethod | string |
Autenticazione predefinita: posta elettronica (Nessuno) |
|
|
Parola chiave
|
password | string |
Password necessaria per il partecipante |
|
|
Codice paese
|
countryCode | string |
Codice paese di telefono del destinatario necessario per visualizzare e firmare il documento |
|
|
Telefono No.
|
phone | string |
Numero di telefono del destinatario necessario per visualizzare e firmare il contratto |
|
|
Ordinamento
|
order | True | integer |
Indice a partire da 1, che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | True | string |
I ruoli correnti del set di partecipanti (firmatario, responsabile approvazione e così via). |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Email
|
string |
Il messaggio di posta elettronica del CC del contratto |
||
|
Scadenza
|
expirationTime | string |
Ora successiva alla scadenza del Contratto. Esempio: 2020-12-31T23:59:00Z |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
Nome
|
fieldName | string |
Nome del campo |
|
|
Value
|
defaultValue | string |
Valore predefinito del campo |
|
|
Ritardo reindirizzamento
|
redirectDelay | string |
Ritardo (in secondi) prima che l'utente venga portato alla pagina di esito positivo. |
|
|
URL di reindirizzamento
|
redirectUrl | string |
URL da reindirizzare dopo aver completato il processo di firma, ad esempio https://adobe.com |
|
|
Messaggi di posta elettronica iniziali
|
initEmails | string |
Controllare i messaggi di notifica per gli eventi di avvio dell'accordo. |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un documento caricato e inviare la firma (precedente) [DEPRECATO]
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
ID documento
|
transientDocumentId | True | string |
ID documento ricevuto caricando un documento |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere - Firma E o Scritto |
|
Messaggio di posta elettronica destinatario
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Giorni alla scadenza
|
daysUntilSigningDeadline | integer |
Numero di giorni che rimangono prima della scadenza del documento |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
ID documento (2)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (3)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (4)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (5)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (6)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (7)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (8)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (9)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (10)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
Posta elettronica destinatario (2)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (2)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (2)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (3)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (3)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (3)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (4)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (4)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (4)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (5)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (5)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (5)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (6)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (6)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (6)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (7)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (7)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (7)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (8)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (8)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (8)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (9)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (9)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (9)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (10)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (10)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (10)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (11)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (11)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (11)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (12)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (12)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (12)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (13)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (13)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (13)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (14)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (14)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (14)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (15)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (15)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (15)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (16)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (16)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (16)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (17)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (17)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (17)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (18)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (18)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (18)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (19)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (19)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (19)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (20)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (20)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (20)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (21)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (21)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (21)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (22)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (22)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (22)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (23)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (23)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (23)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (24)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (24)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (24)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (25)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (25)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (25)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Nome campo modulo (1)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (1)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (2)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (2)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (3)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (3)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (4)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (4)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (5)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (5)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (6)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (6)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (7)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (7)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (8)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (8)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (9)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (9)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (10)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (10)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (11)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (11)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (12)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (12)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (13)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (13)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (14)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (14)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (15)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (15)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (16)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (16)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (17)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (17)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (18)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (18)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (19)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (19)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (20)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (20)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (21)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (21)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (22)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (22)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (23)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (23)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (24)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (24)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (25)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (25)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (26)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (26)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (27)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (27)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (28)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (28)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (29)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (29)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (30)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (30)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (31)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (31)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (32)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (32)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (33)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (33)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (34)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (34)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (35)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (35)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (36)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (36)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (37)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (37)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (38)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (38)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (39)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (39)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (40)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (40)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (41)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (41)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (42)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (42)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (43)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (43)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (44)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (44)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (45)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (45)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (46)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (46)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (47)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (47)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (48)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (48)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (49)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (49)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (50)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (50)
|
defaultValue | string |
Valore predefinito del campo |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un documento caricato e inviare per la firma
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
Documento d'identità
|
transientDocumentId | True | string |
ID documento ricevuto caricando un documento temporaneo |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere- firma elettronica o scritta |
|
Messaggio di posta elettronica del partecipante
|
True | string |
Messaggio di posta elettronica del partecipante |
|
|
Authentication
|
authenticationMethod | string |
Autenticazione predefinita: posta elettronica (Nessuno) |
|
|
Parola chiave
|
password | string |
Password necessaria per il partecipante |
|
|
Codice paese
|
countryCode | string |
Codice paese di telefono del destinatario necessario per visualizzare e firmare il documento |
|
|
Telefono No.
|
phone | string |
Numero di telefono del destinatario necessario per visualizzare e firmare il contratto |
|
|
Ordinamento
|
order | True | integer |
Indice a partire da 1, che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | True | string |
I ruoli correnti del set di partecipanti (firmatario, responsabile approvazione e così via). |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Email
|
string |
Il messaggio di posta elettronica del CC del contratto |
||
|
Scadenza
|
expirationTime | string |
Ora successiva alla scadenza del Contratto. Esempio: 2020-12-31T23:59:00Z |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
Nome
|
fieldName | string |
Nome del campo |
|
|
Value
|
defaultValue | string |
Valore predefinito del campo |
|
|
Ritardo reindirizzamento
|
redirectDelay | string |
Ritardo (in secondi) prima che l'utente venga portato alla pagina di esito positivo. |
|
|
URL di reindirizzamento
|
redirectUrl | string |
URL da reindirizzare dopo aver completato il processo di firma, ad esempio https://adobe.com |
|
|
Messaggi di posta elettronica iniziali
|
initEmails | string |
Controllare i messaggi di notifica per gli eventi di avvio dell'accordo. |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un flusso di lavoro e inviare per la firma
Questa operazione crea un contratto da un flusso di lavoro in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | True | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
Nome gruppo/ID
|
groupId | True | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
Nome/ID flusso di lavoro
|
workflowIdParam | True | string |
Selezionare il flusso di lavoro personalizzato dall'elenco o immettere l'ID del flusso di lavoro personalizzato. |
|
agreementWorkflowSchema
|
agreementWorkflowSchema | True | dynamic |
Dettagli per l'evento selezionato. |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un modello di libreria e inviare la firma (precedente) [DEPRECATO]
Questa operazione crea un contratto da un modello archiviato nella libreria Adobe Acrobat Sign dell'utente e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
Modello raccolta documenti
|
libraryDocumentId | True | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere - Firma E o Scritto |
|
Messaggio di posta elettronica destinatario
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Giorni alla scadenza
|
daysUntilSigningDeadline | integer |
Numero di giorni che rimangono prima della scadenza del documento |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
Modello raccolta documenti (2)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (3)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (4)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (5)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (6)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (7)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (8)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (9)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Modello raccolta documenti (10)
|
libraryDocumentId | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
|
Posta elettronica destinatario (2)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (2)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (2)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (3)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (3)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (3)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (4)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (4)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (4)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (5)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (5)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (5)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (6)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (6)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (6)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (7)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (7)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (7)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (8)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (8)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (8)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (9)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (9)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (9)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (10)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (10)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (10)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (11)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (11)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (11)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (12)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (12)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (12)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (13)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (13)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (13)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (14)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (14)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (14)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (15)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (15)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (15)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (16)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (16)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (16)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (17)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (17)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (17)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (18)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (18)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (18)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (19)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (19)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (19)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (20)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (20)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (20)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (21)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (21)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (21)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (22)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (22)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (22)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (23)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (23)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (23)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (24)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (24)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (24)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (25)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (25)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (25)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Nome campo modulo (1)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (1)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (2)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (2)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (3)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (3)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (4)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (4)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (5)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (5)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (6)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (6)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (7)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (7)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (8)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (8)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (9)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (9)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (10)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (10)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (11)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (11)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (12)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (12)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (13)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (13)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (14)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (14)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (15)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (15)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (16)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (16)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (17)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (17)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (18)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (18)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (19)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (19)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (20)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (20)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (21)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (21)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (22)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (22)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (23)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (23)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (24)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (24)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (25)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (25)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (26)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (26)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (27)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (27)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (28)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (28)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (29)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (29)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (30)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (30)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (31)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (31)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (32)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (32)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (33)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (33)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (34)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (34)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (35)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (35)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (36)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (36)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (37)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (37)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (38)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (38)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (39)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (39)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (40)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (40)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (41)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (41)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (42)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (42)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (43)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (43)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (44)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (44)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (45)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (45)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (46)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (46)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (47)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (47)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (48)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (48)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (49)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (49)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (50)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (50)
|
defaultValue | string |
Valore predefinito del campo |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un modello di libreria e inviarlo per la firma
Questa operazione crea un contratto da un modello archiviato nella libreria Adobe Acrobat Sign dell'utente e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
Template
|
libraryDocumentId | True | string |
Scegliere un documento dai modelli archiviati nella raccolta |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere- firma elettronica o scritta |
|
Messaggio di posta elettronica del partecipante
|
True | string |
Messaggio di posta elettronica del partecipante |
|
|
Authentication
|
authenticationMethod | string |
Autenticazione predefinita: posta elettronica (Nessuno) |
|
|
Parola chiave
|
password | string |
Password necessaria per il partecipante |
|
|
Codice paese
|
countryCode | string |
Codice paese di telefono del destinatario necessario per visualizzare e firmare il documento |
|
|
Telefono No.
|
phone | string |
Numero di telefono del destinatario necessario per visualizzare e firmare il contratto |
|
|
Ordinamento
|
order | True | integer |
Indice a partire da 1, che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | True | string |
I ruoli correnti del set di partecipanti (firmatario, responsabile approvazione e così via). |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Email
|
string |
Il messaggio di posta elettronica del CC del contratto |
||
|
Scadenza
|
expirationTime | string |
Ora successiva alla scadenza del Contratto. Esempio: 2020-12-31T23:59:00Z |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
Nome
|
fieldName | string |
Nome del campo |
|
|
Value
|
defaultValue | string |
Valore predefinito del campo |
|
|
Ritardo reindirizzamento
|
redirectDelay | string |
Ritardo (in secondi) prima che l'utente venga portato alla pagina di esito positivo. |
|
|
URL di reindirizzamento
|
redirectUrl | string |
URL da reindirizzare dopo aver completato il processo di firma, ad esempio https://adobe.com |
|
|
Messaggi di posta elettronica iniziali
|
initEmails | string |
Controllare i messaggi di notifica per gli eventi di avvio dell'accordo. |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un URL del documento e inviare la firma (precedente) [DEPRECATO]
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
URL
|
url | True | string |
URL accessibile pubblicamente per il recupero del documento |
|
Nome
|
name | True | string |
Nome del documento a cui si fa riferimento, con estensione |
|
Tipo di firma
|
signatureType | True | string |
Tipo di firma da richiedere - Firma E o Scritto |
|
Messaggio di posta elettronica destinatario
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Giorni alla scadenza
|
daysUntilSigningDeadline | integer |
Numero di giorni che rimangono prima della scadenza del documento |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
URL (2)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (2)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (3)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (3)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (4)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (4)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (5)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (5)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (6)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (6)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (7)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (7)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (8)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (8)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (9)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (9)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (10)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (10)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
Posta elettronica destinatario (2)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (2)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (2)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (3)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (3)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (3)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (4)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (4)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (4)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (5)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (5)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (5)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (6)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (6)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (6)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (7)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (7)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (7)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (8)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (8)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (8)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (9)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (9)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (9)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (10)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (10)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (10)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (11)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (11)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (11)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (12)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (12)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (12)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (13)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (13)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (13)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (14)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (14)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (14)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (15)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (15)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (15)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (16)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (16)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (16)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (17)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (17)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (17)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (18)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (18)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (18)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (19)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (19)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (19)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (20)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (20)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (20)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Messaggio di posta elettronica destinatario (21)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (21)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (21)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (22)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (22)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (22)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (23)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (23)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (23)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (24)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma destinatario (24)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (24)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Posta elettronica destinatario (25)
|
True | string |
Indirizzo di posta elettronica del destinatario |
|
|
Ordine di firma del destinatario (25)
|
signingOrder | True | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Ruolo destinatario (25)
|
recipientSetRole | True | string |
Specificare il ruolo del destinatario |
|
Nome campo modulo (1)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (1)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (2)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (2)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (3)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (3)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (4)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (4)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (5)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (5)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (6)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (6)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (7)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (7)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (8)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (8)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (9)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (9)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (10)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (10)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (11)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (11)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (12)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (12)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (13)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (13)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (14)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (14)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (15)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (15)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (16)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (16)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (17)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (17)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (18)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (18)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (19)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (19)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (20)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (20)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (21)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (21)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (22)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (22)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (23)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (23)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (24)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (24)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (25)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (25)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (26)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (26)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (27)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (27)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (28)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (28)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (29)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (29)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (30)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (30)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (31)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (31)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (32)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (32)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (33)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (33)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (34)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (34)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (35)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (35)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (36)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (36)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (37)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (37)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (38)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (38)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (39)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (39)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (40)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (40)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (41)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (41)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (42)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (42)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (43)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (43)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (44)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (44)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (45)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (45)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (46)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (46)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (47)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (47)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (48)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (48)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (49)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (49)
|
defaultValue | string |
Valore predefinito del campo |
|
|
Nome campo modulo (50)
|
fieldName | string |
Nome del campo |
|
|
Valore campo modulo (50)
|
defaultValue | string |
Valore predefinito del campo |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un contratto da un URL del documento e inviarlo per la firma
Questa operazione crea un contratto da un documento caricato in Adobe Acrobat Sign e lo invia per la firma.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome contratto
|
name | True | string |
Nome del contratto |
|
URL
|
url | True | string |
URL accessibile pubblicamente per il recupero del contenuto del file non elaborato |
|
Nome
|
name | True | string |
Nome file di sistema originale del documento inviato |
|
TIPO
|
mimeType | True | string |
Tipo mime del file a cui si fa riferimento, ad esempio application/pdf |
|
Tipo di firma
|
signatureType | True | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
Messaggio di posta elettronica del partecipante
|
True | string |
Messaggio di posta elettronica del partecipante |
|
|
Authentication
|
authenticationMethod | string |
Autenticazione predefinita: posta elettronica (Nessuno) |
|
|
Parola chiave
|
password | string |
Password necessaria per il partecipante |
|
|
Codice paese
|
countryCode | string |
Codice paese di telefono del destinatario necessario per visualizzare e firmare il documento |
|
|
Telefono No.
|
phone | string |
Numero di telefono del destinatario necessario per visualizzare e firmare il contratto |
|
|
Ordinamento
|
order | True | integer |
Indice a partire da 1, che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | True | string |
I ruoli correnti del set di partecipanti (firmatario, responsabile approvazione e così via). |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
|
Message
|
message | string |
Messaggio facoltativo per i destinatari che richiedono l'azione |
|
|
Email
|
string |
Il messaggio di posta elettronica del CC del contratto |
||
|
Scadenza
|
expirationTime | string |
Ora successiva alla scadenza del Contratto. Esempio: 2020-12-31T23:59:00Z |
|
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
|
Password documento
|
openPassword | string |
Password che deve essere usata per crittografare il pdf dell'accordo firmato |
|
|
Nome
|
fieldName | string |
Nome del campo |
|
|
Value
|
defaultValue | string |
Valore predefinito del campo |
|
|
Ritardo reindirizzamento
|
redirectDelay | string |
Ritardo (in secondi) prima che l'utente venga portato alla pagina di esito positivo. |
|
|
URL di reindirizzamento
|
redirectUrl | string |
URL da reindirizzare dopo aver completato il processo di firma, ad esempio https://adobe.com |
|
|
Messaggi di posta elettronica iniziali
|
initEmails | string |
Controllare i messaggi di notifica per gli eventi di avvio dell'accordo. |
Restituisce
JSON che contiene l'ID del contratto appena creato
Creare un modello di raccolta da un documento caricato
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un documento caricato. Usare questo modello per l'invio di contratti.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome modello
|
name | True | string |
Nome contratto usato per identificare il modello |
|
Tipo di modello
|
templateTypes | True | array of string |
Elenco di uno o più tipi di modello di libreria |
|
Modalità condivisione
|
sharingMode | True | string |
Specifica chi deve avere accesso a questo documento della raccolta |
|
Documento d'identità
|
transientDocumentId | True | string |
ID documento ricevuto caricando un documento temporaneo |
|
Stato modello
|
state | True | string |
Stato del documento della raccolta. |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
Oggetto JSON che descrive il modello di libreria
Creare un modello di raccolta da un documento caricato (precedente) [DEPRECATO]
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un documento caricato. Usare questo modello per l'invio di contratti.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome modello
|
name | True | string |
Nome contratto usato per identificare il modello |
|
Tipo di modello
|
libraryTemplateTypes | True | string |
Elenco di uno o più tipi di modello di libreria |
|
Condividi con
|
librarySharingMode | True | string |
Specifica chi deve avere accesso a questo documento della raccolta |
|
ID documento
|
transientDocumentId | True | string |
ID documento ricevuto caricando un documento |
|
ID documento (2)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (3)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (4)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (5)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (6)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (7)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (8)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (9)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
|
|
ID documento (10)
|
transientDocumentId | string |
ID documento ricevuto caricando un documento |
Restituisce
Oggetto JSON che descrive il modello di libreria
Creare un modello di raccolta da un URL del documento
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un URL di documento. Usare questo modello per l'invio di contratti
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome modello
|
name | True | string |
Nome contratto usato per identificare il modello |
|
Tipo di modello
|
templateTypes | True | array of string |
Elenco di uno o più tipi di modello di libreria |
|
Modalità condivisione
|
sharingMode | True | string |
Specifica chi deve avere accesso a questo documento della raccolta |
|
URL
|
url | True | string |
URL accessibile pubblicamente per il recupero del contenuto del file non elaborato |
|
Nome
|
name | True | string |
Nome file di sistema originale del documento inviato |
|
TIPO
|
mimeType | True | string |
Tipo mime del file a cui si fa riferimento, ad esempio application/pdf |
|
Stato modello
|
state | True | string |
Stato del documento della raccolta. |
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
Oggetto JSON che descrive il modello di libreria
Creare un modello di raccolta da un URL del documento (precedente) [DEPRECATO]
Questa operazione crea un modello nella raccolta di Adobe Acrobat Sign da un URL di documento. Usare questo modello per l'invio di contratti
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome modello
|
name | True | string |
Nome contratto usato per identificare il modello |
|
Tipo di modello
|
libraryTemplateTypes | True | string |
Elenco di uno o più tipi di modello di libreria |
|
Condividi con
|
librarySharingMode | True | string |
Specifica chi deve avere accesso a questo documento della raccolta |
|
URL
|
url | True | string |
URL accessibile pubblicamente per il recupero del documento |
|
Nome
|
name | True | string |
Nome del documento a cui si fa riferimento, con estensione |
|
URL (2)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (2)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (3)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (3)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (4)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (4)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (5)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (5)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (6)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (6)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (7)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (7)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (8)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (8)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (9)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (9)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
|
|
URL (10)
|
url | string |
URL accessibile pubblicamente per il recupero del documento |
|
|
Nome (10)
|
name | string |
Nome del documento a cui si fa riferimento, con estensione |
Restituisce
Oggetto JSON che descrive il modello di libreria
Ottenere i dati dei campi modulo del contratto (precedente) [DEPRECATO]
Recupera i dati immessi nei campi del modulo interattivo del contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
Restituisce
- response
- file
Ottenere i dati del campo modulo del contratto in formato CSV
Recupera i dati immessi nei campi del modulo interattivo del contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
Contenuto dei dati del modulo
- Contenuto dati modulo
- binary
Ottenere i dati del campo modulo del contratto in formato JSON
Recupera i dati immessi nei campi del modulo interattivo del contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
Contenuto dei dati del modulo
- Contenuto dati modulo
- object
Ottenere le informazioni dettagliate del flusso di lavoro
Questa operazione recupera informazioni dettagliate sul flusso di lavoro.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID flusso di lavoro
|
workflowId | True | string |
ID flusso di lavoro del flusso di lavoro le cui informazioni sono necessarie |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
JSON che contiene informazioni dettagliate sul flusso di lavoro
- Corpo
- WorkflowDescriptionV6
Ottenere lo stato di un contratto
Questa operazione recupera tutte le informazioni correnti di un contratto, ad esempio lo stato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
Dettagli del contratto completo
- Corpo
- AgreementInfoV6
Ottenere lo stato di un contratto [DEPRECATO]
Questa azione è stata deprecata. Usare invece Ottieni lo stato di un contratto .
Questa operazione recupera tutte le informazioni correnti di un contratto, ad esempio lo stato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
Restituisce
Dettagli completi sul contratto
- Corpo
- AgreementInfo
Ottenere un documento da un contratto
Questa operazione recupera il flusso di file di un documento specifico dell'accordo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto il cui documento è necessario |
|
ID documento
|
documentId | True | string |
ID documento del documento specifico del contratto |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
Flusso di file del documento
- response
- DocumentResponse
Ottenere un documento da un contratto [DEPRECATO]
Questa azione è stata deprecata. Usare invece Ottieni un documento da un contratto .
Questa operazione recupera il flusso di file di un documento specifico dell'accordo.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto il cui documento è necessario |
|
ID documento
|
documentId | True | string |
ID documento del documento specifico del contratto |
Restituisce
Flusso di file del documento
- response
- DocumentResponse
Ottenere un elenco di tutti gli ID documento da un contratto
Questa operazione recupera gli ID di tutti i documenti e i documenti di supporto di un contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID dell'accordo i cui documenti sono necessari |
|
Documenti di supporto - Tipo di contenuto
|
supportingDocumentContentFormat | string |
Tipo di contenuto dei documenti di supporto dell'accordo |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
JSON che contiene sia i documenti che gli oggetti matrice di documenti di supporto
- Corpo
- AgreementDocumentsV6
Ottenere un elenco di tutti gli ID documento da un contratto [DEPRECATO]
Questa azione è stata deprecata. Usare invece Get a list of all the document ID from an agreement (Ottieni un elenco di tutti gli ID documento da un contratto ).
Questa operazione recupera gli ID di tutti i documenti e i documenti di supporto di un contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID dell'accordo i cui documenti sono necessari |
|
Documenti di supporto - Tipo di contenuto
|
supportingDocumentContentFormat | string |
Tipo di contenuto dei documenti di supporto dell'accordo |
Restituisce
JSON che contiene sia i documenti che gli oggetti matrice di documenti di supporto
- Corpo
- AgreementDocuments
Ottenere un elenco di tutti i contratti
Questa operazione recupera l'elenco di tutti i contratti dell'utente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Consente di spostarsi tra le pagine. Se non specificato, restituisce la prima pagina. |
|
|
Dimensioni pagina
|
pageSize | integer |
Numero di elementi nella pagina di risposta. Per impostazione predefinita: 100; Max: 10000 |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
JSON che contiene l'oggetto matrice del contratto utente
- Corpo
- userAgreementListV6
Ottenere un elenco di tutti i contratti (old) [DEPRECATO]
Questa operazione recupera l'elenco di tutti i contratti dell'utente.
Restituisce
JSON che contiene l'oggetto matrice del contratto utente
- Corpo
- UserAgreements
Ottenere un elenco di tutti i contratti in base ai criteri di ricerca
Questa operazione cerca i contratti in base a criteri quali ID flusso di lavoro e così via.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
|
|
Nome/ID flusso di lavoro
|
workflowId | string |
Selezionare il flusso di lavoro personalizzato dall'elenco o immettere l'ID del flusso di lavoro personalizzato. |
|
|
Creato dopo
|
gt | string |
Data e ora minima consentita. Esempio: 2020-12-31T23:59:00Z |
|
|
Creato prima
|
lt | string |
Valore massimo consentito per la data e l'ora. Esempio: 2023-12-31T23:59:00Z |
|
|
Dimensioni pagina
|
pageSize | integer |
Numero di elementi nella pagina di risposta. Per impostazione predefinita: 50; Max: 500 |
|
|
Indice iniziale
|
startIndex | integer |
Prima riga in base 0 (offset) dei risultati della ricerca da restituire. |
Restituisce
JSON che contiene l'oggetto matrice del contratto utente
- Corpo
- userAgreementListV6
Ottenere un elenco di tutti i flussi di lavoro
Questa operazione recupera l'elenco di tutti i flussi di lavoro dell'utente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Includi flussi di lavoro bozza
|
includeDraftWorkflows | boolean |
Includere flussi di lavoro bozza |
|
|
Includere flussi di lavoro inattivi
|
includeInactiveWorkflows | boolean |
Includere flussi di lavoro inattivi |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
Json che contiene l'oggetto matrice del flusso di lavoro utente
- Corpo
- userWorkflowListV6
Ottenere un elenco di tutti i gruppi a cui appartiene l'utente
Questa operazione recupera l'elenco di tutti i gruppi a cui appartiene l'utente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
ID utente
|
userId | True | string |
Per ottenere il risultato per l'utente autorizzato, l'ID utente può essere sostituito da 'me' senza virgolette. |
Restituisce
JSON che contiene l'elenco di gruppi per un determinato utente
- Corpo
- UserGroupsInfoV6
Ottenere un elenco di tutti i modelli di libreria
Questa operazione recupera l'elenco di tutti i documenti archiviati come modelli nella raccolta Adobe Acrobat Sign dell'utente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Consente di spostarsi tra le pagine. Se non specificato, restituisce la prima pagina. |
|
|
Dimensioni pagina
|
pageSize | integer |
Numero di elementi nella pagina di risposta. Per impostazione predefinita: 100; Max: 10000 |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
Json che contiene l'oggetto matrice di modelli di libreria
- Corpo
- LibraryDocuments
Ottenere un elenco di tutti i modelli di libreria (precedente) [DEPRECATO]
Questa operazione recupera l'elenco di tutti i documenti archiviati come modelli nella raccolta Adobe Acrobat Sign dell'utente.
Restituisce
Json che contiene l'oggetto matrice di modelli di libreria
- Corpo
- DocumentLibraryItems
Ottenere un elenco di tutti i web form
Questa operazione recupera l'elenco di tutti i web form dell'utente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Consente di spostarsi tra le pagine. Se non specificato, restituisce la prima pagina. |
|
|
Dimensioni pagina
|
pageSize | integer |
Numero di elementi nella pagina di risposta. Per impostazione predefinita: 100; Max: 10000 |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
Nome gruppo/ID
|
groupId | string |
ID del gruppo. Per usarlo, è necessario selezionare il campo 'In the Name Of' |
Restituisce
Json che contiene l'oggetto matrice di web form dell'utente
- Corpo
- userWidgetListV6
Ottenere un PDF dell'audit trail del contratto
Questa operazione recupera il flusso di file PDF del audit trail dell'accordo. Si noti che il flusso di file deve essere archiviato con un nome file che termina con .pdf estensione di file.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
|
|
ID contratto
|
agreementId | True | string |
ID contratto dell'accordo di cui sono necessarie le informazioni |
Restituisce
Flusso di file del audit trail dell'accordo
- response
- AgreementAuditTrailResponse
Ottenere un PDF di un contratto firmato
Questa operazione recupera il flusso di file PDF del contratto combinato o firmato. Si noti che il flusso di file deve essere archiviato con un nome file che termina con .pdf estensione di file.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto fornito dall'azione che crea il contratto |
|
Allegare documenti di supporto?
|
attachSupportingDocuments | boolean |
Se true, allegare documenti di supporto al PDF del contratto firmato |
|
|
Allegare il report di controllo?
|
attachAuditReport | boolean |
Se true, allegare un report di controllo al PDF del contratto firmato |
|
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
Flusso di file del documento
- response
- CombinedDocumentResponse
Ottenere un PDF di un contratto firmato [DEPRECATO]
Questa azione è stata deprecata. Usare invece Get a PDF of a signed agreement (Ottieni un PDF di un contratto firmato ).
Questa operazione recupera il flusso di file PDF del contratto combinato o firmato. Si noti che il flusso di file deve essere archiviato con un nome file che termina con .pdf estensione di file.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto fornito dall'azione che crea il contratto |
|
Allegare documenti di supporto?
|
attachSupportingDocuments | boolean |
Se true, allegare documenti di supporto al PDF del contratto firmato |
|
|
Allegare il report di controllo?
|
auditReport | boolean |
Se true, allegare un report di controllo al PDF del contratto firmato |
Restituisce
Flusso di file del documento
- response
- CombinedDocumentResponse
Recuperare l'URL di firma
Questa operazione recupera l'URL della pagina di firma elettronica per i firmatari correnti di un contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID contratto
|
agreementId | True | string |
ID del contratto fornito dall'azione che crea il contratto |
|
Nel nome di
|
x-api-user | string |
Il messaggio di posta elettronica del chiamante API nel formato: email:adobesignuser@domain.com |
Restituisce
- Corpo
- SigningUrlResponse
Trigger
| Quando lo stato di un contratto cambia |
Attiva un nuovo flusso quando lo stato di un contratto cambia. Vengono illustrati gli eventi di contratto più comuni, ad esempio la creazione, il completamento e così via. |
| Quando si verifica un evento |
Attiva un nuovo flusso quando si verifica un evento. Copre tutti gli eventi Agreement, Mega Sign e Web Form. |
| Quando si verifica un evento del contratto web form |
Attiva un nuovo flusso quando si verifica l'evento del contratto web form. Vengono illustrati gli eventi di contratto più comuni, ad esempio la creazione, il completamento e così via. |
| Quando si verifica un evento di gruppo |
Attiva un nuovo flusso quando si verifica un evento di gruppo. Copre tutti gli eventi Agreement, Mega Sign e Web Form. |
| Quando un contratto viene inviato a un partecipante |
Attiva un nuovo flusso quando un contratto viene inviato a un partecipante. |
| Quando un flusso di lavoro del contratto viene completato correttamente |
Attiva un nuovo flusso quando un flusso di lavoro del contratto viene completato correttamente |
| Quando viene creato un nuovo contratto |
Attiva un nuovo flusso quando viene creato un nuovo contratto. |
Quando lo stato di un contratto cambia
Attiva un nuovo flusso quando lo stato di un contratto cambia. Vengono illustrati gli eventi di contratto più comuni, ad esempio la creazione, il completamento e così via.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Ambito
|
scope | True | string |
Ambito del trigger |
|
Nome contratto/ID
|
resourceId | string |
Specificare solo quando "Ambito" è "Contratto specifico". Selezionare un contratto dall'elenco o immettere l'ID contratto. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
|
|
Includere le informazioni sul documento firmato dall'accordo?
|
includeSignedDocuments | boolean |
Deve essere inviata una copia finale del documento firmato nella notifica del completamento dell'accordo? |
Restituisce
Quando si verifica un evento
Attiva un nuovo flusso quando si verifica un evento. Copre tutti gli eventi Agreement, Mega Sign e Web Form.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Ambito
|
scope | True | string |
Ambito del trigger |
|
Tipo di risorsa
|
resourceType | string |
Specificare solo quando "Ambito" è "Una risorsa specifica". Selezionare il tipo di risorsa per il quale deve essere attivato il flusso. |
|
|
ID risorsa
|
resourceId | string |
Specificare solo quando "Ambito" è "Una risorsa specifica". Immettere l'ID del contratto o del mega sign o del web o del gruppo per il quale deve essere attivato il flusso. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
|
|
Includere le informazioni sul documento firmato dall'accordo?
|
includeSignedDocuments | boolean |
Deve essere inviata una copia finale del documento firmato al completamento dell'accordo nella notifica? |
|
|
Includi informazioni megasign?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate relative ai mega sign devono essere inviate nella notifica? |
|
|
Includi informazioni modulo Web?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sul modulo Web devono essere inviate nella notifica? |
|
|
Includere le informazioni dei partecipanti al modulo Web?
|
includeParticipantsInfo | boolean |
Le informazioni dei partecipanti al modulo Web devono essere inviate nella notifica? |
|
|
Includi informazioni sui documenti del modulo Web?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento del modulo Web devono essere inviate nella notifica? |
Restituisce
- Corpo
- WebhookPayloadGeneric
Quando si verifica un evento del contratto web form
Attiva un nuovo flusso quando si verifica l'evento del contratto web form. Vengono illustrati gli eventi di contratto più comuni, ad esempio la creazione, il completamento e così via.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Dimensioni pagina Web Form
|
pageSize | integer |
Selezionare il numero di web form da visualizzare nell'elenco a discesa |
|
|
Nome/ID modulo Web
|
resourceId | True | string |
Selezionare il modulo Web dall'elenco o immettere l'ID del modulo Web. |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
|
|
Includere le informazioni sul documento firmato dall'accordo?
|
includeSignedDocuments | boolean |
Deve essere inviata una copia finale del documento firmato nella notifica del completamento dell'accordo? |
Restituisce
Quando si verifica un evento di gruppo
Attiva un nuovo flusso quando si verifica un evento di gruppo. Copre tutti gli eventi Agreement, Mega Sign e Web Form.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Nome gruppo/ID
|
resourceId | string |
ID del gruppo |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
|
|
Includere le informazioni sul documento firmato dall'accordo?
|
includeSignedDocuments | boolean |
Deve essere inviata una copia finale del documento firmato al completamento dell'accordo nella notifica? |
|
|
Includi informazioni megasign?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate relative ai mega sign devono essere inviate nella notifica? |
|
|
Includi informazioni modulo Web?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sul modulo Web devono essere inviate nella notifica? |
|
|
Includere le informazioni dei partecipanti al modulo Web?
|
includeParticipantsInfo | boolean |
Le informazioni dei partecipanti al modulo Web devono essere inviate nella notifica? |
|
|
Includi informazioni sui documenti del modulo Web?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento del modulo Web devono essere inviate nella notifica? |
Restituisce
- Corpo
- GroupWebhookEventPayload
Quando un contratto viene inviato a un partecipante
Attiva un nuovo flusso quando un contratto viene inviato a un partecipante.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Ambito
|
scope | True | string |
Ambito del trigger |
|
Nome contratto/ID
|
resourceId | string |
Specificare solo quando "Ambito" è "Contratto specifico". Selezionare un contratto dall'elenco o immettere l'ID contratto. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
Restituisce
- Corpo
- WebhookPayload
Quando un flusso di lavoro del contratto viene completato correttamente
Attiva un nuovo flusso quando un flusso di lavoro del contratto viene completato correttamente
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Ambito
|
scope | True | string |
Ambito del trigger |
|
Nome contratto/ID
|
resourceId | string |
Specificare solo quando "Ambito" è "Contratto specifico". Selezionare un contratto dall'elenco o immettere l'ID contratto. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni documento contratto?
|
includeDocumentsInfo | boolean |
Le informazioni sul documento d'accordo devono essere inviate nella notifica? |
|
|
Includere le informazioni sul documento firmato dall'accordo?
|
includeSignedDocuments | boolean |
Deve essere inviata una copia finale del documento firmato al completamento dell'accordo nella notifica? |
Restituisce
Quando viene creato un nuovo contratto
Attiva un nuovo flusso quando viene creato un nuovo contratto.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome del trigger |
|
Ambito
|
scope | True | string |
Ambito del trigger |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Eventi per i quali deve essere attivato il flusso |
|
Includi informazioni sul contratto?
|
includeDetailedInfo | boolean |
Le informazioni dettagliate sull'accordo devono essere inviate nella notifica? |
|
|
Includi informazioni sul partecipante dell'accordo?
|
includeParticipantsInfo | boolean |
Le informazioni del partecipante dell'accordo devono essere inviate nella notifica? |
Restituisce
Definizioni
AgreementCreationResponse
JSON che contiene l'ID del contratto appena creato
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contratto
|
agreementId | string |
ID univoco del contratto che può essere usato per eseguire query sullo stato e scaricare documenti firmati |
AgreementCreationResponseV6
JSON che contiene l'ID del contratto appena creato
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contratto
|
id | string |
ID univoco del contratto che può essere usato per eseguire query sullo stato e scaricare documenti firmati |
AgreementDocuments
JSON che contiene sia i documenti che gli oggetti matrice di documenti di supporto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documents
|
documents | array of Document |
Elenco di oggetti che rappresentano i documenti |
|
Documenti di supporto
|
supportingDocuments | array of SupportingDocument |
Elenco di documenti di supporto. Questo viene restituito solo se sono presenti documenti di supporto nell'accordo |
AgreementDocumentsV6
JSON che contiene sia i documenti che gli oggetti matrice di documenti di supporto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documents
|
documents | array of DocumentV6 |
Elenco di oggetti che rappresentano i documenti |
|
Documenti di supporto
|
supportingDocuments | array of SupportingDocumentV6 |
Elenco di documenti di supporto. Questo viene restituito solo se sono presenti documenti di supporto nell'accordo |
AgreementInfo
Dettagli completi sul contratto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contratto
|
agreementId | string |
ID univoco che può essere usato per identificare in modo univoco il contratto |
|
Events
|
events | array of DocumentHistoryEvent |
Elenco ordinato degli eventi nel audit trail di questo documento |
|
Data di scadenza
|
expiration | date |
Data successiva alla quale l'accordo non può più essere firmato |
|
ID versione più recente
|
latestVersionId | string |
ID univoco che identifica in modo univoco la versione corrente del contratto |
|
Message
|
message | string |
Messaggio associato al contratto fornito dal mittente |
|
Nome contratto
|
name | string |
Nome del contratto, specificato dal mittente |
|
Set di partecipanti successivi
|
nextParticipantSetInfos | array of NextParticipantSetInfo |
Informazioni su chi deve agire successivamente per questo contratto |
|
Set di partecipanti
|
participantSetInfos | array of ParticipantSetInfo |
Informazioni su tutti i set di partecipanti di questo documento |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
Protezione dei documenti
|
securityOptions | string |
Informazioni di sicurezza sul documento che specifica se è necessaria o meno una password per visualizzarla e firmarla |
|
stato
|
status | string |
Stato corrente dell'accordo |
AgreementInfoV6
Dettagli del contratto completo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contratto
|
id | string |
ID univoco che può essere usato per identificare in modo univoco il contratto |
|
Data di creazione
|
createdDate | date |
Data di creazione del contratto |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Frequenza promemoria
|
reminderFrequency | string |
Con quale frequenza si desidera inviare promemoria? |
|
Data di scadenza
|
expiration | date |
Data successiva alla quale l'accordo non può più essere firmato |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto, ad esempio en_US o fr_FR |
|
Message
|
message | string |
Messaggio associato al contratto fornito dal mittente |
|
Nome contratto
|
name | string |
Nome del contratto, specificato dal mittente |
|
Visibilità del documento?
|
documentVisibilityEnabled | boolean |
La visibilità dei documenti è abilitata? |
|
Set di partecipanti
|
participantSetsInfo | array of ParticipantSetInfoV6 |
Informazioni su tutti i set di partecipanti di questo documento |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
Opzioni di sicurezza
|
securityOptions | string |
Informazioni di sicurezza sul documento che specifica se è necessaria o meno una password per visualizzarla e firmarla |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
Posta elettronica mittente
|
senderEmail | string |
Indirizzo di posta elettronica del mittente |
|
ID flusso di lavoro
|
workflowId | string |
ID del flusso di lavoro personalizzato che definisce il percorso di routing di un contratto. |
|
Ccs
|
ccs | array of CcInfo |
Elenco di uno o più CC che verranno copiati nella transazione dell'accordo. |
|
ID del Gruppo
|
groupId | string |
Identificatore univoco del gruppo a cui appartiene l'accordo. |
CombinedDocumentResponse
AgreementAuditTrailResponse
Flusso di file del audit trail dell'accordo
Flusso di file del audit trail dell'accordo
- Contenuto audit trail dell'accordo
- binary
DisplayUserInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Azienda
|
company | string |
Visualizza il nome della società dell'utente, se disponibile |
|
Email
|
string |
Visualizza l'indirizzo di posta elettronica dell'utente |
|
|
Nome completo
|
fullName | string |
Visualizza il nome completo dell'utente, se disponibile. |
DisplayUserSetInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Visualizzare le informazioni sul set di utenti
|
displayUserSetMemberInfos | array of DisplayUserInfo |
Visualizza le informazioni sul set di utenti |
|
Visualizzare il nome del set di utenti
|
displayUserSetName | string |
Documento
Informazioni sul documento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID documento
|
documentId | string |
ID univoco del documento |
|
Tipo Mime
|
mimeType | string |
Tipo Mime del documento |
|
Nome
|
name | string |
Nome del documento |
|
Num Pages
|
numPages | integer |
Numero di pagine nel documento |
DocumentV6
Informazioni sul documento
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID documento
|
id | string |
ID univoco del documento |
|
Tipo Mime
|
mimeType | string |
Tipo Mime del documento |
|
Nome
|
name | string |
Nome del documento |
|
Num Pages
|
numPages | integer |
Numero di pagine nel documento |
DocumentHistoryEvent
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Iniziatore di eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento |
|
Data evento
|
date | date |
Data dell'evento di controllo |
|
Descrizione evento
|
description | string |
Descrizione dell'evento di controllo |
|
Messaggio di posta elettronica del partecipante
|
participantEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento |
|
Tipo di evento
|
type | string |
Tipo di evento di contratto |
DocumentLibraryItem
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID modello libreria
|
libraryDocumentId | string |
ID univoco del documento della raccolta utilizzato durante l'invio del documento da firmare |
|
Tipi di modelli di libreria
|
libraryTemplateTypes | array of string |
Elenco di uno o più tipi di modello di libreria |
|
Data modifica
|
modifiedDate | date |
Giorno dell'ultima modifica del modello di libreria |
|
Nome modello libreria
|
name | string |
Nome del modello di libreria |
|
Modalità condivisione modelli
|
scope | string |
Ambito di visibilità del modello di libreria |
DocumentLibraryItems
Json che contiene l'oggetto matrice di modelli di libreria
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Elenco modelli di libreria
|
libraryDocumentList | array of DocumentLibraryItem |
Elenco di elementi del modello di libreria |
DocumentResponse
LibraryDocumentCreationResponse
Oggetto JSON che descrive il modello di libreria
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID modello libreria
|
libraryDocumentId | string |
ID univoco che può essere usato per fare riferimento al modello di libreria |
NextParticipantInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
string |
Indirizzo di posta elettronica del partecipante successivo |
|
|
Nome
|
name | string |
Nome del partecipante successivo, se disponibile |
|
In attesa da quando
|
waitingSince | date |
Data da cui il documento è in attesa che il partecipante esee' in azione |
NextParticipantSetInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Informazioni sui membri set di partecipanti successivi
|
nextParticipantSetMemberInfos | array of NextParticipantInfo |
Informazioni sui membri del set di partecipanti successivo |
ParticipantInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Azienda
|
company | string |
Società del partecipante, se disponibile |
|
Email
|
string |
Indirizzo di posta elettronica del partecipante |
|
|
Nome
|
name | string |
Nome del partecipante, se disponibile |
|
ID partecipante
|
participantId | string |
ID univoco del partecipante |
|
Opzioni di sicurezza
|
securityOptions | array of string |
Opzioni di sicurezza applicabili al partecipante |
|
Titolo
|
title | string |
Titolo del partecipante, se disponibile |
ParticipantSetInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID set partecipante
|
participantSetId | string |
ID univoco del set di partecipanti |
|
Informazioni sui membri del set di partecipanti
|
participantSetMemberInfos | array of ParticipantInfo |
Informazioni sui membri del set di destinatari |
|
Messaggio privato
|
privateMessage | string |
Messaggio privato per i partecipanti nel set |
|
Ruolo
|
roles | array of string |
Ruoli correnti del set di partecipanti. Un set di partecipanti può avere uno o più ruoli |
|
securityOptions
|
securityOptions | array of string |
Opzioni di sicurezza applicabili al partecipante |
|
Ordine di firma
|
signingOrder | integer |
Indice a partire da 1, che indica l'ordine in cui il destinatario firma |
|
Stato del set di partecipanti
|
status | string |
Lo stato impostato dal partecipante rispetto al documento |
ParticipantSetInfoV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Informazioni sui membri del set di partecipanti
|
memberInfos | array of MemberInfosV6 |
Informazioni sui membri del set di destinatari |
|
Ordinamento
|
order | integer |
Indice che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | string |
I ruoli correnti del set di partecipanti (firmatario, responsabile approvazione e così via). |
|
Nome del set di partecipanti
|
name | string |
Nome del set di partecipanti |
|
Participant Set Private Messsage
|
privateMessage | string |
Messaggio privato per i partecipanti nel set |
|
Set di pagine visibili del partecipante
|
visiblePages | array of string |
Le pagine visibili al set di partecipanti |
MemberInfosV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Messaggio di posta elettronica del partecipante
|
string |
Messaggio di posta elettronica del partecipante |
|
|
Authentication
|
securityOption.authenticationMethod | string |
Autenticazione predefinita: posta elettronica (Nessuno) |
|
Parola chiave
|
securityOption.password | string |
Password necessaria per il partecipante |
|
Codice paese
|
securityOption.phoneInfo.countryCode | string |
Codice paese di telefono del destinatario necessario per visualizzare e firmare il documento |
|
Telefono No.
|
securityOption.phoneInfo.phone | string |
Numero di telefono del destinatario necessario per visualizzare e firmare il contratto |
SigningUrl
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Indirizzo di posta elettronica per l'URL di accesso
|
string |
Indirizzo di posta elettronica del firmatario associato a questo URL di firma |
|
|
URL di firma
|
esignUrl | string |
Indirizzo URL del firmatario associato a questo URL di firma |
SigningUrlResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Matrice di URL per i set di firmatari
|
signingUrlSetInfos | array of SigningUrlSetInfo |
Matrice di URL per i set di firmatari coinvolti nel presente contratto |
SigningUrlSetInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
- Matrice URL di firma
|
signingUrls | array of SigningUrl |
Matrice di URL per il set di firmatari corrente |
|
- Nome del set di URL di firma
|
signingUrlSetName | string |
Nome del set di firmatario corrente |
Supporto diDocument
Informazioni sul documento di supporto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome documento di supporto
|
displayLabel | string |
Nome visualizzato del documento di supporto |
|
Nome campo documento di supporto
|
fieldName | string |
Nome del campo del documento di supporto |
|
Supporto del tipo mime documento
|
mimeType | string |
Tipo Mime del documento di supporto |
|
Supporto delle pagine documento
|
numPages | integer |
Numero di pagine nel documento di supporto |
|
ID documento di supporto
|
supportingDocumentId | string |
ID univoco che rappresenta il documento di supporto |
SupportoDocumentV6
Informazioni sul documento di supporto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome documento di supporto
|
displayLabel | string |
Nome visualizzato del documento di supporto |
|
Nome campo documento di supporto
|
fieldName | string |
Nome del campo del documento di supporto |
|
Supporto del tipo mime documento
|
mimeType | string |
Tipo Mime del documento di supporto |
|
Supporto delle pagine documento
|
numPages | integer |
Numero di pagine nel documento di supporto |
|
ID documento di supporto
|
id | string |
ID univoco che rappresenta il documento di supporto |
TransientDocumentResponse
JSON che contiene l'ID del documento caricato
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID documento
|
transientDocumentId | string |
ID documento del documento caricato |
UserAgreement
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID contratto
|
agreementId | string |
ID univoco che può essere usato per identificare in modo univoco il contratto |
|
Visualizzare le informazioni sul set di utenti
|
displayUserSetInfos | array of DisplayUserSetInfo |
L'utente più pertinente impostato per il contratto. In genere è il firmatario successivo se il contratto proviene dall'utente corrente o dal mittente se ricevuto da un altro utente |
|
Data di visualizzazione
|
displayDate | date |
Data di visualizzazione del contratto |
|
Esign
|
esign | boolean |
True se si tratta di un documento di firma elettronica |
|
ID versione più recente
|
latestVersionId | string |
ID versione che identifica in modo univoco la versione corrente del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
stato
|
status | string |
Stato corrente dell'accordo |
UserAgreements
JSON che contiene l'oggetto matrice del contratto utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Elenco degli accordi
|
userAgreementList | array of UserAgreement |
Matrice di elementi del contratto |
UserAgreementV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Visualizzare le informazioni sul set di utenti
|
displayParticipantSetInfos | array of DisplayUserSetInfo |
L'utente più pertinente impostato per il contratto. In genere è il firmatario successivo se il contratto proviene dall'utente corrente o dal mittente se ricevuto da un altro utente |
|
Data di visualizzazione
|
displayDate | string |
Data di visualizzazione del contratto |
|
Esign
|
esign | boolean |
True se si tratta di un documento di firma elettronica |
|
Nascosto
|
hidden | boolean |
True se il contratto è nascosto per l'utente |
|
ID del Gruppo
|
groupId | string |
Identificatore univoco del gruppo |
|
ID versione più recente
|
latestVersionId | string |
ID versione che identifica in modo univoco la versione corrente del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
ID padre
|
parentId | string |
ID padre di un elemento figlio megaSign O l'ID di origine di un'istanza del contratto Web Form |
|
ID contratto
|
id | string |
Identificatore univoco del contratto |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
TIPO
|
type | string |
Il tipo di accordo |
userAgreementListV6
JSON che contiene l'oggetto matrice del contratto utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
page
|
page | page |
Informazioni sull'impaginazione per l'esplorazione della risposta |
|
Elenco degli accordi
|
userAgreementList | array of UserAgreementV6 |
Matrice di elementi del contratto |
page
Informazioni sull'impaginazione per l'esplorazione della risposta
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nextCursor
|
nextCursor | string |
Consente di passare alla pagina successiva. Se non viene restituito, non sono presenti altre pagine. |
WebhookPayload
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato nella risorsa. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Tipo di risorsa evento
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Tipo padre contratto
|
eventResourceParentType | string |
Informazioni sulla risorsa da cui viene creato il contratto. Valori possibili: Web Form o Mega Sign |
|
ID padre contratto
|
eventResourceParentId | string |
ID univoco della risorsa da cui viene creato il contratto |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfo |
Informazioni complete dell'accordo |
ApplicableUsers
Informazioni sugli utenti per i quali questa notifica è applicabile
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
NOTIFICA ID utente applicabile
|
id | string |
ID univoco dell'utente per il quale questa notifica è applicabile |
|
Notifica indirizzo di posta elettronica utente applicabile
|
string |
Indirizzo di posta elettronica dell'utente per il quale questa notifica è applicabile |
|
|
Ruolo utente applicabile alla notifica
|
role | string |
Ruolo dell'utente nel flusso di lavoro per il quale viene generata la notifica |
|
Utente applicabile al payload
|
payloadApplicable | boolean |
Indica se i dati forniti in questa notifica sono applicabili o meno all'utente |
WebhookPayloadWithoutNextParticipantSet
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato nella risorsa. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Tipo di risorsa evento
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Tipo padre contratto
|
eventResourceParentType | string |
Informazioni sulla risorsa da cui viene creato il contratto. Valori possibili: Web Form o Mega Sign |
|
ID padre contratto
|
eventResourceParentId | string |
ID univoco della risorsa da cui viene creato il contratto |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
Informazioni complete dell'accordo |
WebhookPayloadWithSignedDocumentForStatusChange
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato nella risorsa. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Sub Event
|
subEvent | string |
Evento secondario che si è verificato in una risorsa. |
|
Tipo padre contratto
|
eventResourceParentType | string |
Informazioni sulla risorsa da cui viene creato il contratto. Valori possibili: Web Form o Mega Sign |
|
ID padre contratto
|
eventResourceParentId | string |
ID univoco della risorsa da cui viene creato il contratto |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
Tipo di azione
|
actionType | string |
Azione per cui si è verificato l'evento. |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Tipo di risorsa evento
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
Informazioni complete dell'accordo |
WebhookPayloadWithSignedDocument
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato nella risorsa. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Tipo padre contratto
|
eventResourceParentType | string |
Informazioni sulla risorsa da cui viene creato il contratto. Valori possibili: Web Form o Mega Sign |
|
ID padre contratto
|
eventResourceParentId | string |
ID univoco della risorsa da cui viene creato il contratto |
|
Tipo di risorsa evento
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
Informazioni complete dell'accordo |
WebhookPayloadGeneric
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato nella risorsa. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Sub Event
|
subEvent | string |
Evento secondario che si è verificato in una risorsa. |
|
Tipo padre contratto
|
eventResourceParentType | string |
Informazioni sulla risorsa da cui viene creato il contratto. Valori possibili: Web Form o Mega Sign |
|
ID padre contratto
|
eventResourceParentId | string |
ID univoco della risorsa da cui viene creato il contratto |
|
Tipo di risorsa evento
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Tipo di azione
|
actionType | string |
Azione per cui si è verificato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Informazioni complete dell'accordo |
|
Mega Sign
|
megaSign | WebhookMegaSignInfo |
Le informazioni complete del mega segno |
|
Web Form
|
widget | WebhookWidgetInfo |
Informazioni complete del modulo Web |
WebFormWebhookAgreementEventPayload
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento del contratto che si è verificato nel web form. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Sub Event
|
subEvent | string |
Evento secondario che si è verificato in un web form. |
|
Tipo padre contratto - Web Form
|
eventResourceParentType | string |
Valore che indica che viene creato un contratto dal Web form. |
|
ID modulo Web
|
eventResourceParentId | string |
ID univoco del modulo Web da cui viene creato il contratto |
|
Tipo di risorsa evento - Contratto
|
eventResourceType | string |
Risorsa in cui si è verificato l'evento. |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Tipo di azione
|
actionType | string |
Azione per cui si è verificato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Informazioni complete dell'accordo |
GroupWebhookEventPayload
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Event
|
event | string |
Evento che si è verificato per un gruppo. |
|
Data evento
|
eventDate | date |
Data dell'evento. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Sub Event
|
subEvent | string |
Sottoevento che si è verificato per un gruppo. |
|
Tipo padre contratto - Web Form
|
eventResourceParentType | string |
Informazioni sul gruppo da cui viene creato il contratto. |
|
ID modulo Web
|
eventResourceParentId | string |
ID univoco del gruppo da cui viene creato il contratto |
|
Tipo di risorsa evento - Contratto
|
eventResourceType | string |
Gruppo per il quale si è verificato l'evento. |
|
Ruolo partecipante evento
|
participantRole | string |
Ruolo del partecipante per l'evento. |
|
ID partecipante evento
|
participantUserId | string |
ID del partecipante per l'evento. |
|
Messaggio di posta elettronica del partecipante dell'evento
|
participantUserEmail | string |
Messaggio di posta elettronica del partecipante per l'evento. |
|
ID utente agendo su eventi
|
actingUserId | string |
ID dell'utente che ha creato l'evento. |
|
Messaggio di posta elettronica dell'utente per la recitazione degli eventi
|
actingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha creato l'evento. |
|
ID utente di avvio dell'evento
|
initiatingUserId | string |
ID dell'utente che ha avviato l'evento per conto dell'utente che agisce |
|
Messaggio di posta elettronica dell'utente di avvio dell'evento
|
initiatingUserEmail | string |
Indirizzo di posta elettronica dell'utente che ha avviato l'evento per conto dell'utente che agisce. |
|
Tipo di azione
|
actionType | string |
Azione per cui si è verificato l'evento. |
|
Indirizzo IP dell'utente che funge da evento
|
actingUserIpAddress | string |
Indirizzo IP dell'utente che ha creato l'evento |
|
Notifica utenti applicabili
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Elenco di utenti per i quali questa notifica è applicabile |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Informazioni complete dell'accordo |
|
Mega Sign
|
megaSign | WebhookMegaSignInfo |
Le informazioni complete del mega segno |
|
Web Form
|
widget | WebhookWidgetInfo |
Informazioni complete del modulo Web |
WebhookAgreementInfo
Informazioni complete dell'accordo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
Ccs
|
ccs | array of CcInfo |
Elenco di uno o più CC che verranno copiati nella transazione dell'accordo. |
|
Data di creazione
|
createdDate | date |
Data di creazione del contratto |
|
Scadenza
|
expirationTime | string |
Tempo trascorso il quale l'accordo scade e deve essere firmato prima di esso |
|
ID esterno
|
externalId.id | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Gruppo esterno
|
externalId.group | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto |
|
Message
|
message | string |
Messaggio facoltativo ai partecipanti, che descrive cosa viene inviato o perché è necessaria la firma |
|
Frequenza promemoria
|
reminderFrequency | string |
Parametro facoltativo che imposta la frequenza con cui si desidera inviare promemoria ai partecipanti. Se non viene specificato, verrà usata la frequenza predefinita impostata per l'account |
|
Posta elettronica mittente
|
senderEmail | string |
Messaggio di posta elettronica del mittente del contratto |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
Visibilità del documento?
|
documentVisibilityEnabled | boolean |
Visibilità dei documenti abilitata |
|
ID flusso di lavoro
|
workflowId | string |
ID del flusso di lavoro personalizzato che definisce il percorso di routing di un contratto. |
|
URL di reindirizzamento post firma
|
postSignOption.redirectUrl | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il processo di firma |
|
Set di partecipanti
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Le informazioni sui partecipanti vengono impostate |
|
Set di partecipanti successivi
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Il partecipante successivo imposta le informazioni |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Elenco di oggetti che rappresentano i documenti |
|
Documenti di supporto
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Elenco di documenti di supporto |
WebhookAgreementInfoWithoutNextParticipantSet
Informazioni complete dell'accordo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
Ccs
|
ccs | array of CcInfo |
Elenco di uno o più CC che verranno copiati nella transazione dell'accordo. |
|
Data di creazione
|
createdDate | date |
Data di creazione del contratto |
|
Visibilità del documento?
|
documentVisibilityEnabled | boolean |
Visibilità dei documenti abilitata |
|
Scadenza
|
expirationTime | string |
Tempo trascorso il quale l'accordo scade e deve essere firmato prima di esso |
|
ID esterno
|
externalId.id | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Gruppo esterno
|
externalId.group | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto |
|
Message
|
message | string |
Messaggio facoltativo ai partecipanti, che descrive cosa viene inviato o perché è necessaria la firma |
|
Frequenza promemoria
|
reminderFrequency | string |
Parametro facoltativo che imposta la frequenza con cui si desidera inviare promemoria ai partecipanti. Se non viene specificato, verrà usata la frequenza predefinita impostata per l'account |
|
Posta elettronica mittente
|
senderEmail | string |
Messaggio di posta elettronica del mittente del contratto |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
URL di reindirizzamento post firma
|
postSignOption.redirectUrl | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il processo di firma |
|
ID flusso di lavoro
|
workflowId | string |
ID del flusso di lavoro personalizzato che definisce il percorso di routing di un contratto. |
|
Set di partecipanti
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Le informazioni sui partecipanti vengono impostate |
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
Informazioni complete dell'accordo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
Ccs
|
ccs | array of CcInfo |
Elenco di uno o più CC che verranno copiati nella transazione dell'accordo. |
|
Data di creazione
|
createdDate | date |
Data di creazione del contratto |
|
Scadenza
|
expirationTime | string |
Tempo trascorso il quale l'accordo scade e deve essere firmato prima di esso |
|
ID esterno
|
externalId.id | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Gruppo esterno
|
externalId.group | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto |
|
Message
|
message | string |
Messaggio facoltativo ai partecipanti, che descrive cosa viene inviato o perché è necessaria la firma |
|
Frequenza promemoria
|
reminderFrequency | string |
Parametro facoltativo che imposta la frequenza con cui si desidera inviare promemoria ai partecipanti. Se non viene specificato, verrà usata la frequenza predefinita impostata per l'account |
|
URL di reindirizzamento post firma
|
postSignOption.redirectUrl | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il processo di firma |
|
ID flusso di lavoro
|
workflowId | string |
ID del flusso di lavoro personalizzato che definisce il percorso di routing di un contratto. |
|
Posta elettronica mittente
|
senderEmail | string |
Messaggio di posta elettronica del mittente del contratto |
|
Visibilità del documento?
|
documentVisibilityEnabled | boolean |
Visibilità dei documenti abilitata |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
Set di partecipanti
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Le informazioni sui partecipanti vengono impostate |
|
Set di partecipanti successivi
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Il partecipante successivo imposta le informazioni |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Elenco di oggetti che rappresentano i documenti |
|
Documenti di supporto
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Un elenco di documenti di supporto Questo viene restituito solo se sono presenti documenti di supporto nell'accordo |
|
Informazioni sul documento firmato
|
signedDocumentInfo.document | string |
Stringa con codifica Base64 del documento firmato |
WebhookAgreementInfoWithSignedDocument
Informazioni complete dell'accordo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del contratto |
|
Nome
|
name | string |
Nome del contratto |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
stato
|
status | string |
Stato corrente dell'accordo |
|
Ccs
|
ccs | array of CcInfo |
Elenco di uno o più CC che verranno copiati nella transazione dell'accordo |
|
Data di creazione
|
createdDate | date |
Data di creazione del contratto |
|
Visibilità del documento?
|
documentVisibilityEnabled | boolean |
Visibilità dei documenti abilitata |
|
Scadenza
|
expirationTime | string |
Tempo trascorso il quale l'accordo scade e deve essere firmato prima di esso |
|
ID esterno
|
externalId.id | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Gruppo esterno
|
externalId.group | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto |
|
Message
|
message | string |
Messaggio facoltativo ai partecipanti, che descrive cosa viene inviato o perché è necessaria la firma |
|
Frequenza promemoria
|
reminderFrequency | string |
Parametro facoltativo che imposta la frequenza con cui si desidera inviare promemoria ai partecipanti. Se non viene specificato, verrà usata la frequenza predefinita impostata per l'account |
|
Posta elettronica mittente
|
senderEmail | string |
Messaggio di posta elettronica del mittente del contratto |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
URL di reindirizzamento post firma
|
postSignOption.redirectUrl | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il processo di firma |
|
ID flusso di lavoro
|
workflowId | string |
ID del flusso di lavoro personalizzato che definisce il percorso di routing di un contratto. |
|
Set di partecipanti
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Le informazioni sui partecipanti vengono impostate |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Elenco di oggetti che rappresentano i documenti |
|
Documenti di supporto
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Un elenco di documenti di supporto Questo viene restituito solo se sono presenti documenti di supporto nell'accordo |
|
Informazioni sul documento firmato
|
signedDocumentInfo.document | string |
Stringa con codifica Base64 del documento firmato |
WebhookMegaSignInfo
Le informazioni complete del mega segno
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del megasign |
|
Nome
|
name | string |
Nome del megasign |
|
stato
|
status | string |
Lo stato del megasign |
|
Ccs
|
ccs | array of MegaSignCcInfo |
Elenco di uno o più indirizzi di posta elettronica da copiare in questo megasign. |
|
ID esterno
|
externalId.id | string |
Valore arbitrario dal sistema, che può essere specificato in fase di invio e quindi restituito o sottoposto a query in un secondo momento |
|
Primo ritardo promemoria
|
firstReminderDelay | integer |
Integer che specifica il ritardo in ore prima di inviare il primo promemoria. |
|
Luogo
|
locale | string |
Impostazioni locali associate al presente contratto |
|
Message
|
message | string |
Messaggio facoltativo ai partecipanti, che descrive cosa viene inviato o perché è necessaria la firma |
|
URL di reindirizzamento post firma
|
postSignOption.redirectUrl | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il processo di firma |
|
Posta elettronica mittente
|
senderEmail | string |
Email of megasign creator |
|
Tipo di firma
|
signatureType | string |
Specifica il tipo di firma richiesto - Firma E o Scritto |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
Informazioni sul file dei contratti figlio
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
Informazioni sui file contenenti le informazioni relative al contratto figlio di megaSign. |
WebhookWidgetInfo
Informazioni complete del modulo Web
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del modulo Web |
|
Nome
|
name | string |
Nome del modulo Web |
|
stato
|
status | string |
Stato del modulo Web |
|
Informazioni sull'errore di autenticazione
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
L'URL e le proprietà associate per la pagina di errore il firmatario del modulo Web verrà acquisito dopo l'errore di autenticazione |
|
Ccs
|
ccs | array of WidgetCcInfo |
Elenco di uno o più indirizzi di posta elettronica da copiare in questo modulo Web. |
|
Data di creazione
|
createdDate | date |
Data di creazione del modulo Web |
|
Informazioni di completamento
|
completionInfo | WidgetCompletionRedirectionInfo |
L'URL e le proprietà associate per la pagina di operazione riuscita verranno eseguite dal firmatario del modulo Web dopo l'esecuzione dell'azione desiderata nel modulo Web |
|
Messaggio di posta elettronica creatore
|
creatorEmail | string |
Messaggio di posta elettronica dell'autore del modulo Web |
|
Insieme di credenziali abilitato?
|
vaultingInfo.enabled | boolean |
Per gli account configurati per l'insieme di credenziali dei documenti e l'opzione per abilitare per contratto, questo determina se il documento deve essere insieme di credenziali |
|
Informazioni aggiuntive sui set di partecipanti
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
Elenco di tutti i partecipanti nel modulo Web ad eccezione del firmatario del modulo Web |
|
First Participant Set Role
|
participantSetsInfo.widgetParticipantSet.role | string |
Ruolo assunto da tutti i partecipanti al set (firmatario, responsabile approvazione e così via) |
|
Ordine set primo partecipante
|
participantSetsInfo.widgetParticipantSet.order | integer |
Indice che indica un gruppo di firma sequenziale (specificato per il routing ibrido) |
|
Documents
|
documentsInfo.documents | array of WidgetWebhookDocument |
Elenco di oggetti che rappresentano i documenti |
AuthFailureWidgetRedirectionInfo
L'URL e le proprietà associate per la pagina di errore il firmatario del modulo Web verrà acquisito dopo l'errore di autenticazione
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Ritardo reindirizzamento errori di autenticazione
|
delay | integer |
Ritardo (in secondi) prima che l'utente venga portato alla pagina risultante |
|
Auth Failure Redirect Deframe
|
deframe | boolean |
Se il frame è false, la pagina risultante verrà visualizzata all'interno del frame del modulo Web |
|
URL di reindirizzamento degli errori di autenticazione
|
url | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il modulo Web |
WidgetCompletionRedirectionInfo
L'URL e le proprietà associate per la pagina di operazione riuscita verranno eseguite dal firmatario del modulo Web dopo l'esecuzione dell'azione desiderata nel modulo Web
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Ritardo reindirizzamento completamento
|
delay | integer |
Ritardo (in secondi) prima che l'utente venga portato alla pagina risultante |
|
Deframe reindirizzamento completamento
|
deframe | boolean |
Se il frame è false, la pagina risultante verrà visualizzata all'interno del frame del modulo Web |
|
URL di reindirizzamento completamento
|
url | string |
URL accessibile pubblicamente a cui l'utente verrà inviato dopo aver completato correttamente il modulo Web |
WebhookParticipantSets
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Informazioni sui membri
|
memberInfos | array of MemberInfos |
Informazioni sui membri dei partecipanti |
|
Ordinamento
|
order | integer |
Indice che indica la posizione in corrispondenza della quale il gruppo di firma deve firmare. |
|
Ruolo
|
role | string |
Ruolo assunto da tutti i partecipanti al set (firmatario, responsabile approvazione e così via) |
|
stato
|
status | string |
Stato corrente del contratto dal punto di vista dell'utente |
|
Documento d'identità
|
id | string |
ID del set di partecipanti |
|
Nome
|
name | string |
Nome del set di partecipanti |
|
Messaggio privato
|
privateMessage | string |
Messaggio privato per i partecipanti nel set |
MegaSignChildAgreementsFileInfo
Informazioni sui file contenenti le informazioni relative al contratto figlio di megaSign.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID file contratti figlio
|
childAgreementsInfoFileId | string |
ID del file contenente informazioni sull'elemento childAgreementsInfo esistente di megaSign. |
WidgetWebhookDocument
Informazioni sul documento del modulo Web
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del documento |
|
Nome
|
name | string |
Nome del documento |
WebhookDocument
Informazioni sul documento dell'accordo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del documento |
|
Nome
|
name | string |
Nome del documento |
WebhookSupportingDocument
Informazioni sul documento di supporto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Nome
|
displayLabel | string |
Nome visualizzato del documento di supporto |
|
Nome campo
|
fieldName | string |
Nome del campo del documento di supporto |
|
Documento d'identità
|
id | string |
ID univoco che rappresenta il documento di supporto |
WidgetCcInfo
Informazioni sul cc del modulo Web
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
string |
Messaggio di posta elettronica del partecipante cc del modulo Web |
MegaSignCcInfo
Le informazioni sul CC del mega segno
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
string |
Email del partecipante cc del megasign |
CcInfo
Informazioni sulla CC del contratto
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Email
|
string |
Il messaggio di posta elettronica del CC del contratto |
|
|
Etichetta
|
label | string |
Etichetta dell'elenco CC restituita nella descrizione del flusso di lavoro |
|
Pagine visibili
|
visiblePages | array of string |
Le pagine visibili al CC |
WidgetParticipantSetInfo
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Ruolo
|
role | string |
Ruolo assunto da tutti i partecipanti al set (firmatario, responsabile approvazione e così via) |
|
Documento d'identità
|
id | string |
Identificatore univoco del set di partecipanti |
|
Informazioni sui membri
|
memberInfos | array of MemberInfos |
Informazioni sui membri del partecipante |
|
Ordinamento
|
order | integer |
Indice che indica un gruppo di firma sequenziale (specificato per il routing ibrido) |
MemberInfos
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Documento d'identità
|
id | string |
ID univoco del partecipante |
|
Email
|
string |
Messaggio di posta elettronica del partecipante |
|
|
Azienda
|
company | string |
Società del partecipante |
|
Nome
|
name | string |
Nome del partecipante |
|
Messaggio privato
|
privateMessage | string |
Messaggio privato del partecipante |
|
stato
|
status | string |
Stato del partecipante |
LibraryDocumentCreationResponseV6
Oggetto JSON che descrive il modello di libreria
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID modello libreria
|
id | string |
ID univoco che può essere usato per fare riferimento al modello di libreria |
LibraryDocument
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID modello libreria
|
id | string |
Identificatore univoco usato per fare riferimento al modello di libreria |
|
Nascosto
|
hidden | boolean |
True se il documento della raccolta è nascosto |
|
Tipi di modello
|
templateTypes | array of string |
Elenco di uno o più tipi di modello di libreria |
|
Data modifica
|
modifiedDate | date |
Giorno dell'ultima modifica del modello di libreria |
|
Nome modello libreria
|
name | string |
Nome del modello di libreria |
|
Modalità condivisione modelli
|
sharingMode | string |
Ambito di visibilità del modello di libreria |
|
Messaggio di posta elettronica creatore
|
creatorEmail | string |
Indirizzo di posta elettronica dell'autore del documento della raccolta. |
|
ID del Gruppo
|
groupId | string |
Identificatore univoco del gruppo a cui appartiene il modello di libreria. |
|
stato
|
status | string |
Stato del documento della raccolta |
LibraryDocuments
Json che contiene l'oggetto matrice di modelli di libreria
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
page
|
page | page |
Informazioni sull'impaginazione per l'esplorazione della risposta |
|
Elenco modelli di libreria
|
libraryDocumentList | array of LibraryDocument |
Elenco di elementi del modello di libreria |
UserWidgetV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID modulo Web
|
id | string |
Identificatore univoco di un web form |
|
Data modifica
|
modifiedDate | string |
Data dell'ultima modifica del modulo Web |
|
Nascosto
|
hidden | boolean |
True se il contratto è nascosto per l'utente |
|
ID del Gruppo
|
groupId | string |
Identificatore univoco del gruppo |
|
Nome
|
name | string |
Nome del modulo Web |
|
stato
|
status | string |
Stato del modulo Web |
|
URL
|
url | string |
URL ospitato del modulo Web |
|
Javascript
|
javascript | string |
Codice Javascript incorporato del web form |
userWidgetListV6
Json che contiene l'oggetto matrice di web form dell'utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
page
|
page | page |
Informazioni sull'impaginazione per l'esplorazione della risposta |
|
Elenco modulo Web
|
userWidgetList | array of UserWidgetV6 |
Matrice di elementi del modulo Web |
UserWorkflowV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID flusso di lavoro
|
id | string |
Identificatore univoco di un flusso di lavoro |
|
Description
|
description | string |
Descrizione fornita per questo flusso di lavoro al momento della creazione |
|
Data di creazione
|
created | string |
Data di creazione del flusso di lavoro. Il formato sarebbe aaaaa-MM-gg'T'HH:mm:ssZ |
|
Data modifica
|
modified | string |
Data in cui è stato modificato il flusso di lavoro. Il formato sarebbe aaaaa-MM-gg'T'HH:mm:ssZ |
|
Nome
|
name | string |
Nome del flusso di lavoro |
|
Nome visualizzato
|
displayName | string |
Nome visualizzato del flusso di lavoro |
|
stato
|
status | string |
Stato del flusso di lavoro |
|
Ambito
|
scope | string |
Ambito del flusso di lavoro |
|
ID origine
|
originatorId | string |
Origine iniziale del flusso di lavoro |
|
ID ambito
|
scopeId | string |
Identificatore dell'ambito. Attualmente è applicabile solo per l'ambito GROUP e il valore sarà groupId. |
userWorkflowListV6
Json che contiene l'oggetto matrice del flusso di lavoro utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Elenco flussi di lavoro
|
userWorkflowList | array of UserWorkflowV6 |
Matrice di elementi del flusso di lavoro |
WorkflowDefaultParamsV6
Json che contiene l'oggetto params predefinito del flusso di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Valore predefinito
|
defaultValue | string |
Valore predefinito del campo se l'input per questo campo non viene specificato e questo campo è obbligatorio |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo corrente è visibile o meno. Se l'attributo visibile per questo campo è false, questo campo non deve essere visibile nell'interfaccia utente di creazione del contratto usando questo flusso di lavoro per l'utente |
CCsListInfoDescriptionV6
JSON che contiene informazioni dettagliate sul flusso di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Valori predefiniti
|
defaultValues | array of string |
Matrice di messaggi di posta elettronica predefiniti che verranno usati se non viene fornito alcun input per questo elemento elenco |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Etichetta
|
label | string |
Testo visualizzato per l'utente del flusso di lavoro che può essere utilizzato per l'elenco CC corrente |
|
Numero massimo di voci CC
|
maxListCount | integer |
Numero massimo di voci consentite nell'elenco CC corrente |
|
Min CCntries (Voci cc min)
|
minListCount | integer |
Numero minimo di voci consentite nell'elenco CC corrente |
|
CC List Name
|
name | string |
Nome dell'elenco CC corrente |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo corrente è visibile o meno. Se l'attributo visibile per questo campo è false, questo campo non deve essere visualizzato nella pagina di creazione del contratto utilizzando questo flusso di lavoro |
ExpirationFieldInfoDescriptionV6
JSON che contiene informazioni sulla scadenza
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Valore predefinito
|
defaultValue | string |
Valore predefinito del campo se l'input per questo campo non viene specificato e questo campo è obbligatorio |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Scadenza del contratto Max Days
|
maxDays | integer |
Numero massimo di giorni per la scadenza del contratto |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo corrente è visibile o meno. Se l'attributo visibile per questo campo è false, questo campo non deve essere visualizzato nella pagina di creazione del contratto utilizzando questo flusso di lavoro |
FileInfosDescriptionV6
JSON che contiene informazioni sui file
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Etichetta
|
label | string |
Visualizzare l'etichetta di questo campo per gli utenti esterni |
|
Nome
|
name | string |
Nome dell'elemento fileInfo |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Documenti della raccolta flussi di lavoro
|
workflowLibraryDocumentSelectorList | array of WorkflowLibraryDocumentV6 |
Elenco di documenti della raccolta del flusso di lavoro da cui è possibile selezionare un documento della raccolta del flusso di lavoro con questo oggetto fileInfo |
WorkflowLibraryDocumentV6
Json che contiene informazioni sul documento della raccolta del flusso di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Etichetta
|
label | string |
Testo visualizzato per questo modulo per gli utenti del flusso di lavoro |
|
Data di modifica
|
modifiedDate | string |
Data dell'ultima modifica del documento della raccolta. Il formato sarebbe aaa-MM-gg'T'HH:mm:ssZ. Ad esempio, ad esempio 2016-02-25T18:46:19Z rappresenta l'ora UTC |
|
Modalità condivisione
|
sharingMode | string |
Specifica chi deve avere accesso a questo documento della raccolta. GLOBAL sharing è un'operazione con restrizioni |
|
Tipi di modello
|
templateTypes | array of |
Elenco di uno o più tipi di modello di libreria |
|
ID documento raccolta flussi di lavoro
|
workflowLibDoc | string |
ID del documento della raccolta del flusso di lavoro che può essere fornito come file di input nella richiesta di creazione del contratto del flusso di lavoro personalizzato |
LocaleFieldInfoDescriptionV6
JSON che contiene informazioni dettagliate sulle impostazioni locali del flusso di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Impostazioni locali disponibili
|
availableLocales | array of string |
Impostazioni locali che è possibile scegliere per questo flusso di lavoro |
|
Valore predefinito
|
defaultValue | string |
Valore predefinito del campo se l'input per questo campo non viene specificato e questo campo è obbligatorio |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo corrente è visibile o meno. Se l'attributo visibile per questo campo è false, questo campo non deve essere visibile nell'interfaccia utente di creazione del contratto usando questo flusso di lavoro per l'utente |
MergeFieldInfoDescriptionV6
JSON che contiene informazioni dettagliate sul campo di merge
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Valore predefinito
|
defaultValue | string |
Valore predefinito del campo se l'input per questo campo non viene specificato e questo campo è obbligatorio |
|
Nome visualizzato
|
displayName | string |
Testo visualizzato che può essere visualizzato per questo campo personalizzato |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Nome campo personalizzato
|
fieldName | string |
Nome del campo personalizzato in questo flusso di lavoro |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo corrente deve essere visibile nella pagina di creazione del contratto. Se l'attributo visibile per questo campo è false, questo campo non deve essere visualizzato nella pagina di creazione del contratto utilizzando questo flusso di lavoro |
PasswordFieldInfoDescriptionV6
JSON che contiene informazioni dettagliate sulla password
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Parola chiave
|
defaultValue | string |
Valore predefinito del campo informazioni password |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Etichetta
|
label | string |
Etichetta del campo password |
|
Nome
|
name | string |
Nome del campo password |
|
Obbligatorio
|
required | boolean |
Indica se questo campo è obbligatorio o facoltativo |
|
Visibile
|
visible | boolean |
Indica se il campo informazioni sulla password è visibile nella pagina di creazione del contratto |
RecipientsListInfoDescriptionV6
Json che contiene informazioni dettagliate sull'elenco dei destinatari
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Consenti mittente
|
allowSender | boolean |
Indica se il mittente è consentito come destinatario |
|
Consenti mittente
|
allowfax | boolean |
Indica se il fax è consentito o meno |
|
Metodo di autenticazione
|
authenticationMethod | string |
Metodo di autenticazione per l'elenco di destinatari corrente per avere accesso per visualizzare e firmare il documento, |
|
Valore predefinito email/fax
|
defaultValue | string |
Un numero di posta elettronica o fax predefinito |
|
Modificabili
|
editable | boolean |
Indica se il campo corrente può essere modificato. Se l'attributo modificabile per questo campo è false, questo campo non deve essere fornito nella richiesta di creazione del contratto e il valore predefinito di questo campo verrà utilizzato nella creazione del contratto |
|
Etichetta
|
label | string |
Testo visualizzato per l'utente del flusso di lavoro che può essere utilizzato per l'elenco dei destinatari corrente |
|
Numero massimo di destinatari
|
maxListCount | integer |
Numero massimo di voci consentite nell'elenco dei destinatari corrente |
|
Destinatari minimi
|
minListCount | integer |
Numero minimo di voci consentite nell'elenco dei destinatari corrente |
|
Nome dell'elenco informazioni destinatario
|
name | string |
Nome dell'elenco informazioni destinatario corrente |
|
Ruolo partecipante
|
role | string |
Ruolo corrente del partecipante |
|
Visibile
|
visible | boolean |
Indica se il campo corrente è visibile. Se l'attributo visibile per questo campo è false, questo campo non deve essere visualizzato nell'interfaccia utente di creazione del contratto usando questo flusso di lavoro per l'utente |
WorkflowDescriptionV6
JSON che contiene informazioni dettagliate sul flusso di lavoro
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
agreementNameInfo
|
agreementNameInfo | WorkflowDefaultParamsV6 |
Json che contiene l'oggetto params predefinito del flusso di lavoro |
|
authoringInfo
|
authoringInfo | WorkflowDefaultParamsV6 |
Json che contiene l'oggetto params predefinito del flusso di lavoro |
|
Informazioni elenco CC
|
ccsListInfo | array of CCsListInfoDescriptionV6 |
Informazioni sul campo di input dell'elenco CC nella richiesta di creazione del contratto |
|
Data creazione flusso di lavoro
|
created | string |
Giorno in cui è stato creato il flusso di lavoro |
|
Descrizione flusso di lavoro
|
description | string |
Descrizione fornita per questo flusso di lavoro al momento della creazione |
|
Nome visualizzato flusso di lavoro
|
displayName | string |
Nome visualizzato del flusso di lavoro |
|
expirationInfo
|
expirationInfo | ExpirationFieldInfoDescriptionV6 |
JSON che contiene informazioni sulla scadenza |
|
Informazioni sui file
|
fileInfos | array of FileInfosDescriptionV6 |
Informazioni sul campo di input delle informazioni sul file nella richiesta di creazione del contratto |
|
localeInfo
|
localeInfo | LocaleFieldInfoDescriptionV6 |
JSON che contiene informazioni dettagliate sulle impostazioni locali del flusso di lavoro |
|
Info campi unione
|
mergeFieldsInfo | array of MergeFieldInfoDescriptionV6 |
Informazioni sul campo di input delle informazioni personalizzate nella richiesta di creazione del contratto |
|
messageInfo
|
messageInfo | WorkflowDefaultParamsV6 |
Json che contiene l'oggetto params predefinito del flusso di lavoro |
|
Data modifica
|
modified | string |
Giorno dell'ultima modifica del flusso di lavoro |
|
Nome flusso di lavoro
|
name | string |
Nome del flusso di lavoro |
|
passwordInfo
|
passwordInfo | PasswordFieldInfoDescriptionV6 |
JSON che contiene informazioni dettagliate sulla password |
|
Informazioni elenco destinatari
|
recipientsListInfo | array of RecipientsListInfoDescriptionV6 |
Informazioni sul campo di input delle informazioni di tipo recepients nella richiesta di creazione del contratto |
|
Ambito flusso di lavoro
|
scope | string |
Ambito del flusso di lavoro |
|
Stato flusso di lavoro
|
status | string |
Stato del flusso di lavoro |
|
ID origine flusso di lavoro
|
originatorId | string |
Origine iniziale del flusso di lavoro |
|
ID ambito flusso di lavoro
|
scopeId | string |
Identificatore dell'ambito. Attualmente è applicabile solo per l'ambito GROUP e il valore sarà groupId |
BooleanSettingInfoV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Value
|
value | boolean |
Valore dell'impostazione |
|
Ereditato
|
inherited | boolean |
True se l'impostazione viene ereditata dal relativo valore di gruppo o account |
SettingsInfoV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
libaryDocumentCreationVisible
|
libaryDocumentCreationVisible | BooleanSettingInfoV6 | |
|
sendRestrictedToWorkflows
|
sendRestrictedToWorkflows | BooleanSettingInfoV6 | |
|
userCanSend
|
userCanSend | BooleanSettingInfoV6 | |
|
widgetCreationVisible
|
widgetCreationVisible | BooleanSettingInfoV6 |
UserGroupInfoV6
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID del Gruppo
|
id | string |
Identificatore univoco del gruppo |
|
Amministratore del gruppo
|
isGroupAdmin | boolean |
True se l'utente è amministratore del gruppo |
|
Gruppo primario
|
isPrimaryGroup | boolean |
True se il gruppo è il gruppo primario dell'utente |
|
stato
|
status | string |
Stato dell'appartenenza al gruppo |
|
Data di creazione
|
createdDate | date |
Data di creazione del gruppo |
|
Nome del gruppo
|
name | string |
Nome del gruppo |
|
settings
|
settings | SettingsInfoV6 |
UserGroupsInfoV6
JSON che contiene l'elenco di gruppi per un determinato utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Elenco gruppi di utenti
|
groupInfoList | array of UserGroupInfoV6 |
Matrice di elementi di informazioni del gruppo di utenti |
binario
Questo è il tipo di dati di base 'binario'.
oggetto
Si tratta del tipo 'object'.
documento
Si tratta del tipo di dati di base 'file'.