mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-29 04:54:56 +02:00
1 line
6.8 KiB
JavaScript
1 line
6.8 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4469],{27668:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>b,default:()=>M,frontMatter:()=>J,metadata:()=>n,toc:()=>B});const n=JSON.parse('{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/deletedocument.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/deletedocument","permalink":"/docs/API-docs/deletedocument","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar_label":"Delete Document","hide_title":true,"hide_table_of_contents":true,"api":"eJy9Vttu20YQ/ZXJvjQBaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMG2rxI5PLMffbMrEXA3Iv4VlyYpCpJBy+mkUjJJ07aII0WsbgpCC5IUSBIOxScf7gCVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJVKmKRNvp7gIiERYclBXLs3VpoLIlhHeBOpiISkr2zGArx0OUPzsxlSmBmnykJVymYbOtQMNCaE5Fw9KWSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczIoT9Kmo6ylb9dZoT571nEwm/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux589i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xp6KO+lqdh6eFTiYnp0fHk6PJ9zfHb+KzH+LXb0aTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvDZoTRem5JCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3dHae51k9iFpqJTXd9T10dzaZ3B1vknD2RC9pEyAzlU6/baiH7D8d0Nnd6Sag1/sBXek5Kpk2JHRj7kl/23iG5kNrfr9bZQtqvoudYIfnbZCeksrJsGqYbnmEVh613+PbKdMFd4rZsmTDjqEQsRj3nDZeD5ixFqzSzXvurJwSsShCsD4ejz3qdGaWI2NJe5lrhTM/Skw5RivH82NRRw8l0NpnoKk6ep6AD5hLnT8tNd1m6Zor2RZrJ1ebkqGVv9JKRH0phqhuaBSEKbmmbFJnphHuCvTekr6WuW7KOz/eGy0fSSWmJJ4ioSDo4f/89Xcj0deh6b4X8L5yYM2CXFYpQJ1CpmgpZ4oOTFBPWCryXq1A6kC5Q564MpcBFXBWmC0StDiTSnK/Msy0o3XQ8n4EHwsKBTn+9J0jQEhpTorbHJQx96wnGMAqmBKHU31h3H3GLkWAMKu81OQ9eKJehHSBOiHoaxGBcYAaSAdy1klPgLJkcGYcUJbJRLJivpwOkwAlasyJjUXAfnMWbDusPTgzq3wAb1TVBMIWS6LQhqiJUj+CCzmnNvBmpaCAUlEKecUqIkhMStDdVQ5DpzAjH8CyeZlQo9QHdAEUzck1vddUkkcrWMMkIlHxxjCsLSsKDrXnMd+tM11pNumzzvCMbmykuBrBJ/1JM9FD5YkbQEl97+NP+ghuN232kWZeBpq+7O/DYrHYuwevdmXeylBUM3BkzVYubw6bWzMU37y8EpEI5Er/PrsmN5cJdZfwEZvjBjzuqBWThlqpRKnaO/bjQwGmOSUT0p4GRHj+9sM7mMPpaCKiwc3/CofH765+vvzt+pL1Mpm19+94NBlN+MgaH0rUA1Pdknqx3SJ3ru56OyP+p522I6BAyzC2CmXD/E3M646yb8Vgx42H6+w0EoXxgSHr9Qw9/eFUXfPxl4ocz4ZpJOboJM6Yp27XIpWen9PNbvpotC9/79bcV/DVm/HBWHqG1Uyvc1QVv4lI3NPqwXZeT+uop1l2tkWcJwnZMJDdG9U78+7i8t3lzaWIBFacvCHD3zcM3z2wgYOu7VJ/6wP/8hQ6KLBet9Ojrjf49tOjEl2MPZrzNK3r+l+YLKmx","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/getdocumentlist"}}');var l=o(74848),s=o(28453),d=o(33617),c=o.n(d),p=o(17543),i=o.n(p),r=o(86013),m=o.n(r),a=o(63723),u=o.n(a),k=(o(18766),o(79329),o(9303));const J={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEX5VLc2UqNBE9QuAtQRjBE5JDde7m52l7pA4Fu/pJ/WLymGF4myZCMG2rxI5PLMffbMrEXA3Iv4VlyYpCpJBy+mkUjJJ07aII0WsbgpCC5IUSBIOxScf7gCVMosPKxMBcGAo9LMCbylRGYy2UIzZ0oGuc2RH4lIGEsO2cJVKmKRNvp7gIiERYclBXLs3VpoLIlhHeBOpiISkr2zGArx0OUPzsxlSmBmnykJVymYbOtQMNCaE5Fw9KWSjlIRB1dRJHxYKTbkZWkVA2hplUlJxBkqz4CkoBJFvBZhZRtkcFLnIhKZcSWG4QktsdESC1uczIoT9Kmo6ylb9dZoT571nEwm/LcbQF+OztMUfJUk5H1WKbV6ISKRGB04U/FaoLVKJk0ux589i6/33WwzwYl1nPkgW+N9gg4FtHX/pyU7b3+xp6KO+lqdh6eFTiYnp0fHk6PJ9zfHb+KzH+LXb0aTyeRPEYllqVi2LyoGYr1BBrV9r/dgbc2GwO6kZvDZoTRem5JCIXUOC07mwhmdR2AVoScIbgWYo9SgMJD7D7NKzhn3dHae51k9iFpqJTXd9T10dzaZ3B1vknD2RC9pEyAzlU6/baiH7D8d0Nnd6Sag1/sBXek5Kpk2JHRj7kl/23iG5kNrfr9bZQtqvoudYIfnbZCeksrJsGqYbnmEVh613+PbKdMFd4rZsmTDjqEQsRj3nDZeD5ixFqzSzXvurJwSsShCsD4ejz3qdGaWI2NJe5lrhTM/Skw5RivH82NRRw8l0NpnoKk6ep6AD5hLnT8tNd1m6Zor2RZrJ1ebkqGVv9JKRH0phqhuaBSEKbmmbFJnphHuCvTekr6WuW7KOz/eGy0fSSWmJJ4ioSDo4f/89Xcj0deh6b4X8L5yYM2CXFYpQJ1CpmgpZ4oOTFBPWCryXq1A6kC5Q564MpcBFXBWmC0StDiTSnK/Msy0o3XQ8n4EHwsKBTn+9J0jQEhpTorbHJQx96wnGMAqmBKHU31h3H3GLkWAMKu81OQ9eKJehHSBOiHoaxGBcYAaSAdy1klPgLJkcGYcUJbJRLJivpwOkwAlasyJjUXAfnMWbDusPTgzq3wAb1TVBMIWS6LQhqiJUj+CCzmnNvBmpaCAUlEKecUqIkhMStDdVQ5DpzAjH8CyeZlQo9QHdAEUzck1vddUkkcrWMMkIlHxxjCsLSsKDrXnMd+tM11pNumzzvCMbmykuBrBJ/1JM9FD5YkbQEl97+NP+ghuN232kWZeBpq+7O/DYrHYuwevdmXeylBUM3BkzVYubw6bWzMU37y8EpEI5Er/PrsmN5cJdZfwEZvjBjzuqBWThlqpRKnaO/bjQwGmOSUT0p4GRHj+9sM7mMPpaCKiwc3/CofH765+vvzt+pL1Mpm19+94NBlN+MgaH0rUA1Pdknqx3SJ3ru56OyP+p522I6BAyzC2CmXD/E3M646yb8Vgx42H6+w0EoXxgSHr9Qw9/eFUXfPxl4ocz4ZpJOboJM6Yp27XIpWen9PNbvpotC9/79bcV/DVm/HBWHqG1Uyvc1QVv4lI3NPqwXZeT+uop1l2tkWcJwnZMJDdG9U78+7i8t3lzaWIBFacvCHD3zcM3z2wgYOu7VJ/6wP/8hQ6KLBet9Ojrjf49tOjEl2MPZrzNK3r+l+YLKmx",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},b=void 0,h={},B=[];function y(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(k.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,l.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(k.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(i(),{parameters:[{name:"document_id",in:"path",description:"Provide objectId of document to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}]}),"\n",(0,l.jsx)(m(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Document deleted successfully!",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",example:"Bxh2aspHp3"},deletedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},xml:{name:"delete"},title:"delete"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function M(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); |