WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafd020dc5b4a76df7f26bc156fe78d325567178
OpenSign/assets/js/bfe4b778.b61a7ff2.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:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),d=(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:"eJzdV+tu2zYUfpXT82ctoNhOmnaYMAzr2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0GYoN2J/Aoc7t+3huXGEQU4/pGb4wWVWSDh7HCebkMydtkEZjiqczgo82F4Ggk4Jnx0cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGeioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHuWYYuOkw4cJbhxherZCLUrCFDtbFzLHBCXTY0WY4S5nRy8Y8Jb3iFET5RHUhFpcbMfRl0o6yjENrqIEfVgq9uZlaRVhgnRllckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1Qj52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzs2dvqeuhm8pmyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMMUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8bm+jjXWdYJBhy9RFLzcvJnzVdc1yjrw12jesHoxG1zNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8NofH762TEgb0rNwt9LB6ODx3v5ob/Tj6f7T9PCn9MnTwWg0+h0TvCrVJp+QrWGfvfh/70BqJTVddKxdHIxGF49bKg9vYq/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvMd8d0FnyF34A/vSB1uwoWpdP5fw70porsBHl4criE+uQ7xSDeU8WQ6NZek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrWrPWHlXvM9PRvzsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexK+yCmUk/37qkldD4xV7drjDeIT/hWGuK3cK/pF1a+oSUmHa19qXbaz0jk5OIV8GV/2EzWl92VrW9ldxx10+jbBszuSnHjyOhPDOSbl7owEVGbAe8t6RM2zvkz379m9ROpzJTE0563lU78rz/+jBqd05jeD+B95cCaBbmiUjHuQtGVnCjqL4S8lgUDnkSpyHu1BKkDTR2vErmcyiBUxCv1FDJhxUQqyQXBYoa1HfRqyg/g04zCjBx/+sHxIpjTnBTXEShjLtlOMCCqYMrooyNqYdxlwSElIGBSeanJe/BEnQrpmeBFsUuQBIwDoYF0IGed9ARClixcGAdUFDKTbJir34ksQCm0mBI7S4DjZhbaRuvBmUnlA3ijqggk7shEoYEYN8EBvJBzaoDzYbMsUw7Tik0kkJmcoG0GDEPnMCEfwLJ7mVE06oNwvJfNycUSatbgSimwhruUFIq30f7dsqHghPbcSpuAuqtZ02ed4S0g+sjFcgDn+lyfcLJUnjgBlNSXPj3Xe3C2TrNPNPEy0PhhV6CLxeJacT7a1nklw6yagCNrNnrTeBhLua++/odXzUCu9O+LE3JzmVHbFW7xOYzCw7Z3iyz2biqFVE3h/7qrwNWkZEba92v62avjtzCHx4MRJr1W9A0BD98ePX/57uQl2+WG2dTf/mA0GPGRNT6UQvdc7by5dkt3tRlC/9cnWtuWA12FoVVCxtkWSV+1c+kMe/0y7b/OxgnOjA8sslpNhKePTtU1H3+pyPH0Gyc4F06KCTfKsxXm0vPvfP3KupXuhx+69w7c76F3I6Bu+GiePHOhqrjiJ3hJy50XZz2uk24CccSNxPMmrr1TtrOxcG0v4eHZaDzLMrLhTtn+InD88RQTnLSvxzI+RNGJBb9cxQJTPMdzjC/q2OdYKJ6vUAk9rcSU5RuzPDdFxTfXH7qXcei2PxjYjZRsT+MGCf9lXDcq/MyZ+oaWv6zFmy+3KrTUdtJ8PeO6rv8Gwy39SA==",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:"eJzdV+tu2zYUfpXT82ctoNhOmnaYMAzr2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0GYoN2J/Aoc7t+3huXGEQU4/pGb4wWVWSDh7HCebkMydtkEZjiqczgo82F4Ggk4Jnx0cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGeioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHuWYYuOkw4cJbhxherZCLUrCFDtbFzLHBCXTY0WY4S5nRy8Y8Jb3iFET5RHUhFpcbMfRl0o6yjENrqIEfVgq9uZlaRVhgnRllckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1Qj52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzs2dvqeuhm8pmyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMMUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8bm+jjXWdYJBhy9RFLzcvJnzVdc1yjrw12jesHoxG1zNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8NofH762TEgb0rNwt9LB6ODx3v5ob/Tj6f7T9PCn9MnTwWg0+h0TvCrVJp+QrWGfvfh/70BqJTVddKxdHIxGF49bKg9vYq/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvMd8d0FnyF34A/vSB1uwoWpdP5fw70porsBHl4criE+uQ7xSDeU8WQ6NZek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrWrPWHlXvM9PRvzsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexK+yCmUk/37qkldD4xV7drjDeIT/hWGuK3cK/pF1a+oSUmHa19qXbaz0jk5OIV8GV/2EzWl92VrW9ldxx10+jbBszuSnHjyOhPDOSbl7owEVGbAe8t6RM2zvkz379m9ROpzJTE0563lU78rz/+jBqd05jeD+B95cCaBbmiUjHuQtGVnCjqL4S8lgUDnkSpyHu1BKkDTR2vErmcyiBUxCv1FDJhxUQqyQXBYoa1HfRqyg/g04zCjBx/+sHxIpjTnBTXEShjLtlOMCCqYMrooyNqYdxlwSElIGBSeanJe/BEnQrpmeBFsUuQBIwDoYF0IGed9ARClixcGAdUFDKTbJir34ksQCm0mBI7S4DjZhbaRuvBmUnlA3ijqggk7shEoYEYN8EBvJBzaoDzYbMsUw7Tik0kkJmcoG0GDEPnMCEfwLJ7mVE06oNwvJfNycUSatbgSimwhruUFIq30f7dsqHghPbcSpuAuqtZ02ed4S0g+sjFcgDn+lyfcLJUnjgBlNSXPj3Xe3C2TrNPNPEy0PhhV6CLxeJacT7a1nklw6yagCNrNnrTeBhLua++/odXzUCu9O+LE3JzmVHbFW7xOYzCw7Z3iyz2biqFVE3h/7qrwNWkZEba92v62avjtzCHx4MRJr1W9A0BD98ePX/57uQl2+WG2dTf/mA0GPGRNT6UQvdc7by5dkt3tRlC/9cnWtuWA12FoVVCxtkWSV+1c+kMe/0y7b/OxgnOjA8sslpNhKePTtU1H3+pyPH0Gyc4F06KCTfKsxXm0vPvfP3KupXuhx+69w7c76F3I6Bu+GiePHOhqrjiJ3hJy50XZz2uk24CccSNxPMmrr1TtrOxcG0v4eHZaDzLMrLhTtn+InD88RQTnLSvxzI+RNGJBb9cxQJTPMdzjC/q2OdYKJ6vUAk9rcSU5RuzPDdFxTfXH7qXcei2PxjYjZRsT+MGCf9lXDcq/MyZ+oaWv6zFmy+3KrTUdtJ8PeO6rv8Gwy39SA==",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"}},y={},f=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,t.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)(r(),{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)(d.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)(n.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)(d.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)(d.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)(d.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)(d.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 v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink