Se stai utilizzando API REST v6 di Acrobat Sign, puoi eliminare definitivamente i tuoi accordi firmati utilizzando l’operazione DELETE /agreements.
Passaggi
Abilitazione dell’API governance dei dati
La funzione API Delete non è attivata per impostazione predefinita.
Per abilitare l’operazione DELETE /agreements/{agreementId}, l’amministratore dell’account deve inviare un ticket di supporto al supporto di Acrobat Sign.
Per istruzioni dettagliate sulla conservazione manuale dei dati, consulta Panoramica sulla governance/conservazione dei dati.
Identifica gli agreementID che devi eliminare
-
-
Sotto la sezione Accordi, seleziona GET /agreements.
-
Seleziona il pulsante Autorizza per creare un token di accesso.
-
Autorizza l’ambito (agreement_read:account)
-
Consenti accesso quando richiesto.
Questo genererà un elenco dei tuoi accordi completo di ID accordo:
{ "userAgreementList": [ { "id": "CBJCHBCAABAAhKRLf4ITY7QiGc", "type": "AGREEMENT", "name": "Test Agreement", "groupId": "CBJCHBCAABAAzHAworuZFe9", "displayDate": "2024-11-22T13:49:07Z", "displayParticipantSetInfos": [ { "displayUserSetMemberInfos": [ { "fullName": "Test Person", "email": "Someone@email.com", "company": "MyBusiness, Inc.", "deliverableEmail": true } ] } ], "latestVersionId": "3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz", "status": "OUT_FOR_SIGNATURE", "hidden": false, "esign": true } ] }
Utilizzo degli endpoint Elimina:
Ci sono tre endpoint DELETE/agreements.
- DELETE /agreements/{agreementId}: elimina l‘accordo. L’accordo non è più visibile sulla pagina Gestisci dell‘utente.
- DELETE /agreements/{agreementId}/documents: elimina tutti i documenti correlati a un accordo. L‘accordo è visibile sulla pagina Gestisci dell’utente.
- DELETE /agreements/{agreementId}/shares: elimina le relazioni di condivisione tra l’accordo e un utente.
Passaggi per utilizzare gli endpoint Elimina:
-
Seleziona l’operazione DELETE /agreements da eseguire.
-
Seleziona il pulsante Autorizza con agreement_retention scope e Consenti accesso se richiesto.
-
Fornisci il codice agreementId dell’accordo da eliminare.
-
Una volta eliminato l’accordo, il corpo della risposta contiene “nessun contenuto”.
Errore quando l’opzione DELETE/agreements è disabilitata
Se l’operazione DELETE/agreeemnts non è abilitata, riceverai la seguente risposta:
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": “L’operazione richiede l’abilitazione di alcune impostazioni account. Contattare il team Adobe Sign per attivare le impostazioni.”
}
