WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-08 10:47:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/52d5c0f9.0d9e94c0.js
T

1 line
9.6 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:()=>v,contentTitle:()=>j,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>y});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"deletedocument",title:"Delete document by ID",description:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/deletedocument",title:"Delete document by ID",description:"delete a document",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:"delete a document",sidebar_label:"Delete document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu4zYQ/RV2njaAYimOFwWEomjQBAtjgyaoU/QhMQxaGlncSCSXpBwbgv69GOpiOZfdtCj2xZbIGfKcMzfV4PjGQnwPlyqpSpTOwjKAFG1ihHZCSYghxQIdMs7SzgYCUBoNp/15OliMtjU3vESHhs6uQfISIYbdKdfi1KlHlBCAoLNz5CkaCMDg10oYTCF2psIArNsX5GNFqQuEAHCnC5UixBkvLBkkOZYc4hrcXntLZ4TcQEOm3DvFBFNasZGT3W63gyYYoPRYVyLtoWjucnjO/daorUiRqfUXTNw8ZSobZGBOsZb5/4k/gEyZkrvxyoGQzqfrfMptCk2zpFutVtKipXOmUUR/xwT6uHZIU2arJEFrs6oo9j9BAImSjoIW18C1LkTiwxp+seRev4TZKkExNpQETrSXJ57bYCWrcu3jOkCfRlETQInW8g2+RvtA8juYmyYAJ5w3FbIQEle9DqtpFK1+hqYhm1k0+4YeUjmWqUqmP1KEWTT71yKMgH6L+Syarc4H5h9fMp/LLS9Eyi5u5+yOavDHEv/4XuJjnK7FSZx2ZUF+Xf2K1qjtJUeqjNdbNSwmlRFu71vRuAfF90sqohJdrg5tzLcvl0MMYV/pYT3qFw3QkWbbN7fKFNTInNM2DkOu9aTvOgVf20miypBrEW7PgC7rwSxI2Va8I0iDMlyLz7iH4PvNkzgKmSnv3Olwo1EuxEZ6FbdnL/raXS4sE9Zv99x86FmmDHvmzdbcYsqUZC5Hv0nr55MzZjUmIuuyZsIe5INcqBJZZTGrClYI+WjjB3nK7m+yTCSCF+xvXFvhcPmhV+zp6emFYife55NwebVmBrU6mG/8opd17DW8nEAADk1pb7IFmq1IsIvOG1eF3jjsaoEnvhaw5IKi2i399tyJUq4QCUqLo6S8+HR7zc4nEQSjpHgH5PB6/vvVH4srOpXSqg3R2SSaRLSklXUll6OLLtuJPAyi9Z7NL5/HuD4U96sjvMszhzsX6oILX0ced90VwD2MzOPxyFwGkCvryKSuKTv+MkXT0PLXCg1V2jKALTeCrykd72tIhaXndJh/b2L98Gc3Sk/Yu6fvq1z6QpJURVteVPQGATzi/tkXQLNsgr6a/jPYt2C01x2X74CGPklag4skQe1Gey/68VGvury6vrq7ggB4RaEat41H3za6B6LzqhDHgFoM9EuIXnX4hYr+M+5/HczbnTcdhm+71prUWDZN8w/BGpPh",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"}},v={},y=[{value:"Request",id:"request",level:2}];function g(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)(d(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"delete a document"}),"\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)(m.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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document deleted successfully!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Document deleted successfully!"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink