WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-12 04:37:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
16d5fcdede7d14ebbe73bfcacc1f25d8dfdd9bd2
OpenSign/assets/js/52d5c0f9.24a25302.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8468],{65313:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>k,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=l(85893),n=l(11151),t=l(58219),i=(l(62316),l(51039)),o=l.n(i),d=(l(82723),l(9487)),r=l(41429),c=l(5397),m=l(4667),p=l(9472),h=l(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:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",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",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:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6kRowlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAm1eJHJ5Zmfm7MyZXYuAuRfxnbgwSVWSDl5MI5GST5y0QRotYnFbEFyQokCQdig4f3cFqJRZeFiZCoIBR6WZE3hLicxksoVmzpQMcpslPxKRMJYcsoerVMQibfbvASISFh2WFMhxdGuhsSSGdYB7mYpISI7OYijE45DfOTOXKYGZfaQkXKVgsm1AwUDrTkTC0adKOkpFHFxFkfBhpdiRl6VVDKClVSYlEWeoPAOSgkoU8VqElW2QwUmdi0hkxpUYhiu0xGaXWNjiZFacoE9FXU/Zq7dGe/K8z8lkwn+7CfTH0UWagq+ShLzPKqVWz0QkEqMDMxWvBVqrZNJwOf7o2Xy9H2bLBBPrmPkgW+c9QYcS2ob/05KDt7/YU1FH/Vmdh6eNTiYnp0fHk6PJt7fHr+Kz7+KXr0aTyeQPEYllqdi2P1QMxPsGGdT2vd6DtWc2BHYrNYPPDtF4Y0oKhdQ5LJjMhTM6j8AqQk8Q3AowR6lBYSD3H7JKzhn3NDv/LrJ6kLXUSmq672vo/mwyuT/ekHD2RC1pEyAzlU6/bqqH/D+d0Nn96Sahl/sJXek5Kpk2InRrHkh/3XyG7kPrfr9aZQtqvoudZIfrbZKeksrJsGqUbnmEVh613+O7KcsFV4rZqmSjjqEQsRj3mjZeD5SxFrylm/faWTklYlGEYH08HqO1I2NJe5lrhTM/Skw5RivH82NRR4/RPmAudX70pNV0m8IN09wyuZPIhk+08g2tRNTzNER1il4QpuQaTqXOTGPcsffWkr6RuW64nx/v6f57UokpiSU+FAQ9/O8//2osepKa0ngGbysH1izIZZUC1ClkipZypujAePOEpSLv1QqkDpQ75HEocxlQAbPCrZygxZlUkouJYaade4N69CN4X1AoyPGnbxwBQkpzUlyDoIx54H2CAayCKXE4chfGPWQcUgQIs8pLTd6DJ+pNSBeoE4L+LCIwDlAD6UDOOukJUJYMzowDyjKZSN6YO8dhEqBEjTmxswg4bmbBtpPUgzOzygfwRlVNIuyxJAptipoo9SO4kHNqE2/mPQWUilLIK94igsSkBF0jcRo6hRn5AJbdy4SaTX1AF0DRnFxTe81J8twDa7jDJSoe58Oz5Y2CQ+15Bnd3je5oNvRZZ3iANj5SXI3gg/6gWYWh8sQFoKR+8PEHfQR3mzJ7TzMvA02f9/2wWCz2+uDFrs1rGYpqBo6s2drlzWLTNUPzzcsLEYlArvRvsxtyc5lQ14Sf8TluwONO9zBpdI9KlKrtsR8fG7AGKZmQ9jRQqfPX765hDqejiYgGnf8FAY+vr36+/PXmkvdlpWn773g0GU14yRofStQDV90N8mJ7xdtp3fVWwP+nC2cnQIGWYWwVykaWm5zXnZ7eicEFNB7eNaeRKIwPDFmvZ+jpd6fqmpc/VeRYuKeRmKOTOGOduluLVHp+TjcXx89m+/y37g76Ar742nowl15hNcvrHFXFbyISD7R6dHWup3XUyywH2yLOk4RsGNjuzdGdYXRxeX15eykigRWTN1T4h0bhuwd2cDC0XelvY+BfnkIHDb7nInhDqx828PbLZw26FHs00zSt6/ofLJ2E/g==",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={},y=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:l}=s;return l||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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Delete Document"})}),"\n",(0,a.jsx)(o(),{method:"delete",path:"/document/{document_id}"}),"\n",(0,a.jsx)(s.p,{children:"The Delete document API allows you to remove specific document from your documents."}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(r.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,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document deleted successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.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,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Document not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink