WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 10:04:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
0797dd4aba144eefb2d04b1a7d2684fb0cc6e23a
OpenSign/assets/js/bfe4b778.941ae0bf.js
T

1 line
15 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:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=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),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:"eJzdWOtuHDUUfpVT/6GVZi9JA4gRQpS2gghEIpKqEskq8o7P7Jh4bGN7drNazT+ehEfjSdCxZ3Zns2naogok/kQbz7l9n30u9oYFvvAsv2KvTNHUqINns4wJ9IWTNkijWc4uK4Q3VvCA0EvBi/NT4EqZlYfGo/MQDNRGyHINXAtoknioEAQGLpUHUwIHb7GQpSxAdIbG8LOJgjxAqKSPho1W6956ML0xDiWuwHLHawzofAZr00DBtTYBiorrRXJYSoVgdIEgQ4qgD1p6KBzygGLMMmYsOk4QTwXLWXLS42MZ2zli+dWGaV4jy1lv60YKljFJ9FgeKnafs9NXBHjPe8SoEUUENccOF9lx+HsjHQqWB9dgxnxYK/LmZW0VsozhnVVGIMtLrjwJFBXWnOUbFtY2SgYn9YJlrDSu5mG30razZB99+M6INensh3ruzFIKhDkqM+B3wHzA2ioe0MNTHkAh9wGMxoFsD+AZy1hhdCAK8w3j1ipZRJInv3nytjkM3cx/wyIy7mhLgkRPXxPh7wdI5PBIU858/LGlnLUZ0yZ8tJlzgojgcClxFc+zlwudzufQ9h6PH+dieyqGNlrSUQIdnchDezttkkTN5wrPLs8HonNjFHI9lO0OzP6W0ymDUQJk4iKspFKQbMLZ5Tks0VGixr0bw5uY41HGYYFySek4FIHCCISl5IA1lyqDVSWLihJgDXXjA6DuzlRHJQ5KQIwRRnAYkJD+wYiyVB6kXuzKz4FhENJhEdQaVjJUpgnAhZCkzhX4gNaPd0RemsZ9eiY5LBopUEAwjYPSuBhlLF42ph0hkNoH1xSk7EE0tNsRB4nSb+tMgd7veOpZIaGB/QxQ+6TOoeQ+oMug0ZKYd40NKLYm8c6ik6gLHLO2zViQYe9Y3gzq3M2cykbbkpxDb432KUOPp9PDarLtEF11A98UFH3ZKLV+8unKQ1p+X6JwL45/8OcnP1ja6S6kF+FxpePp8fPR0XQ0/fLy6Iv85Kv88y/G0+n0V5axu1rtahMja2zIXvx/sCC1khpvetZujqfTm+cdlScPsddVHtuV5CVXUkApUQkgn/4TEojOGfcPK+Mj8T0GnyD34E8eOTrU0EvTaPFfw30ooscBntycbCF+fgjxVCfKaMq5NLeo/w2EOzxD9yG5p1D3T7VMQvE72wM7XE8gPRaNk2EdR6S7EbdylL7nVzMaPGoMlaHxyjZppgoVy9mkry6TzaDOtIzsuWU/cTVOsZxVIVifTyaeazE3d2NjUVMVU3zux4WpJ9zKyfKItdl9DW7tR0j7wBdSL0aPas12iC9oVxLxe7i39HMrf8Q1y3pah1Ld5FghF+jiFtBm/7Kb0l73W7bdlfujTT/ZfNiwcr9tPTh+DKcPxvYmjK73DVtlXGoJSWki7O6YnFnUFxQBHbLl0YHrt6gKUyN1bOpfvfhff/wZNfrIYg48gbPGgTUrdGWjIrhS4Z2k5je4gdA9gAYA5LVC79UaqOctHM2uQi5koH7fdb6CWz6XSlLWkJghbQeDxPNjeFthqNDRp88cdXGBS1SUbKCMuY0N2gBvgqmjj57NlXG3JYWUAYd546VG78Ej9iqoK043k/4UZWAccJ2mI+ukR+CyJmGaFbAsZSHJMJUIx4sANdd8geQsA4qbWOiqsQdn5jRqeaOaNEzQpQwxJIjx6jGGVzS8ReC0mG5nKNIc4bM0x3UVg2BoAXP0ASy5lwWmUStwRxeBJbqYNene1SgF1lApk1zR9We4t2QoOK491dsUUL81W/q6QSf6EHw9hmt9rS/osDQe6QAoqW99fq1HcLU9Zm9x7mXA2dM+k1er1UEGP9vX+V6GqpmDQ2t2eou4GPN9qL79h+42AV3tz8oLdEtZYFc+3uFzEoUnXYHnRSzwcTpO1eHb+wpUbJUsUPth4r/4/vwnWMLz8ZRlg5r1AQFPfjp9+frni9dkl6pqyr+j8XQ8pSVrfKi5Hri6d8m/n7qbXaf6v74JdLU74F2YWMVlbICR9E3XvK7YoKjmw+eAWcYq4wOJbDZz7vGNU21Ly7836KhFzjK25E5SDY0drpvjxcN3iyHdT3/pL9jwcS8LDwLqO5Sm9rTkqsFU8G9xfe+Jo521Wd+mKOIk8TLFNbokOzsLB8MLddmk8aIo0IZHZYfTwvmbS5axefdcUceXD+b4ip5K+Irl7Jpds/iEE+scCcX1DVNcLxq+IPlklporb2jnhp35Nnbm7gcBe5CS/ZadkNBfwvWgwtd0Un/E9Tdb8fTlnQodtb00bc+sbdu/AUEm3sk=",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:"eJzdWOtuHDUUfpVT/6GVZi9JA4gRQpS2gghEIpKqEskq8o7P7Jh4bGN7drNazT+ehEfjSdCxZ3Zns2naogok/kQbz7l9n30u9oYFvvAsv2KvTNHUqINns4wJ9IWTNkijWc4uK4Q3VvCA0EvBi/NT4EqZlYfGo/MQDNRGyHINXAtoknioEAQGLpUHUwIHb7GQpSxAdIbG8LOJgjxAqKSPho1W6956ML0xDiWuwHLHawzofAZr00DBtTYBiorrRXJYSoVgdIEgQ4qgD1p6KBzygGLMMmYsOk4QTwXLWXLS42MZ2zli+dWGaV4jy1lv60YKljFJ9FgeKnafs9NXBHjPe8SoEUUENccOF9lx+HsjHQqWB9dgxnxYK/LmZW0VsozhnVVGIMtLrjwJFBXWnOUbFtY2SgYn9YJlrDSu5mG30razZB99+M6INensh3ruzFIKhDkqM+B3wHzA2ioe0MNTHkAh9wGMxoFsD+AZy1hhdCAK8w3j1ipZRJInv3nytjkM3cx/wyIy7mhLgkRPXxPh7wdI5PBIU858/LGlnLUZ0yZ8tJlzgojgcClxFc+zlwudzufQ9h6PH+dieyqGNlrSUQIdnchDezttkkTN5wrPLs8HonNjFHI9lO0OzP6W0ymDUQJk4iKspFKQbMLZ5Tks0VGixr0bw5uY41HGYYFySek4FIHCCISl5IA1lyqDVSWLihJgDXXjA6DuzlRHJQ5KQIwRRnAYkJD+wYiyVB6kXuzKz4FhENJhEdQaVjJUpgnAhZCkzhX4gNaPd0RemsZ9eiY5LBopUEAwjYPSuBhlLF42ph0hkNoH1xSk7EE0tNsRB4nSb+tMgd7veOpZIaGB/QxQ+6TOoeQ+oMug0ZKYd40NKLYm8c6ik6gLHLO2zViQYe9Y3gzq3M2cykbbkpxDb432KUOPp9PDarLtEF11A98UFH3ZKLV+8unKQ1p+X6JwL45/8OcnP1ja6S6kF+FxpePp8fPR0XQ0/fLy6Iv85Kv88y/G0+n0V5axu1rtahMja2zIXvx/sCC1khpvetZujqfTm+cdlScPsddVHtuV5CVXUkApUQkgn/4TEojOGfcPK+Mj8T0GnyD34E8eOTrU0EvTaPFfw30ooscBntycbCF+fgjxVCfKaMq5NLeo/w2EOzxD9yG5p1D3T7VMQvE72wM7XE8gPRaNk2EdR6S7EbdylL7nVzMaPGoMlaHxyjZppgoVy9mkry6TzaDOtIzsuWU/cTVOsZxVIVifTyaeazE3d2NjUVMVU3zux4WpJ9zKyfKItdl9DW7tR0j7wBdSL0aPas12iC9oVxLxe7i39HMrf8Q1y3pah1Ld5FghF+jiFtBm/7Kb0l73W7bdlfujTT/ZfNiwcr9tPTh+DKcPxvYmjK73DVtlXGoJSWki7O6YnFnUFxQBHbLl0YHrt6gKUyN1bOpfvfhff/wZNfrIYg48gbPGgTUrdGWjIrhS4Z2k5je4gdA9gAYA5LVC79UaqOctHM2uQi5koH7fdb6CWz6XSlLWkJghbQeDxPNjeFthqNDRp88cdXGBS1SUbKCMuY0N2gBvgqmjj57NlXG3JYWUAYd546VG78Ej9iqoK043k/4UZWAccJ2mI+ukR+CyJmGaFbAsZSHJMJUIx4sANdd8geQsA4qbWOiqsQdn5jRqeaOaNEzQpQwxJIjx6jGGVzS8ReC0mG5nKNIc4bM0x3UVg2BoAXP0ASy5lwWmUStwRxeBJbqYNene1SgF1lApk1zR9We4t2QoOK491dsUUL81W/q6QSf6EHw9hmt9rS/osDQe6QAoqW99fq1HcLU9Zm9x7mXA2dM+k1er1UEGP9vX+V6GqpmDQ2t2eou4GPN9qL79h+42AV3tz8oLdEtZYFc+3uFzEoUnXYHnRSzwcTpO1eHb+wpUbJUsUPth4r/4/vwnWMLz8ZRlg5r1AQFPfjp9+frni9dkl6pqyr+j8XQ8pSVrfKi5Hri6d8m/n7qbXaf6v74JdLU74F2YWMVlbICR9E3XvK7YoKjmw+eAWcYq4wOJbDZz7vGNU21Ly7836KhFzjK25E5SDY0drpvjxcN3iyHdT3/pL9jwcS8LDwLqO5Sm9rTkqsFU8G9xfe+Jo521Wd+mKOIk8TLFNbokOzsLB8MLddmk8aIo0IZHZYfTwvmbS5axefdcUceXD+b4ip5K+Irl7Jpds/iEE+scCcX1DVNcLxq+IPlklporb2jnhp35Nnbm7gcBe5CS/ZadkNBfwvWgwtd0Un/E9Tdb8fTlnQodtb00bc+sbdu/AUEm3sk=",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 b(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)(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)(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,l.jsx)(o.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:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps."}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1,description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience."}})]})]})})}),"\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)(o.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)(o.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)(o.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)(o.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 y(e={}){const{wrapper:a}={...(0,t.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