Odstraňte dohodu pomocí rozhraní API.

Hledat

Naposledy aktualizováno 18. 2. 2025

Pokud používáte rozhraní REST API služby Acrobat Sign verze 6, můžete své podepsané dohody trvale odstranit pomocí operace DELETE /agreements.

Postup

Povolení správy dat rozhraní API

Funkce odstranění API je ve výchozím nastavení vypnutá.

Chcete-li povolit operaci DELETE /agreements/{agreementId}, musí správce účtu odeslat podpoře služby Acrobat Sign žádost o podporu.

Podrobné pokyny k ručnímu uchovávání dat naleznete v části Přehled pravidel pro správu a uchovávání dat.

Identifikujte ID dohod, které potřebujete odstranit

Přejděte na adresu https://secure.adobesign.com/public/docs/restapi/v6.
V části Dohody vyberte možnost GET /agreements.
Výběrem tlačítka Autorizovat vytvořte přístupový token.
Autorizace rozsahu (agreement_read:account)
Po vyzvání povolte přístup.

Tím vytvoříte seznam dohod včetně jejich ID:
{
"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
    }
  ]
}
```

Použití odstranění koncových bodů:

Existují tři koncové body operace DELETE/agreements.

Operace DELETE /agreements/{agreementId}: Odstraní dohodu. Dohoda již není viditelná na stránce uživatele Správa.
Operace DELETE /agreements/{agreementId}/documents: Odstraní všechny dokumenty dohody. Dohoda je viditelná na stránce uživatele Správa.
Operace DELETE /agreements/{agreementId}/shares: Odstraní vztahy sdílení mezi dohodou a uživatelem.

Postup použití odstranění koncových bodů:

Vyberte operaci DELETE/agreements/, kterou chcete spustit.
Vyberte tlačítko Autorizovat spolu s možností agreement_retention scope a v případě zobrazení výzvy povolte přístup.
Zadejte prvek agreementId dohody, kterou chcete odstranit.
Po odstranění dohody bude tělo odpovědi zahrnovat část „žádný obsah“.

Chyba, když je operace DELETE /agreements zakázána

Pokud operace DELETE /agreements není povolena, zobrazí se následující odpověď:

{

"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

"message": „K dokončení operace je potřeba povolit určitá nastavení účtu. Ve věci povolení nastavení se obraťte na tým Adobe Sign.“

}

{ "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED", "message": „K dokončení operace je potřeba povolit určitá nastavení účtu. Ve věci povolení nastavení se obraťte na tým Adobe Sign.“ }

{
  &quot;code&quot;: &quot;DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED&quot;,
  &quot;message&quot;: „K dokončení operace je potřeba povolit určitá nastavení účtu. Ve věci povolení nastavení se obraťte na tým Adobe Sign.“
}

Získejte pomoc rychleji a snáze

Nový uživatel?