WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
6bf12db8c109ff2d3f6d0078996d5d7f3104f684
OpenSign/assets/js/bfe4b778.6b36ff91.js
T

1 line
16 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:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var n=s(85893),t=s(11151),i=s(58219),l=(s(62316),s(51039)),o=s.n(l),r=(s(82723),s(9487)),d=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:"eJzdWOFuI7cRfpUJ/+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1ntYy5JENyJQuC/uVJ+mh9kmLIXWlt+Zy7NmiB/jFk7nA483H4zUduRMRFEOWVeG2rriUTg7gphKRQeeWiskaU4rIheO8kRoLBCl6dvwXU2q4CdIF8gGihtVLVa0AjocvmsSGQFFHpALYGhOCoUrWqQPaOJvCzTYYYITYqJMfW6PXgPdrBGUJNK3DosaVIPhSwth1UaIyNUDVoFnnBWmkCayoCFXMEQ9AqQOUJI8mJKIR15JFTfCtFKfIiQ36iEPuFRHm1EQZbEqUYfN0qKQqhGB6HsRGPMXv7mhN+sHrK0RDJlNSc+rzYj6dfO+VJijL6jgoR4lrzakG1TpMoBN07bSWJskYd2KBqqEVRbkRcu2QZvTILUYja+hbjfmS7vcn+KcS/WbnmOQ9DPfd2qSTBnLQd4TtCPlLrNEYK8AIjaMIQwRoa2Q4JfCUKUVkTGcJyI9A5raoE8vSXwKttDkO381+oSoh73pKoKPDXDPjvJ8jgYIKpFCH92EEutoUwNn62m3NOkcDTUtEq1XNQC5Prc+y7tlqS5/I59L/3xpZkcK7p7PJ8ZDq3VhOag9LhEoCjvJpNg7BSWkP2AWeX57Akz6coATuB9+kAJhtPFakln5WxCVRWEiwVArWodAGrRlUNV+ca2i5EINNveJ8njc5nqjg4gsOApApPRlTks6vMYs8NB45BKk9V1GtYqdjYLgJKqXg6agiRXJiMUUxR7IC8tJ3/z5FEWHRKkoRoOw+19SnKxCwunQnOQJkQfVfx5ACy491NebAp/3beVhTCHqcBFTYa+S+ATMjTEWoMkXwBnVGMvO9cJLlzSfeOvCJT0ZMQJHBvE9n2gIdPx+KcfKtiGDLlrUEpgTQl8ofQVQ1g/o6x8xQKUEZFhToUECK2LhRgPUS6ZxKAaB0zHd2rEDn4lZILigHUx+roHfEZqUYx1N62afcZG7MeF8IurmgfubvkTVWhbzE1djrCEnX3FGbbQkQV9QP+HhH57Zx5cbtlO0/BWRMyBZ3MZod0uWuBPX0zZFwBdaf1+os/jv/y8O+RCwZ58kM4P/3BMc30Ib2Kz086mZ28PDqeHc3+dHn8TXn6bfn1N5PZbPZ3UYj7Vu/JV7A3MUYv/T8aUEYrQ7cDarcns9ntyx7K06fQ66nV9T1niVpJqBVpCbxm+AMBJO+t/zep/5n4nkufUx6SP32mdFix1LYz8n+d7lMRPZ/g6e3pLsWvD1N8azJkLOMu7R2Z/0aG+3zGy8e8PIf6sKpVNkrfxYNkx+M5yUBV51VcJw14f4ROHeXv5dUNK6uWYmNZP7oui8bYiFJMB3aZbkY8sxXszy8HSdl5LUrRxOhCOZ0GNHJu7yfWkWFm1DgPk8q2U3RqujwW2+LxDHTuM6xDxIUyi6NnZ93sM77gXcnAP8h7Bz869SOtRTHAOrbqpXFDKMmnLeDNfreXoW+GLdvtymPtNki3T1NjYzEmxAPB1UvmsXLoh57spEObVaa2Kdu+Os4cmQtemGtreXzQYD+QrmxLQ6cazP/52z/SjCHStMwXcNZ5cHZFvu50yqnWdK9YN4xuVny/Ye1E2GoKQa+B5cLCsyaXaqEiS6VeNFTocK604sPCZpZnexidtzCBDw3Fhjx/+tKzAJK0JM1nDLS1d0nbWMAu2jatMbDDyvq7mkMqAGHeBWUoBAhEwxQyDfKNayieJBHQZGHpvAoEqFo2ZplFda0qxY6ZGTxWEVo0uEi9vgCOm1HoSTiAt3NWqcHqLuswvmwSxZxiulJN4DXr3pQ4D+ZbJ8kswUKRJXBPFJyGkTCnEMHx8qqirFIjer7gLMmnw5Lvk53W4CwzmELNYme8t+woejSBaTYHNGzNDr5eI6Y1JK4ncG2uzQUXSxeIC0ArcxfKa3MEV7sy+0DzoCLdvBgO8Gq1Oji4Xz2c872KTTcHT87u5y3SYDrm4+m7f/jOFsm34ay+IL9UFfWs8ZE1p8l42vM6VonX08Uik8JfH09gjtWqIhPG5/3V9+c/wRJeTmaiGFHVJwQ8/entd29+vnjDfplM8/k7nswmMx5yNsQWzWipR48Xj4/uZt+g/l/fOnrKZtE+dRpV6nsJ9E3fs67EiEvL8TPHTSEaGyKbbDZzDPTe6+2Wh3/tyHNnvCnEEr1ifk2Nrb8CyR3RfhTuF++GhwP4vBeTJxMaGpPhrpQuA7kZ3NH60dPN9mZbDN2JI84W3+W4ji7Zz97DgWbh5ppnvKoqcvFZ27FIOH9/KQox759h2vSiIzyu+AkIV6IU1+JapKep3bUujW+ERrPocMH22S33VOx458YN+S415P4HJ/YkJA87dc6E/3JeT074M1fqj7T+y848f/nohB7awZq352a73f4LVGAtxA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJzdWOFuI7cRfpUJ/+QCrCXZ56TIoih6zR2SQ4LYOPtwQG3DGC1ntYy5JENyJQuC/uVJ+mh9kmLIXWlt+Zy7NmiB/jFk7nA483H4zUduRMRFEOWVeG2rriUTg7gphKRQeeWiskaU4rIheO8kRoLBCl6dvwXU2q4CdIF8gGihtVLVa0AjocvmsSGQFFHpALYGhOCoUrWqQPaOJvCzTYYYITYqJMfW6PXgPdrBGUJNK3DosaVIPhSwth1UaIyNUDVoFnnBWmkCayoCFXMEQ9AqQOUJI8mJKIR15JFTfCtFKfIiQ36iEPuFRHm1EQZbEqUYfN0qKQqhGB6HsRGPMXv7mhN+sHrK0RDJlNSc+rzYj6dfO+VJijL6jgoR4lrzakG1TpMoBN07bSWJskYd2KBqqEVRbkRcu2QZvTILUYja+hbjfmS7vcn+KcS/WbnmOQ9DPfd2qSTBnLQd4TtCPlLrNEYK8AIjaMIQwRoa2Q4JfCUKUVkTGcJyI9A5raoE8vSXwKttDkO381+oSoh73pKoKPDXDPjvJ8jgYIKpFCH92EEutoUwNn62m3NOkcDTUtEq1XNQC5Prc+y7tlqS5/I59L/3xpZkcK7p7PJ8ZDq3VhOag9LhEoCjvJpNg7BSWkP2AWeX57Akz6coATuB9+kAJhtPFakln5WxCVRWEiwVArWodAGrRlUNV+ca2i5EINNveJ8njc5nqjg4gsOApApPRlTks6vMYs8NB45BKk9V1GtYqdjYLgJKqXg6agiRXJiMUUxR7IC8tJ3/z5FEWHRKkoRoOw+19SnKxCwunQnOQJkQfVfx5ACy491NebAp/3beVhTCHqcBFTYa+S+ATMjTEWoMkXwBnVGMvO9cJLlzSfeOvCJT0ZMQJHBvE9n2gIdPx+KcfKtiGDLlrUEpgTQl8ofQVQ1g/o6x8xQKUEZFhToUECK2LhRgPUS6ZxKAaB0zHd2rEDn4lZILigHUx+roHfEZqUYx1N62afcZG7MeF8IurmgfubvkTVWhbzE1djrCEnX3FGbbQkQV9QP+HhH57Zx5cbtlO0/BWRMyBZ3MZod0uWuBPX0zZFwBdaf1+os/jv/y8O+RCwZ58kM4P/3BMc30Ib2Kz086mZ28PDqeHc3+dHn8TXn6bfn1N5PZbPZ3UYj7Vu/JV7A3MUYv/T8aUEYrQ7cDarcns9ntyx7K06fQ66nV9T1niVpJqBVpCbxm+AMBJO+t/zep/5n4nkufUx6SP32mdFix1LYz8n+d7lMRPZ/g6e3pLsWvD1N8azJkLOMu7R2Z/0aG+3zGy8e8PIf6sKpVNkrfxYNkx+M5yUBV51VcJw14f4ROHeXv5dUNK6uWYmNZP7oui8bYiFJMB3aZbkY8sxXszy8HSdl5LUrRxOhCOZ0GNHJu7yfWkWFm1DgPk8q2U3RqujwW2+LxDHTuM6xDxIUyi6NnZ93sM77gXcnAP8h7Bz869SOtRTHAOrbqpXFDKMmnLeDNfreXoW+GLdvtymPtNki3T1NjYzEmxAPB1UvmsXLoh57spEObVaa2Kdu+Os4cmQtemGtreXzQYD+QrmxLQ6cazP/52z/SjCHStMwXcNZ5cHZFvu50yqnWdK9YN4xuVny/Ye1E2GoKQa+B5cLCsyaXaqEiS6VeNFTocK604sPCZpZnexidtzCBDw3Fhjx/+tKzAJK0JM1nDLS1d0nbWMAu2jatMbDDyvq7mkMqAGHeBWUoBAhEwxQyDfKNayieJBHQZGHpvAoEqFo2ZplFda0qxY6ZGTxWEVo0uEi9vgCOm1HoSTiAt3NWqcHqLuswvmwSxZxiulJN4DXr3pQ4D+ZbJ8kswUKRJXBPFJyGkTCnEMHx8qqirFIjer7gLMmnw5Lvk53W4CwzmELNYme8t+woejSBaTYHNGzNDr5eI6Y1JK4ncG2uzQUXSxeIC0ArcxfKa3MEV7sy+0DzoCLdvBgO8Gq1Oji4Xz2c872KTTcHT87u5y3SYDrm4+m7f/jOFsm34ay+IL9UFfWs8ZE1p8l42vM6VonX08Uik8JfH09gjtWqIhPG5/3V9+c/wRJeTmaiGFHVJwQ8/entd29+vnjDfplM8/k7nswmMx5yNsQWzWipR48Xj4/uZt+g/l/fOnrKZtE+dRpV6nsJ9E3fs67EiEvL8TPHTSEaGyKbbDZzDPTe6+2Wh3/tyHNnvCnEEr1ifk2Nrb8CyR3RfhTuF++GhwP4vBeTJxMaGpPhrpQuA7kZ3NH60dPN9mZbDN2JI84W3+W4ji7Zz97DgWbh5ppnvKoqcvFZ27FIOH9/KQox759h2vSiIzyu+AkIV6IU1+JapKep3bUujW+ERrPocMH22S33VOx458YN+S415P4HJ/YkJA87dc6E/3JeT074M1fqj7T+y848f/nohB7awZq352a73f4LVGAtxA==",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"}},j={},g=[{value:"Request",id:"request",level:2}];function v(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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Update Document"})}),"\n",(0,n.jsx)(o(),{method:"put",path:"/document/{document_id}"}),"\n",(0,n.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,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(a.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.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,n.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(a.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,n.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,n.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.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,n.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",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.",example:!1}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",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.",example:!1}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - Permits signers to add elements such as signatures, initials, stamps, or text on top of existing widgets in the document. false - Restricts signers from adding any additional elements to the document. This is the default value.",example:!1}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(u.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Document updated successfully!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,n.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,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"400",value:"400",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.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,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(u.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.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,n.jsx)(a,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink