mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 12:17:41 +02:00
1 line
7.1 KiB
JavaScript
1 line
7.1 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4001],{23661:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>b,contentTitle:()=>Y,default:()=>v,frontMatter:()=>f,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","source":"@site/docs/API-docs/v1/deletedocument.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/deletedocument","permalink":"/docs/API-docs/v1/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":"eJy9V9tu3DYQ/ZUJX5oY8mp9SYrqqW5tJEaNxIgdBKizMLjSSGJMkQxJ7QULAX3oH/QP+mn5kmIoaVfrdYwEbfNir6i5nhnOGa2Y54VjyQ071WldofKOTSKWoUutMF5oxRJ2XSKcokSPkHVScHJ5DlxKPXew1DV4DRYrPUNwBlORi3QjmltdkZBdH7kRi5g2aDl5OM9YwrJgvxdgETPc8go9WopuxRSvkMQ6gVuRsYgJis5wX7L7IV9aPRMZgp5+xNSfZ6DzTUBeQ+uORczip1pYzFjibY0Rc34pyZETlZEkgAsjdYYsybl0JJCWWHGWrJhfmiDprVAFi1iubcX98AQXPFhJmCkPp+Uhdxlrmgl5dUYrh47sHI7H9G87gb4cXaQZuDpN0bm8lnL5hEUs1coTUsmKcWOkSAOW8UdH6qvdMFskCFhLyHvROu8BeiihTfi/LCh488ocsSbqa3XiH1c6HB8e7R+M98c/Xh+8SI5/Sp6/GI3H499ZxBaVJN2+qNwj2fXCy81zsyPW1mwo2J00JHz8EIxXukJfClXAnMCcW62KCIxE7hC8XQIvuFAguUf7H6KK1mr7ODrfFlkzyFooKRTe9j10ezwe3x6sQTh+pJeU9pDrWmXfN9WH/D+e0PHt0Tqh57sJnasZlyILQ+ha36H6vvkM3fvW/W63ilYovGdbyQ7P2yQdprUVfhkm3WKfG7Hfvk9uJjQuqFP0ZkqG6ehLlrC4n2nxajAZG0Ym7ayfnbWVLGGl98Ylcey4yqZ6MdIGlROFknzqRqmuYm5EPDtgTXRfgxvzDdJY73+bgvO8EKp4XGuyQemKKtkWawurdcm4Eb/hkkV9KYZSHWmUyDO0oWxC5ToodwV6Y1BdiUKF8s4OdqjlPcpUV0gs4kuEXvzzn38Hjb4OofuefFAf1JvagtFztHktgasMcokLMZUY5LEK79Y06pBXEp2TSxDKY2E50a4ohOcSCBoaGSk3fCqkoKYlMd3y66Dv3Qjel+hLtPTqB4vAIcMZSup14LXXFfdkas2Kc23vciL0CDhMaycUOgeoSq5SEuzhj0Bb4ApQebTGCofgvKWoRRubVt7y1EPFFS+QbEdbKGUoBfUmWD2tnQenZR1CBs+F1BYz6BNSiJkbEYhnRMMWgU5TXRmLJXXKDKGoRYYuglRnCC7cUUpBZTBF58FQLCJFR0ZrJXV6F+pGRApG08gQXNJ+MIyR1L3lyhGpd8tLV4M1YMZqYmRsA9zbe+eQKnwh1J1L9vY+qH24WTfTe5w64XHytO/6+Xy+0+3PtnVeCv+qnsJbNNoJr+1yo10IX9bTcEOGRtYPraWXqDD0z+AGbGxkOnW7F45O4xKlia/QU4e4+OTyPEzZZ/D5j7/gArlVUOp5261pbVEuoehdEXJt5VvY1kMSch0aryTE07b5aPtC5wlB2gq2b/P2tbOYY9ggQyE37ozozN/0YQJF/2/SpHFNXczTwCZYcSHbsfLzfTthsqOt3Jv8Cu1MpNgNti9UOA7CMYuYFCkqhwPGOHl5eQEzOBqNWTQYkV9R7fji/Nez11dnFA3drBaxg9F4NKYjo52vuBq46rb50826vQX2akOm/9Py301qjwsfG8lFoMiQ86rjths2+BhIhnv/JGKldp5EVqspd/jOyqah4081WiLRScRm3Ao+pYF+s2KZcPQ7Wy/xX8z26dvue+AZfPUnxIO59FSkiIdmXNb0xCJ2h8t7nzHNpIl6PqJgW4mTNEXjB7o7O83WYnB6dnF2fcYiRhdsmwrvAhV2P8jBg6Ftc2QbA/0lun5QYbVqabZp1vLtqy9qdDn20oTTpGmafwDN2xi/","sidebar_class_name":"delete api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Revoke Document","permalink":"/docs/API-docs/v1/revokedocument"},"next":{"title":"Get Document list from status","permalink":"/docs/API-docs/v1/getdocumentlist"}}');var s=o(74848),i=o(28453),d=o(33617),c=o.n(d),l=o(17543),a=o.n(l),p=o(86013),r=o.n(p),m=o(63723),u=o.n(m),h=(o(18766),o(79329),o(9303));const f={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:"eJy9V9tu3DYQ/ZUJX5oY8mp9SYrqqW5tJEaNxIgdBKizMLjSSGJMkQxJ7QULAX3oH/QP+mn5kmIoaVfrdYwEbfNir6i5nhnOGa2Y54VjyQ071WldofKOTSKWoUutMF5oxRJ2XSKcokSPkHVScHJ5DlxKPXew1DV4DRYrPUNwBlORi3QjmltdkZBdH7kRi5g2aDl5OM9YwrJgvxdgETPc8go9WopuxRSvkMQ6gVuRsYgJis5wX7L7IV9aPRMZgp5+xNSfZ6DzTUBeQ+uORczip1pYzFjibY0Rc34pyZETlZEkgAsjdYYsybl0JJCWWHGWrJhfmiDprVAFi1iubcX98AQXPFhJmCkPp+Uhdxlrmgl5dUYrh47sHI7H9G87gb4cXaQZuDpN0bm8lnL5hEUs1coTUsmKcWOkSAOW8UdH6qvdMFskCFhLyHvROu8BeiihTfi/LCh488ocsSbqa3XiH1c6HB8e7R+M98c/Xh+8SI5/Sp6/GI3H499ZxBaVJN2+qNwj2fXCy81zsyPW1mwo2J00JHz8EIxXukJfClXAnMCcW62KCIxE7hC8XQIvuFAguUf7H6KK1mr7ODrfFlkzyFooKRTe9j10ezwe3x6sQTh+pJeU9pDrWmXfN9WH/D+e0PHt0Tqh57sJnasZlyILQ+ha36H6vvkM3fvW/W63ilYovGdbyQ7P2yQdprUVfhkm3WKfG7Hfvk9uJjQuqFP0ZkqG6ehLlrC4n2nxajAZG0Ym7ayfnbWVLGGl98Ylcey4yqZ6MdIGlROFknzqRqmuYm5EPDtgTXRfgxvzDdJY73+bgvO8EKp4XGuyQemKKtkWawurdcm4Eb/hkkV9KYZSHWmUyDO0oWxC5ToodwV6Y1BdiUKF8s4OdqjlPcpUV0gs4kuEXvzzn38Hjb4OofuefFAf1JvagtFztHktgasMcokLMZUY5LEK79Y06pBXEp2TSxDKY2E50a4ohOcSCBoaGSk3fCqkoKYlMd3y66Dv3Qjel+hLtPTqB4vAIcMZSup14LXXFfdkas2Kc23vciL0CDhMaycUOgeoSq5SEuzhj0Bb4ApQebTGCofgvKWoRRubVt7y1EPFFS+QbEdbKGUoBfUmWD2tnQenZR1CBs+F1BYz6BNSiJkbEYhnRMMWgU5TXRmLJXXKDKGoRYYuglRnCC7cUUpBZTBF58FQLCJFR0ZrJXV6F+pGRApG08gQXNJ+MIyR1L3lyhGpd8tLV4M1YMZqYmRsA9zbe+eQKnwh1J1L9vY+qH24WTfTe5w64XHytO/6+Xy+0+3PtnVeCv+qnsJbNNoJr+1yo10IX9bTcEOGRtYPraWXqDD0z+AGbGxkOnW7F45O4xKlia/QU4e4+OTyPEzZZ/D5j7/gArlVUOp5261pbVEuoehdEXJt5VvY1kMSch0aryTE07b5aPtC5wlB2gq2b/P2tbOYY9ggQyE37ozozN/0YQJF/2/SpHFNXczTwCZYcSHbsfLzfTthsqOt3Jv8Cu1MpNgNti9UOA7CMYuYFCkqhwPGOHl5eQEzOBqNWTQYkV9R7fji/Nez11dnFA3drBaxg9F4NKYjo52vuBq46rb50826vQX2akOm/9Py301qjwsfG8lFoMiQ86rjths2+BhIhnv/JGKldp5EVqspd/jOyqah4081WiLRScRm3Ao+pYF+s2KZcPQ7Wy/xX8z26dvue+AZfPUnxIO59FSkiIdmXNb0xCJ2h8t7nzHNpIl6PqJgW4mTNEXjB7o7O83WYnB6dnF2fcYiRhdsmwrvAhV2P8jBg6Ftc2QbA/0lun5QYbVqabZp1vLtqy9qdDn20oTTpGmafwDN2xi/",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},Y=void 0,b={},y=[];function g(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Delete Document"}),"\n",(0,s.jsx)(c(),{method:"delete",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,s.jsx)(t.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,s.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,s.jsx)(a(),{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,s.jsx)(r(),{title:"Body",body:void 0}),"\n",(0,s.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 v(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(g,{...e})}):g(e)}}}]); |