Si utilizas la API REST de Acrobat Sign v6, puedes eliminar de forma permanente los acuerdos firmados mediante la operación DELETE /agreements.
Pasos
Habilitación de la gobernanza de datos de la API
La función Eliminar de la API está desactivada de forma predeterminada.
Para habilitar la operación DELETE /agreements/{agreementId}, el administrador de la cuenta debe enviar un ticket de asistencia técnica al servicio de soporte de Acrobat Sign.
Para obtener instrucciones paso a paso sobre la retención de datos manual, consulta la Información general sobre la gobernanza y retención de datos.
Identificar los agreementID que se deben eliminar
-
-
En la sección Acuerdos, seleccione GET /agreements.
-
Selecciona el botón Autorizar para crear un token de acceso.
-
Autoriza el ámbito (agreement_read:account)
-
Permite el acceso cuando el sistema lo solicite.
Esto hará que aparezca una lista de los acuerdos completados con sus ID de acuerdo:
{ "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 } ] }
Uso de puntos finales Eliminar:
Hay tres puntos finales DELETE/agreements.
- DELETE /agreements/{agreementId}: elimina el acuerdo. El acuerdo deja de estar visible en la página Administrar del usuario.
- DELETE /agreements/{agreementId}/documents: elimina todos los documentos de un acuerdo. El acuerdo está visible en la página Administrar del usuario.
- DELETE /agreements/{agreementId}/shares: elimina las relaciones de uso compartido entre el acuerdo y un usuario.
Pasos para utilizar los puntos finales Eliminar :
-
Selecciona la operación DELETE/agreements/ que se va a ejecutar.
-
Selecciona el botón Autorizar con el ámbito agreement_retention y Permitir acceso si el sistema lo solicita.
-
Proporciona el agreementId del acuerdo que deseas eliminar.
-
Una vez eliminado el acuerdo, el cuerpo de respuesta “no tiene contenido”.
Error cuando la operación Eliminar /acuerdos está deshabilitada
Si la operación DELETE / agreements no está habilitada, recibirás la siguiente respuesta:
{
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "Para llevar a cabo esta operación es necesario habilitar algunos valores de configuración de la cuenta. Póngase en contacto con el equipo de Adobe Sign para habilitar la configuración".
}
