WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-30 21:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
e98a4b594de09e6ea27c25f05bc3acba404dcd6c
OpenSign/assets/js/5a2de241.f6ff51c6.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:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>v});var l=s(85893),t=s(11151),i=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),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/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={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/ivcfWoB2ZaTtMWEYVjWFW3QYjEaFwOWGAYtnWw2FMmSlB3D0H8fjpJs2XG9Zui2L4ZM3dvz3PHutAHP5w6SWxhjYST36GASQYYutcJ4oRUkMF4g+2Qy7pG1UuxydMVQ8ZlEx9a6ZF6zQmciXzOuMlbW0n6BLEPPhXRM54wzZzAVuUiZb+z0IQJt0HJydZVBArVq6wciMNzyAj1aCnMDihcICbQGpiKDCASFabhfwGHsV7+RZwqk1WB+wT1TiJmjqGfYREt2LH4phcUMEm9LjMD5tSRvThRGUjD4YKTOEJKcS0cC6QILDskG/NoESW+FmkMEubYF97uTqprU9tH5X3W2Jp39UEdWL0WGbIZSr9gWNgXZ8tnmiD3jnknkzjOtsCPbAngOEaRaeVSeHHFjpEgDyYPPjrxtHoeuZ58x9cS4pZR4gY7e1oT/PUAihweaEnDhYRsvVBEo7Z9sZkQQkVlcClyFwnJirphfCMcynZYFwasOUv40F9uq6NqoSEdmaKkin2bv4bOb8eFb/jCCqorAC7/nZtqp2+mMyqCqSM6iM1q5mvGzOH5cHdub11Qrc2WaonN5KeX6h++X7vr4OPAdTO6ys3dudPHOEFlNSJf+tNJZfHbeG8a9+NV4+DK5+DF58bIfx/GfEMFDIXe1BllTMy179f/OgVBSKJy2rE3P4nh63lB5cYy9ppJMc8WWXIqM5QJlxsin+44EorXa/sNKPxHfKfgEuQV/caJ0lPYs16XK/m+4xyI6DfBi+moL8cVjiFeqpozG0ljfo/ovEO7wdN372j2Ful/VohYK72EPbPe8BukwLa3w6zDyHnrciF79Prmd0CAp0C80jUtThoBp9CUwaLvLYNPpMxWQPbtsJ2hpJSSw8N64ZDDgxvS1QUWdVfKZ66e6GHAjBsshVNGhtPN8LtS8d1Jrsov/hjiuadxDsSWTG/Ee1xC1JHWlmrm+QJ6hDYRS6j7uZuibNgFbjg8HTzt3vm2UHC4PR4dDdzbstXsKN9cBW5PZa4PqhtxQXSyHj+yPybtw4XUbRKhRlmvLDrTZjDvMmFZhm6GXdH7eH263qqDaZ3fqTt3oAlnpMC8lk0Ldu+RO9djtdZ6LVHDJ/sCZEx4nz9rErlarRwl9HnTeCr8oZ8yi0TvxeTgMWe9qbf/Q/uHRFu46v0G7FCk2RfQVV4MgPGguLU/DpcWCCyq+5uiXQyWiXIoUleuWwOXb0Qe2ZOf9GKJO9X5D0IMPV6/f/H7zhuzSbamTNOzH/ZiOjHa+4Krj6mApPszvZteB/u0durlNHh/8wEguQoMJ4DdNc7iFzqVIuuvzJIKFdp5ENhsqsk9WVhUdfynRUguaRLDkVlCkoYNkwtFztl2Dvwr72cd2IWVP28SPAmp7hqKGseSypH8QwT2uDz4JqkkVtY2DIq4lXtdx9cZkZ2fh0XCgvldrXKYpGn9SttuNR5/GEMGsWe+L8KUAlq/o04KvIIE7uIPwyUMGQlsM5xuQXM1LPif52iy1O15S5rq98j70yuaBgB2lZL+J1kjol3AdVfiJSvE9rn/eitdvvqrQUNtKU3omVVX9Ba+K7fQ=",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 y(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)(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)(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)(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",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\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)(c.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)(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)(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)(c.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)(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)(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)(c.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)(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)(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)(c.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)(o.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)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink