Als u Acrobat Sign REST v6 API gebruikt, kunt u uw ondertekende overeenkomsten permanent verwijderen met de bewerking DELETE /agreements.
Stappen
API-datagovernance inschakelen
De functie voor het verwijderen van een API is standaard uitgeschakeld.
Om de bewerking DELETE /agreements/{agreementId} in te schakelen moet de accountbeheerder een ondersteuningsticket indienen bij Acrobat Sign-ondersteuning.
Bekijk voor stapsgewijze instructies voor het handmatig bewaren van gegevens het Overzicht van datagovernance/dataretentie.
De agreementID's aangeven die u wilt verwijderen
-
-
Onder de sectie Overeenkomsten selecteert u GET /agreements.
-
Selecteer de knop Autoriseren om een toegangstoken te maken.
-
De scope autoriseren (agreement_read:account)
-
Verleen toegang als hierom wordt gevraagd.
Hierdoor wordt een lijst gemaakt met uw overeenkomsten inclusief overeenkomst-ID's:
{"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}]}{ "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 } ] }{ "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 } ] }
De DELETE-eindpunten gebruiken:
Er zijn drie DELETE/agreements-eindpunten.
- DELETE /agreements/{agreementId}: verwijdert de overeenkomst. De overeenkomst is niet langer zichtbaar op pagina Beheren van de gebruiker.
- DELETE /agreements/{agreementId}/documents: verwijdert alle documenten van een overeenkomst. De overeenkomst is zichtbaar op de pagina Beheren van de gebruiker.
- DELETE /agreements/{agreementId}/shares: verwijdert relaties voor delen tussen de overeenkomst en een gebruiker.
Stappen om de DELETE-eindpunten te gebruiken:
-
Selecteer de DELETE/agreements-bewerking die moet worden uitgevoerd.
-
Selecteer de knop Autoriseren met de agreement_retention scope en Toegang verlenen als hierom wordt gevraagd.
-
Geef de agreementId op voor de overeenkomst die u wilt verwijderen.
-
Zodra de overeenkomst is verwijderd, bevat de hoofdtekst van de reactie 'geen inhoud'.
Fout wanneer Delete /agreements is uitgeschakeld
Als de bewerking DELETE /agreements niet is ingeschakeld, krijgt u de volgende reactie:
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "Voor deze bewerking moeten enkele accountinstellingen worden ingeschakeld. Neem contact op met het Adobe Sign-team om de instellingen in te schakelen."
}
