Удаление соглашения с помощью API-интерфейса

Поиск

Последнее обновление 18 февр. 2025 г.

Если вы используете API-интерфейс Acrobat Sign REST v6, вы можете безвозвратно удалить подписанные соглашения, используя операцию DELETE /agreements.

Действия

Включение управления данными с помощью API-интерфейса

По умолчанию функция удаления с помощью API-интерфейса отключена.

Чтобы включить операцию DELETE /agreements/{agreementId}, администратор учетной записи должен отправить заявку в службу поддержки Acrobat Sign.

Чтобы получить пошаговые инструкции по хранению данных вручную, см. Обзор функции управления данными/хранения данных.

Определите agreementID соглашения, которое необходимо удалить

Перейдите по адресу https://secure.adobesign.com/public/docs/restapi/v6.
В разделе Соглашения выберите GET /agreements.
Нажмите кнопку Авторизовать для создания маркера доступа.
Авторизуйте область (agreement_read:account)
При появлении запроса разрешите доступ.

Появится список всех завершенных соглашений с идентификаторами:
{
"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 } ] }
```
{
  &quot;userAgreementList&quot;: [
    {
      &quot;id&quot;: &quot;CBJCHBCAABAAhKRLf4ITY7QiGc&quot;,
      &quot;type&quot;: &quot;AGREEMENT&quot;,
      &quot;name&quot;: &quot;Test Agreement&quot;,
      &quot;groupId&quot;: &quot;CBJCHBCAABAAzHAworuZFe9&quot;,
      &quot;displayDate&quot;: &quot;2024-11-22T13:49:07Z&quot;,
      &quot;displayParticipantSetInfos&quot;: [
        {
          &quot;displayUserSetMemberInfos&quot;: [
            {
              &quot;fullName&quot;: &quot;Test Person&quot;,
              &quot;email&quot;: &quot;Someone@email.com&quot;,
              &quot;company&quot;: &quot;MyBusiness, Inc.&quot;,
              &quot;deliverableEmail&quot;: true
            }
          ]
        }
      ],
      &quot;latestVersionId&quot;: &quot;3AAABLblqZhCpUEwbU5ASfzb3WZDVyw1YBtKJ8lRIXc0kJ8Rtaz&quot;,
      &quot;status&quot;: &quot;OUT_FOR_SIGNATURE&quot;,
      &quot;hidden&quot;: false,
      &quot;esign&quot;: true
    }
  ]
}
```

Использование конечных точек Delete:

Существует три конечных точки DELETE/agreements.

DELETE /agreements/{agreementId}: удаляет соглашение. Соглашение перестает отображаться на странице Управление пользователя.
DELETE /agreements/{agreementId}/documents: удаляет все документы соглашения. Соглашение отображается на странице Управление пользователя.
DELETE /agreements/{agreementId}/shares: удаляет отношения общего доступа между соглашением и пользователем.

Шаги по использованию конечных точек Delete:

Выберите операцию DELETE/agreements/ для запуска.
Нажмите кнопку Авторизовать для области agreement_retention и при появлении запроса разрешите доступ.
Укажите идентификатор соглашения, которое вы хотите удалить.
После удаления соглашения текст ответа выглядит как «no content».

Ошибка при отключенном параметре Delete /agreements

Если операция DELETE /Agreements не включена, будет получен следующий ответ:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": "Для этой операции требуется активировать несколько параметров учетной записи. Обратитесь к специалистам Adobe Sign, чтобы активировать эти параметры".

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": "Для этой операции требуется активировать несколько параметров учетной записи. Обратитесь к специалистам Adobe Sign, чтобы активировать эти параметры". }

{
  &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
  &quot;message&quot;: &quot;Для этой операции требуется активировать несколько параметров учетной записи. Обратитесь к специалистам Adobe Sign, чтобы активировать эти параметры&quot;.
}

Получайте помощь быстрее и проще

Новый пользователь?