Navigiere zu https://secure.adobesign.com/public/docs/restapi/v6.
Zuletzt aktualisiert am
25. Februar 2025
Wenn du die Acrobat Sign REST v6-API verwendest, kannst du deine signierten Vereinbarungen dauerhaft löschen, indem du die Funktion DELETE /agreements verwendest.
Schritte
Aktivieren der API-Data-Governance
Die API-Löschfunktion ist standardmäßig deaktiviert.
Um die Funktion DELETE /agreements/{agreementId} zu aktivieren, müssen Konto-Admins ein Support-Ticket an den Acrobat Sign-Support senden.
Schrittweise Anweisungen zur manuellen Datenspeicherung findest du im Überblick über Data Governance/Datenaufbewahrung.
Identifiziere die Vereinbarungs-IDs, die gelöscht werden sollen.
-
-
Wähle im Abschnitt Vereinbarungen die Option GET /agreements aus.
-
Wähle die Schaltfläche Autorisieren aus, um ein Zugriffstoken zu erstellen.
-
Autorisiere den Bereich (agreement_read:account).
-
Wähle Zugriff erlauben, wenn du dazu aufgefordert wirst.
Dadurch wird eine Auflistung deiner Vereinbarungen, einschließlich der Vereinbarungs-IDs, erstellt:
{ "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 } ] }
Verwenden der Delete-Endpunkte:
Es gibt drei Endpunkte für DELETE/agreements.
- DELETE /agreements/{agreementId}: Löscht die Vereinbarung. Die Vereinbarung ist auf der Seite Verwalten der nutzenden Person nicht mehr sichtbar.
- DELETE /agreements/{agreementId}/documents: Löscht alle Dokumente im Zusammenhang mit einer Vereinbarung. Die Vereinbarung ist auf der Seite Verwalten der nutzenden Person sichtbar.
- DELETE /agreements/{agreementId}/shares: Löscht die Freigabebeziehungen zwischen der Vereinbarung und einer nutzenden Person.
Schritte zum Verwenden der Delete-Endpunkte:
-
Wähle die DELETE/agreements-Funktion aus, die ausgeführt werden soll.
-
Wähle die Schaltfläche Autorisieren mit dem agreement_retention scope und Zugriff erlauben aus, wenn du dazu aufgefordert wirst.
-
Gib die Vereinbarungs-ID der Vereinbarung, die du löschen möchtest, an.
-
Sobald die Vereinbarung gelöscht wurde, hat der Antworttext keinen Inhalt mehr.
Fehler, wenn Delete/agreements deaktiviert ist
Wenn die Funktion DELETE /agreements nicht aktiviert ist, erhältst du folgende Antwort:
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "Für den Vorgang müssen einige Kontoeinstellungen aktiviert werden. Wende dich an das Adobe Sign-Team, um die Einstellungen zu aktivieren.“
}
