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
cd358d2f22caeb790b4eb525910c9803d6de0684
OpenSign/assets/js/52d5c0f9.7cfe3494.js
T

1 line
11 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:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),o=a(41429),c=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:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",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+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",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)(d(),{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)(r.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)(c.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)(r.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)(c.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)(r.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)(c.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)(r.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)(c.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