WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 18:14:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
791a7db1f06196a4979873fd39a50697f2ddb171
OpenSign/assets/js/bfe4b778.469f98eb.js
T

1 line
13 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:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),n=s(58219),d=(s(62316),s(51039)),i=s.n(d),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=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:"eJzdV21v2zYQ/ivcfUoB2VZe2mLCMCxrgzZo0QRNggFLDIOWTjYbimRJyo5h6L8PR0m27DheMhQbsC+GTN3b89zx7rQEzycOklt4r9OyQOUdDCPI0KVWGC+0ggSup8huTMY9slaKnV6eMy6lnjtWOrSOec0KnYl8wbjKWFmL+ymyDD0X0jGdM86cwVTkImVZY6jPvuggyD3zU+GCYa3korXudWuMsxznzHDLC/RoXcQWumQpV0p7lk65mtQOcyGRaZUiE76OoA1aOJZa5B6zPkSgDVpOEM8zSKB20uKDCNaOILldguIFQgKtrZHIIAJB9Bjup7DN2fl7ArzhPWBUiFkANcYGF9mx+L0UFjNIvC0xAucXkrw5URiJEAE+GKkzhCTn0pFAOsWCQ7IEvzBB0luhJhBBrm3B/fqkqoa1fXT+d50tSGcz1EurZyJDNkapO/x2mPdYGMk9OnbAPZPInWdaYUe2BfAKIki18kRhsgRujBRpIHnwzZG35ePQ9fgbpoFxSynxAh29rQn/e4BEDg80JeDCw4pyqCJQ2r/YzCVBRGZxJnAe6tmJiarrs2t7g8eXuVhVRddGRToyQ0sV+ZzURuCF37A36hToaEz5riqSs+iMVq6m9iiOH5fB6mo3ZclcmaboXF5Kufjpx+W1Pt6NcM0Pd9nRR3d58tEQK01Ip36/0lF8dNw7jHvx2+vDN8nJz8nrN/04jv+ECB4KuS4qIGvQZS/87xwIJYXCUcva6CiOR8cNlSe72GtKxjR3acalyFguUGaMfLofSCBaq+0/LOk98e2DT5Bb8Cd7Soc6ca5Llf3XcHdFtB/gyehkBfH1Y4jnqqaMxtO1vkf1byBc4+m697V7CnWzqkUtFN7DBtjueQ3SYVpa4Rdhtj30uBG9+n1yO6SJUaCfapqLpqyHoZ9CAoO2uwyWnT5TAdmzs3ZUllZCAlPvjUsGA25MXxtU1EIlH7t+qosBN2IwO4Qq2pZ2nk+EmvT2ag3X8V8RxzWNGyhWZHIjPuECopakrlQzwKfIM7SBUErd1/WwPGsTsOJ4e8K0A+Z5M2N7S9g5BbpDYNXqKdRcB1xNVi8MqityQTUxO3xk+5o8NwtV6yfUJ8u1ZVvabMwdZkyrsLLQSzo/7h+uNrag2md36k5d6QJp68tLyaRQ9y65Uz12e5HnIhVcsj9w7ITH4UGb1Pl8/iiZr4LOB+Gn5ZhZNHotPgmHIeNdrdUfWjI82sJd5FdoZyLFpoCecDUIwoPmwvI0XFgsuKDCa45+21YiyqVIUblu+k8/XH5mM3bcjyHqVO4zgh58Pn939uXqjOzSTamTdNiP+zEdGe18wVXH1dbGvZ3f5br7/F8X9OYGe3zwAyO5CE0tkL5sGtItdK5W0t3NhxFMtfMkslxScd9YWVV0/L1ES21vGMGMW8HHdJtul5AJR8/Zasd+ku6Dr+22y1625u8E1PYpRU1qxmVJ/yCCe1xsfW9UwypqmxVFXEu8q+PqXZOdtYVHA4l6ba1xmqZo/F7Z7gS4vLmGCMbNt0MRPkPA8jl9t/A5JHAHdxC+p8hAaMXhfAmSq0nJJyRfm6UWy0vKXLc/34f+3DwQsJ2UbDbuGgn9Eq6dCr9QpX7Cxa8r8frNkwoNta00pWdYVdVfjxs7rw==",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:"eJzdV21v2zYQ/ivcfUoB2VZe2mLCMCxrgzZo0QRNggFLDIOWTjYbimRJyo5h6L8PR0m27DheMhQbsC+GTN3b89zx7rQEzycOklt4r9OyQOUdDCPI0KVWGC+0ggSup8huTMY9slaKnV6eMy6lnjtWOrSOec0KnYl8wbjKWFmL+ymyDD0X0jGdM86cwVTkImVZY6jPvuggyD3zU+GCYa3korXudWuMsxznzHDLC/RoXcQWumQpV0p7lk65mtQOcyGRaZUiE76OoA1aOJZa5B6zPkSgDVpOEM8zSKB20uKDCNaOILldguIFQgKtrZHIIAJB9Bjup7DN2fl7ArzhPWBUiFkANcYGF9mx+L0UFjNIvC0xAucXkrw5URiJEAE+GKkzhCTn0pFAOsWCQ7IEvzBB0luhJhBBrm3B/fqkqoa1fXT+d50tSGcz1EurZyJDNkapO/x2mPdYGMk9OnbAPZPInWdaYUe2BfAKIki18kRhsgRujBRpIHnwzZG35ePQ9fgbpoFxSynxAh29rQn/e4BEDg80JeDCw4pyqCJQ2r/YzCVBRGZxJnAe6tmJiarrs2t7g8eXuVhVRddGRToyQ0sV+ZzURuCF37A36hToaEz5riqSs+iMVq6m9iiOH5fB6mo3ZclcmaboXF5Kufjpx+W1Pt6NcM0Pd9nRR3d58tEQK01Ip36/0lF8dNw7jHvx2+vDN8nJz8nrN/04jv+ECB4KuS4qIGvQZS/87xwIJYXCUcva6CiOR8cNlSe72GtKxjR3acalyFguUGaMfLofSCBaq+0/LOk98e2DT5Bb8Cd7Soc6ca5Llf3XcHdFtB/gyehkBfH1Y4jnqqaMxtO1vkf1byBc4+m697V7CnWzqkUtFN7DBtjueQ3SYVpa4Rdhtj30uBG9+n1yO6SJUaCfapqLpqyHoZ9CAoO2uwyWnT5TAdmzs3ZUllZCAlPvjUsGA25MXxtU1EIlH7t+qosBN2IwO4Qq2pZ2nk+EmvT2ag3X8V8RxzWNGyhWZHIjPuECopakrlQzwKfIM7SBUErd1/WwPGsTsOJ4e8K0A+Z5M2N7S9g5BbpDYNXqKdRcB1xNVi8MqityQTUxO3xk+5o8NwtV6yfUJ8u1ZVvabMwdZkyrsLLQSzo/7h+uNrag2md36k5d6QJp68tLyaRQ9y65Uz12e5HnIhVcsj9w7ITH4UGb1Pl8/iiZr4LOB+Gn5ZhZNHotPgmHIeNdrdUfWjI82sJd5FdoZyLFpoCecDUIwoPmwvI0XFgsuKDCa45+21YiyqVIUblu+k8/XH5mM3bcjyHqVO4zgh58Pn939uXqjOzSTamTdNiP+zEdGe18wVXH1dbGvZ3f5br7/F8X9OYGe3zwAyO5CE0tkL5sGtItdK5W0t3NhxFMtfMkslxScd9YWVV0/L1ES21vGMGMW8HHdJtul5AJR8/Zasd+ku6Dr+22y1625u8E1PYpRU1qxmVJ/yCCe1xsfW9UwypqmxVFXEu8q+PqXZOdtYVHA4l6ba1xmqZo/F7Z7gS4vLmGCMbNt0MRPkPA8jl9t/A5JHAHdxC+p8hAaMXhfAmSq0nJJyRfm6UWy0vKXLc/34f+3DwQsJ2UbDbuGgn9Eq6dCr9QpX7Cxa8r8frNkwoNta00pWdYVdVfjxs7rw==",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 g(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)(i(),{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)(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,t.jsx)(r.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)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(c.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)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string"}})]})]})})}),"\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)(r.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.jsx)(c.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)(m.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)(r.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)(c.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)(m.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)(r.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)(c.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)(m.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)(r.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)(c.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)(m.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)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink