WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-29 04:54:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c261e8a628ddc918ee2dd0125d1dd6c34e17339c
OpenSign/assets/js/5a2de241.2b8fccd7.js
T

1 line
13 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>v});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=s(9472),u=s(85162);const h={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",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-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV+9u2zYQf5Urv6wFFNtJ0xYThmFdW7RBiyVoUhRYYgQn6WyzoUiWpOwYhr7tSfZoe5LhKMmWnTRthm77EjjU/fvdHe93XImAUy/Sc3FGpVUYyItxIgryuZM2SKNFKs5mBB9sgYGgk4LnJ0dAGjNFHpamgmCgNIWcLAF1AVUjHWYEBQWUyoOZAIK3lMuJzCG0dgYiEcaSQ3Z1VIhUNKqdH5EIiw5LCuQ4zJXQWJJIRWfgUhYiEZLDtBhmYjf2o5fsmQPpNCDMMIAmKjxHnVEbLdtx9LmSjgqRBldRInxYKvbmZWkVB0PXVpmCRDpB5Vkgn1GJIl2JsLRRMjippyIRE+NKDJuTuh439smHX02xZJ3tUE+cmcuCICNlFrCGzUF2+exqBA8xgCL0AYymnmwH4JFIRG50IB3YEVqrZB6TPPzk2dvqZugm+0R54Iw7LkmQ5Plrk/CvA+TkYExTKnz8sY5X1InQJtzbzAlDJHA0l7SIjeXlVEOYSQ+FyauS4dU7Jb+fi3VX9G3UrKMKctyRN+1ttFmyuQXHZyc90cwYRaj7srFh6joRQYYtz5e9Vr7MuDPqmuUceWu0b4pwMBrdbJj1ZWwbGHyV5+T9pFJq+eD7dUBz/LVcoC8O3viTwzeWs9KG9DzcrXQwOni8tz/aGz0723+aHv6YPnk6GI1Gv4tEXJdq036iaNuoy17zf+9AaiU1XXZZuzwYjS4ft6k8vC17bXPZ9tbNUckCJpJUAezTf8cEknPG/cPmvyO+u+Az5A784R2to02Aial08X/DvS2iuwEeXj5bQ3xyE+KRblLGTHVmrkj/Fwg3ePruQ+OeQ93uatkIxe9iC2z/vAHpKa+cDMvIgtd7aOVe8z09HzO3lBRmhhnUVjFgZsNUDLvpMlz15kwt2J6bd6RaOSVSMQvB+nQ49KiLzFwPjCXNA1dh5ge5KYdo5XC+L+pkVwOtvYe0DziVerp3p9Z4g/iUq9Ikfgv3Ov1o5VtaiqRLa1+qXQ5mhAW5WAIu9vsNEb/qSrauyi57deT1bXy0u4HcyjB9ghFii0QaouCwJyZibHvi2JI+ZXfcUfP9G34+kspNSbwu8LrTif/1x59Ro4svNvwDOK4cWLMgN6lURDJRdC0z1Wx2qJRZrBc7T1gq8l4tQepAUxfRyKkMqGIGpJ5CjhYzqSRfERYzrO2gd8v8AD7OKMzI8acfHAFCQXNSfLNAGXPFdoIBrIIpo482ZlgYdzXhkBJAyCovNXkPnqhTIT1DnRN0LZOAcYAaSAdy1klPgLJk4YlxQJOJzCUb5nngMA9QosYpsbMEOG7OQjt6PTiTVT6AN6qKQOK2SxQaiHGVHMBLOacGOB82ay8VMK3YRAK5KQja8cAwdAEZ+QCW3cucolEf0PFiNycXr0isJNM5WMNzS6LidbZfWzYUHGrPw7UJqCvNOn3WGd4Loo8ClwO40Bf6lJul8sQNoKS+8umF3oPzdZt9pMzLQOOH3bVdLBY3ruujbZ3XMsyqDBxZs9GbxsN4ufvq6394Vw3kSn88OSU3lzm1s+ILPodReNhOc8zjNKcSpWpGwS+7CjxZlcxJ+/4tf/765B3M4fFgJJLegPqGgIfvjl68+u30FdvlEdrcv/3BaDDiI2t8KFH3XO08nnav7mpDS//2W6sdmIGuw9AqlJF1IvhVyxjnojf30v4za5yImfGBRVarDD19cKqu+fhzRY55aZyIOTrJkUZaKaTn38X6ufRF2A/fdw8XuN+L7VZAHS1o5oQ5qoqaKXtFy52nYz2uk44bOOJG4kUT194Z29lYuLExMLU1Gs/znGy4U7ZP0ScfzkQisvYZWMYXpXC44CcoLkQqLsSFiE/jOG9YKJ6vhEI9rXDK8o1ZZjSsuHJ9OryKdNj+YGC3pmSbJxsk/Jdx3arwE7fiW1r+vBZvvnxRoU1tJ83lGdd1/Tf6s7z3",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,i.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 Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\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)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.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)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(o.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.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