WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-25 09:02:33 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
16d5fcdede7d14ebbe73bfcacc1f25d8dfdd9bd2
OpenSign/assets/js/bfe4b778.b9b91e4e.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:()=>j,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLZqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0HYoN2E3gUOfv+3j+uMIgph7TC3xusqokHTyOE8zJZ07aII3GFM9nBO9tLgJBJwVHp8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxherFCLUrCFDtbVzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfRp0o6yjENrqIEfVgq9uZlaRVhgnRjlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzo2dvqduhm8pGyyLjjKwmSPH9tCP8yQCZHRJpS9PHHmnKsE9QmfLOZU4ZI4GguaRHz2cupbvKzb3uLx29zsc6Kvo2adVROjjPytr2NNtZ1gkGGLVNXvdy8mvBV1zXLOfLWaN+wejAa3c6AdVW3GQm+yjLyvqiUWj74flfaHH8JnPD5wSt/evjKMiFtSEfhfqWD0cHjvf3R3ujH8/2n6eFP6ZOng9Fo9DsmeFOqTT4hW8M+e/H/3oHUSmq66li7OhiNrh63VB7exV6bLbYto7lQModCksqBffrvSCA5Z9w/zOZ74rsPPkPuwB/ekzrchAtT6fy/hntXRPcDPLw6XEN8chvisW4o48l0bq5J/xsIN3j67kPjnkPdzmrZCMXvuAW2f96A9JRVToZlHGs3e8LKveZ7ejHmYVFSmBkeibZq5mCYYYrDrrsMV70+UyPbc/NuSlZOYYqzEKxPh0Nh7cBY0tw9lZj4QWbKobByON/HOtmV9kFMpZ7u3as13sR/xhw3NG6hWJMprHxNS0w6kvpS7eyekcjJRUL56t5t5uSL7gLWHO8Ol262fN242F0Q7hwA/f6PfI9SFyYiau/zxJI+Y+OcDfP9W1Y/kMpMSTy7effoxP/648+o0TmNyfoATioH1izIFZWKcReKbuREUX+94yUrGPAkSkXeqyVIHWjqeDHI5VQGoSJeqaeQCSsmUklObxYzrO2gVyF+AB9mFGbk+NMPjte6nOakuCpAGXPNdoIBUQVTRh8dUQvjrgsOKQEBk8pLTd6DJ+pUSM8Er31dgiRgHAgNpAM566QnELJk4cI4oKKQmWTDXMtOZAFKocWU2FkCHDez0LZND85MKh/AG1VFIHHjJQoNxLjXDeC5nFMDnA+b1ZdymFZsIoHM5ARtaTMMncOEfADL7mVG0agPwvGWNScXC6JZaiulwBruOVIo3i37d8uGghPac2NsAuquZk2fdYZnevSRi+UALvWlPuNkqTxxAiipr316qffgYp1mH2jiZaDxw65IF4vFreJ8tK3zUoZZNQFH1mz0pvEwlnJfff0PL46BXOlPijNyc5lR2xk+43MYhYdtJxZZ7MRUCqmawv91V4GrScmMtO/X9NHL0zcwh8eDESa9dvQVAQ/fHD978fbsBdvl9tfU3/5gNBjxkTU+lEL3XO28oHZLd7UZKf/XB1fblgPdhKFVQsZJFUlftVPmAnv9Mu2/tcYJzowPLLJaTYSn907VNR9/qsjxLBsnOBdOigk3yosV5tLz73z9Zvos3Q/fda8X+LZn252AuuGjefLMhariwp7gNS133o/1uE66CcQRNxLPmrj2ztnOxsKtLYMHaKNxlGVkw72y/bF++v4cE5y0b8EyPivRiQW/Q8UCU7zES4zv49jnWCier1AJPa3ElOUbszw3RcU31x+613Hotj8Y2J2UbE/jBgn/ZVx3KvzMmfqalr+sxZsvn1Voqe2k+XrGdV3/DaZv63Y=",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={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.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,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.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,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.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,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.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,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.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,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink