WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-05 17:27:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3dfdd5d03dfd8e85dfaf575ce72e19963b65acd5
OpenSign/assets/js/52d5c0f9.4f2bfead.js
T

1 line
10 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:()=>j,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),d=(a(62316),a(51039)),i=a.n(d),c=(a(82723),a(9487)),o=a(41429),r=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={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:"eJy9Vm1v4zYM/isaP10BJ3Ha3g0zhmHdWtyKK9Zi7TBgbVAoNh3rKks6Sc4LAv/3gbKdOE0a3IDtviQ29VAkH76Ya/B85iB5hEudViUq72ASQYYutcJ4oRUk8FAgu0SJHlnWotjF3TXjUuqFYytdMa+ZxVLPkTmDqchFuoXmVpcEshuRG0IE2qDlZOE6gwSycH8HgAgMt7xEj5a8W4PiJRKsBTyLDCIQ5J3hvoDXLt9ZPRcZMj39jKm/zpjOtw55zRpzEIHFL5WwmEHibYUROL+SZMiJ0kgC4NJInSEkOZeOAGmBJYdkDX5lAtJboWYQQa5tyX1fgksebknAFKfT4pS7DOp6Qlad0cqho3tO45j+dgPo0tF6mjFXpSk6l1dSrr6DCFKtPDGVrIEbI0UauBx9dqS+3nezYYKItcS8F43xjqBDAW3d/2VJzpvfzBnUUZerC39c6TQ+PRuM40H8/cP4Q3L+Q/L+wzCO478hgmUpSbdLKvdI93rh5fa93oM1OesDW0lN4PNDNN7rEn0h1IwtiMyF1WoWMSORO2TerhifcaGY5B7tf8gqWqvtcXb+nWd1L2qhpFD43NXQ83kcP483JJwfqSWlPct1pbJvG+oh+8cDOn8+2wT0fj+gazXnUmRhCD3oF1TfNp6+ed+Y369W0YDCOewE25c3QTpMKyv8Kky65YAbMWjOk8cJjQuqFL2dkmE6+gISGHUzbbTuTcYa6Eo772ZnZSUkUHhvXDIacWOG2qByYqYkn7phqssRN2I0H0MdvUY7z2dCzQZHtSbbEO6J5obJnUA2fHIjPuEKoo6nPqqd6AXyDG3gVKhcB+WWvVuD6l7MVOB+Pt6b+w+FcEy4cNwxEuqA5dqyV9psyh1mTCvmCwyHJD8bjjcfsaA6ZE/qSVG/ssphXkkmhXpxyZMasMfbPBep4JL9hVMnPE7edcwtFos9xk6Czkfhi2rKLBq9hc+CMNDa19q8nEAEHm3pbvN7tHORYpulN0yNAnjUNgZPQ2NgyQVltxX9/FqJClWKFJXDXilffLy7YXN2Nowh6pXHVzg9urn+9er3+yu6l8qxSdJ4GA9jEhntfMlVz1S7Zlxu94Cd/K63Xf4/bSVtlXpc+pGRXITeDTGv26Z7hN6WkvQXkkkEhXaeIOs11dafVtY1ib9UaKm7JxHMuRV8SsX8uIZMOHrONtvFm9G++6NdVE7YV+82B2Pp2lBRD865rOgNInjB1av9qp7UUdeL5GyDuEhTNL6nuzdsdybW5dXN1cMVRMArIq8/Bl7CGGgfyMBB13bnQ+MD/dKoOqjwIxXBJ1z9tIE3J28qtCF2aKJpUtf1P6lL0F0=",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",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",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:"eJy9Vm1v4zYM/isaP10BJ3Ha3g0zhmHdWtyKK9Zi7TBgbVAoNh3rKks6Sc4LAv/3gbKdOE0a3IDtviQ29VAkH76Ya/B85iB5hEudViUq72ASQYYutcJ4oRUk8FAgu0SJHlnWotjF3TXjUuqFYytdMa+ZxVLPkTmDqchFuoXmVpcEshuRG0IE2qDlZOE6gwSycH8HgAgMt7xEj5a8W4PiJRKsBTyLDCIQ5J3hvoDXLt9ZPRcZMj39jKm/zpjOtw55zRpzEIHFL5WwmEHibYUROL+SZMiJ0kgC4NJInSEkOZeOAGmBJYdkDX5lAtJboWYQQa5tyX1fgksebknAFKfT4pS7DOp6Qlad0cqho3tO45j+dgPo0tF6mjFXpSk6l1dSrr6DCFKtPDGVrIEbI0UauBx9dqS+3nezYYKItcS8F43xjqBDAW3d/2VJzpvfzBnUUZerC39c6TQ+PRuM40H8/cP4Q3L+Q/L+wzCO478hgmUpSbdLKvdI93rh5fa93oM1OesDW0lN4PNDNN7rEn0h1IwtiMyF1WoWMSORO2TerhifcaGY5B7tf8gqWqvtcXb+nWd1L2qhpFD43NXQ83kcP483JJwfqSWlPct1pbJvG+oh+8cDOn8+2wT0fj+gazXnUmRhCD3oF1TfNp6+ed+Y369W0YDCOewE25c3QTpMKyv8Kky65YAbMWjOk8cJjQuqFL2dkmE6+gISGHUzbbTuTcYa6Eo772ZnZSUkUHhvXDIacWOG2qByYqYkn7phqssRN2I0H0MdvUY7z2dCzQZHtSbbEO6J5obJnUA2fHIjPuEKoo6nPqqd6AXyDG3gVKhcB+WWvVuD6l7MVOB+Pt6b+w+FcEy4cNwxEuqA5dqyV9psyh1mTCvmCwyHJD8bjjcfsaA6ZE/qSVG/ssphXkkmhXpxyZMasMfbPBep4JL9hVMnPE7edcwtFos9xk6Czkfhi2rKLBq9hc+CMNDa19q8nEAEHm3pbvN7tHORYpulN0yNAnjUNgZPQ2NgyQVltxX9/FqJClWKFJXDXilffLy7YXN2Nowh6pXHVzg9urn+9er3+yu6l8qxSdJ4GA9jEhntfMlVz1S7Zlxu94Cd/K63Xf4/bSVtlXpc+pGRXITeDTGv26Z7hN6WkvQXkkkEhXaeIOs11dafVtY1ib9UaKm7JxHMuRV8SsX8uIZMOHrONtvFm9G++6NdVE7YV+82B2Pp2lBRD865rOgNInjB1av9qp7UUdeL5GyDuEhTNL6nuzdsdybW5dXN1cMVRMArIq8/Bl7CGGgfyMBB13bnQ+MD/dKoOqjwIxXBJ1z9tIE3J28qtCF2aKJpUtf1P6lL0F0=",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",permalink:"/docs/API-docs/update-document"},next:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,t.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"})}),"\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)(n.Z,{children:[(0,l.jsxs)(h.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.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)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink