WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 17:44:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd358d2f22caeb790b4eb525910c9803d6de0684
OpenSign/assets/js/bfe4b778.d4605a99.js
T

1 line
14 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),n=s(11151),t=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Update Document"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{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)(a.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:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document updated 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)(s,{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)(a.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:"asd2HsP4Hp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",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": "asd2HsP4Hp",\n "updatedAt": "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)(a.p,{children:"Please provide valid field names!"})}),(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)(s,{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)(a.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",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(s,{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)(a.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",format:"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)(a.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)(s,{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)(a.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 g(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink