WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1be2b94cd3c25d9ccdc5d6fc8b8232e96b56b09e
OpenSign/assets/js/52d5c0f9.13bbb31c.js
T

1 line
9.2 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),t=a(58219),d=(a(62316),a(51039)),i=a.n(d),r=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsxU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl7Dv8rXVS5Ej0/OvmPlpznSxc8hr1pqDCCx+q4XFHFJva4zA+bUkQ05URhIAV0bqHCEtuHQEyEqsOKQb8GsTkN4KtYAICm0r7ocSXPFwSwqmPJ6Xx9zl0DQzsuqMVg4d3XOcJPT3PIA+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM7hWbBDeRukw6y2wq9Dk69G3IhRe57ezahTKvSl3g2IMBh8CSnEfTvHm8FQaICutMt+bNRWQgql98alcew8Xwi1GHFjxtqgcmKhJJ+7caarmBsRLydARnunboi4lptnrm0Z4kZ8xjVEfeRDVDeeSuQ52sCSUIUOyh0fVwbVjViowOZycjDEbkvhmHDhuI8xZJYV2rI9bTbnDnOmFfMlhkOSn4wn24kcVMfsXt2rG10hqx0WtWRSqEeX3qsRu7sqCpEJLtlfOHfC4+xdz9zT09MBY0dB55PwZT1nFo3ewRdBGGgdam1fjiACj7ZyV8UN2qXIsMvSK6biAI67UudZKHWsuKDsdqJf9pWo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTC0vzHnazY938/xZte7/9Ga7SrV48rHRnIROjJEvula6Q4GazcdbthZBKV2niCbDdXXFyubhsTfarTUs7MIltwKPqeCvttALhw959t1+Wq07/7sNu8R++5l/WIsfSsq6sMllzW9QQSPuN77YGhmTdT3IznbIs6yDI0f6B6M0Gdz6Pzi8uL2AiLgNZE3HAWPYRR0D2TgRdeez4jWB/ptolcUfqIi+Izrn7fw9uRVhS7EHk00zZqm+QdMLWXL",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete document by ID",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:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete document by ID",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfWoA2ZKTtEOFYVi2BJ3RYAmWFAOWGAEtnSw2FMmSlGPD0H8fjpJsxU6Cftj2xZaOz/HunnvTBjxfOEjv4FxndYXKO5hFkKPLrDBeaAUp3JbIzlGiR5Z3KHZ2PWVcSv3k2FrXzGtmsdJLZM5gJgqR7aCF1RWB7FbkxhCBNmg5WZjmkEIe7u8BEIHhllfo0ZJ3G1C8QoJ1gAeRQwSCvDPcl7Dv8rXVS5Ej0/OvmPlpznSxc8hr1pqDCCx+q4XFHFJva4zA+bUkQ05URhIAV0bqHCEtuHQEyEqsOKQb8GsTkN4KtYAICm0r7ocSXPFwSwqmPJ6Xx9zl0DQzsuqMVg4d3XOcJPT3PIA+HZ2nOXN1lqFzRS3l+geIINPKE1PpBrgxUmSBy/irI/XNoZstE0SsJea9aI33BL0U0M79X1fkvPndnEAT9bk6828rHSfHJ6NJMkp+vJ18SE8/pu8/jJMk+RsiWFWSdPukco90rxde7t6bA1ibsyGwkzQEPk1O36BRac8KXav8X+QOrdX2bQ5est8MIhBKCoUPfT08nCanDyfbgN4fBjRVSy5FHvrvVj+i+n/jGZr3rfnDRIkWFM7hWbBDeRukw6y2wq9Dk69G3IhRe57ezahTKvSl3g2IMBh8CSnEfTvHm8FQaICutMt+bNRWQgql98alcew8Xwi1GHFjxtqgcmKhJJ+7caarmBsRLydARnunboi4lptnrm0Z4kZ8xjVEfeRDVDeeSuQ52sCSUIUOyh0fVwbVjViowOZycjDEbkvhmHDhuI8xZJYV2rI9bTbnDnOmFfMlhkOSn4wn24kcVMfsXt2rG10hqx0WtWRSqEeX3qsRu7sqCpEJLtlfOHfC4+xdz9zT09MBY0dB55PwZT1nFo3ewRdBGGgdam1fjiACj7ZyV8UN2qXIsMvSK6biAI67UudZKHWsuKDsdqJf9pWo9KTIUDkcFOfZp+tLdjJOIBoUx3e4HF9Of7v44+aCbqXyalM0GSfjhERGO19xNTC0vzHnazY938/xZte7/9Ga7SrV48rHRnIROjJEvula6Q4GazcdbthZBKV2niCbDdXXFyubhsTfarTUs7MIltwKPqeCvttALhw959t1+Wq07/7sNu8R++5l/WIsfSsq6sMllzW9QQSPuN77YGhmTdT3IznbIs6yDI0f6B6M0Gdz6Pzi8uL2AiLgNZE3HAWPYRR0D2TgRdeez4jWB/ptolcUfqIi+Izrn7fw9uRVhS7EHk00zZqm+QdMLWXL",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},f={},b=[{value:"Request",id:"request",level:2}];function I(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Delete document by ID"})}),"\n",(0,l.jsx)(i(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{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)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(I,{...e})}):I(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink