WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-09 19:27:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3436c2afc5d3dabaeec7290dda3eb3cfa331f40f
OpenSign/assets/js/5a2de241.7d7e666b.js
T

1 line
12 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:()=>j,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>f,toc:()=>v});var l=s(85893),t=s(11151),i=s(58219),d=(s(62316),s(51039)),n=s.n(d),r=(s(82723),s(9487)),m=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={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:"eJzFV21v2zYQ/ivcfUoB2VZe2mLCMCzrijZo0RiNgwFLDIOWTjYbimRJyo5h6L8PR0m2YiduM3TbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xR/kmQJpNZifc88UYuYo6ik20ZIdi19LYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+d52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5ABKlWHpUnR9wYKdJA8uCLI2/r/dD19Aumnhi3lBIv0NHbmvBvAyRyeKApARceNvFCFYHS/tlmhgQRmcWFwGUoLCdmivm5cCzTaVkQvGon5c9zsamKro2KdGSGlipy395WG6oqAi/8A1OTTm1OppTqqiI5i85o5WpWT+J4vwI2t6upSObKNEXn8lLK1U8/LqX18bfAcZedvHfDs/eGCGlCOveHlU7ik9PecdyLX4+OXyVnPycvX/XjOP4LIrgv5LaeIGvqomWv/t85EEoKhZOWtclJHE9OGyrPHmOvqRbTXKMFlyJjuUCZMfLpfiCBaK22/7CaD8R3CD5BbsGfHSgdpT3Ldamy/xvuYxEdBng2eb2B+HIf4oWqKaPRM9J3qP4LhFs8Xfe+dk+hPqxqUQuF9/AAbPe8BukwLa3wqzDW7nvciF79PrkZ07Ao0M81jURThoBpvCUwaLvLYN3pMxWQPbtop2RpJSQw9964ZDDgxvS1QUXdU/Kp66e6GHAjBotjqKJdaef5TKhZ76DWeBv/FXFc0/gAxYZMbsQHXEHUktSVamb3HHmGNhBKqfu8nZNv2wRsON4dLu1s+b5xsbsgPDoAuv0fKI9C5TogavJ5aVBdkXGqhsXxntUR+RQuvG5dh8pkubZsR5tNucOMaRX2FHpJ56f9482+FFT77FbdqitdICsd5qVkUqg7l9yqHru5zHORCi7Znzh1wuP4qE3ncrncS+OLoPNO+Hk5ZRaN3orPwmHIdVdr84c2C4+2cJf5FdqFSLEpnSdcDYLwoLmqPA1XFQsuqOSao992lYhyKVJUrpv483fDj2zBTvsxRJ2a/Y6gBx8v3rz9dPWW7NIdqZN03I/7MR0Z7XzBVcfVzrq7m9/1tu/829txc4c83vuBkVyEthLAr5uWcAOdq5B0F+NxBHPtPIms11Rk11ZWFR1/LdFS4xlHsOBWUKShb2TC0XO2WXCfhH30uV012fN27EcBtZ1CUZtYcFmG7SqCO1ztLPvVuIradkER1xJv6rh6I7KztbA3Eqjb1RrnaYrGH5Tt9uDh9QgimDaLexG+AcDyJX008CUkcAu3ED5myEBohuF8DZKrWclnJF+bpSbHS8pct0PehQ7ZPBCwRyl52DprJPRLuB5V+IVK8QOuft2I12+eVGiobaUpPeOqqv4Gp4TgdA==",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-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:"eJzFV21v2zYQ/ivcfUoB2VZe2mLCMCzrijZo0RiNgwFLDIOWTjYbimRJyo5h6L8PR0m2YiduM3TbF0Om7u157nh3WoPnMwfJDYywMJJ7dDCOIEOXWmG80AoSGM2RXZuMe2StFDsfXjBUfCrRsZUumdes0JnIV4yrjJW1tJ8jy9BzIR3TOePMGUxFLlLmGzt9iEAbtJxcXWSQQK3a+oEIDLe8QI+WwlyD4gVCAq2BicggAkFhGu7nsBv7xR/kmQJpNZifc88UYuYo6ik20ZIdi19LYTGDxNsSI3B+JcmbE4WRFAzeG6kzhCTn0pFAOseCQ7IGvzJB0luhZhBBrm3B/fakqsa1fXT+d52tSOdhqEOrFyJDNkWpl2wDm4Js+WxzxI64ZxK580wr7Mi2AF5ABKlWHpUnR9wYKdJA8uCLI2/r/dD19Aumnhi3lBIv0NHbmvBvAyRyeKApARceNvFCFYHS/tlmhgQRmcWFwGUoLCdmivm5cCzTaVkQvGon5c9zsamKro2KdGSGlipy395WG6oqAi/8A1OTTm1OppTqqiI5i85o5WpWT+J4vwI2t6upSObKNEXn8lLK1U8/LqX18bfAcZedvHfDs/eGCGlCOveHlU7ik9PecdyLX4+OXyVnPycvX/XjOP4LIrgv5LaeIGvqomWv/t85EEoKhZOWtclJHE9OGyrPHmOvqRbTXKMFlyJjuUCZMfLpfiCBaK22/7CaD8R3CD5BbsGfHSgdpT3Ldamy/xvuYxEdBng2eb2B+HIf4oWqKaPRM9J3qP4LhFs8Xfe+dk+hPqxqUQuF9/AAbPe8BukwLa3wqzDW7nvciF79PrkZ07Ao0M81jURThoBpvCUwaLvLYN3pMxWQPbtop2RpJSQw9964ZDDgxvS1QUXdU/Kp66e6GHAjBotjqKJdaef5TKhZ76DWeBv/FXFc0/gAxYZMbsQHXEHUktSVamb3HHmGNhBKqfu8nZNv2wRsON4dLu1s+b5xsbsgPDoAuv0fKI9C5TogavJ5aVBdkXGqhsXxntUR+RQuvG5dh8pkubZsR5tNucOMaRX2FHpJ56f9482+FFT77FbdqitdICsd5qVkUqg7l9yqHru5zHORCi7Znzh1wuP4qE3ncrncS+OLoPNO+Hk5ZRaN3orPwmHIdVdr84c2C4+2cJf5FdqFSLEpnSdcDYLwoLmqPA1XFQsuqOSao992lYhyKVJUrpv483fDj2zBTvsxRJ2a/Y6gBx8v3rz9dPWW7NIdqZN03I/7MR0Z7XzBVcfVzrq7m9/1tu/829txc4c83vuBkVyEthLAr5uWcAOdq5B0F+NxBHPtPIms11Rk11ZWFR1/LdFS4xlHsOBWUKShb2TC0XO2WXCfhH30uV012fN27EcBtZ1CUZtYcFmG7SqCO1ztLPvVuIradkER1xJv6rh6I7KztbA3Eqjb1RrnaYrGH5Tt9uDh9QgimDaLexG+AcDyJX008CUkcAu3ED5myEBohuF8DZKrWclnJF+bpSbHS8pct0PehQ7ZPBCwRyl52DprJPRLuB5V+IVK8QOuft2I12+eVGiobaUpPeOqqv4Gp4TgdA==",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"}},j={},v=[{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 Template"})}),"\n",(0,l.jsx)(n(),{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)(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)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.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,l.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(c.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)(i.Z,{children:[(0,l.jsxs)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.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,l.jsx)(h.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)(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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(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,l.jsx)(h.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)(h.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)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.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)(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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(c.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)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(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