WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-08-30 19:59:49 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/5a2de241.8057ae9d.js
T

1 line
14 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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),d=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",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 by ID",description:"Update template by ID",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 by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV9tu2zgQ/RXuPKWA4kua9kFPm22yqbFFYjQJ9iExDEoa2UwokiUpX2Do3xejm+U4l2Y32PpJpmbIOefMcEYb8HzmILyFa8yM5B4dTALQBi33QqtRAiHkJuEeGwMIwHDLM/RoyXMDimcIIawOuRGHXj+gggCEghDmyBO0EIDFH7mwmEDobY4BOL+W5ONEZiRtiSsjdYIQplw6MojnmHEIN+DXprT0VqgZFGTKS6eQwlROzFRvtVqtoAjaUHwd61QkTSiG+zkEkKCLrTCEDUIYnTKdMj9H1ngwP+eeKcTEMa9ZhKxCn7wniABSbTPuO7CKSbU/Ov+HTtbksxuqsXohEmQRSr1krQIUZBVhC8GxA+6ZRO480wo7tg2ADxBArJVH5ekgbowUcal3/97RaZv90HV0j7En8S1lhxfo6O1FSfjrALuyufKhjZc0vdD+zduMCSIyiwuBS8ZVwigXmJ8LxxId5xnBKwI47fL4tiParOhqUQTwp5YJWiqOt+23uncRH57z1RiKIgAv/M4x007eTiNKg6IgO4vOaOUqxo8Gg/3saIqzyVbm8jhG59JcyvVv7yd3XKZ3a6XyLCrruwXdrrSgjwaDIoAMneOzN2vcwdXAalBBRUwu/ethV8tP67U9jLvk6KsbH381O+oIJYXCaSPC9GgwmA6H0/rs1y1rEY+f0q3O4aa4F1yKhKUCZcLoKnO/Vrrj/yLd69Beoo7Yang7fiHflfYs1blKfjVTx++Q5B0wL3NzPP3csvNpn52Rqtg+GY/YNfXj/4GcDhWfXqZiC7wbp6/iJEyrTJJf3ctFZVTNFTusdNcrNnZpuNntiyxas9EpUGx+rmmwMXmJjyaDEPqNXX/TuYYLCMChXTSzTm4lzTXeGxf2+9yYXjOESB65XqyzPjeivxgCdXSHcW6FX18RuRV/3SlpSw434i9cQ/D6LEUwSbPv22HhrCG0acd7HbZpsD/XMx+1zKe7YLcJ7vQ1CjfVJbZaqUuD6oqOIZ0Xw70p7JpOF6583QRRJidLtWWPvFnEHSZMq3Jso5e0/rE3ZM5gLNI6r3vsTt2pK50hyx2muWRSqAcX3qlDdnuZpiIWXLK/MXLC4+SgEXS5XO4J+qH0ORd+nkfMotFb81m5WKre9Wr/0KDl0WbuMr1CuxAx1snzzFH90rhfVyuPy2rFjAtKunrp98dORLkUMSqHnbI5OR9/Yx97Awg6OfsTIfe/jb6cXVyd0a6U9ZVEw96gN6Alo53PuOoc9FyVJU+OXR5Xvm8kF2Utl5Ft6gq8hU6+ht0RfhLAXDtPJpsN6X9jZVHQ8o8c7RrC20kAC24FjyjhbjeQCEfPSTuKP4qmvQzh4HszFLO3fQ08CagpZ0W1vOAyp38QwAOuH32WFJMiaGr6X0f8XBjVcbuXSBsNfSdVBl+qPQ+vaY+txV572HqcxDEa/6LtpHPBjm+uIYCo/qDJytYBli/pY4ovIYQ7uCN6dAmzvB/L9Q1IrmZ52UCg2pZ+/wBCEBBO",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 by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function y(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 by ID"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\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)(d.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.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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(m.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",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.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)(m.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:200}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template upated sucessfully"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsx)("div",{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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template upated sucessfully",\n "result": {\n "objectId": "asd2HsP4Hp"\n }\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)(m.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:400}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 400,\n "message": "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)(m.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:404}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 404,\n "message": "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)(m.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink