WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 13:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
b0783458983bf2d1d336b9727d073c8b0b983b3d
OpenSign/assets/js/5a2de241.5a92f5d2.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:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});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),c=s(4667),o=s(9472),h=s(85162);const x={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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=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:"eJzFV91u2zYUfpVT3qwFFNtJ0xYThmFdW7RBizVoUhRYYgRH0pHNhiJZkrJjGLrbk+zR9iTDoSRbcdK0HbrtJnCo8/edv49ci4AzL9IzcUqVVRjIi2kiCvK5kzZIo0UqTucE722BgaCXgqfHR0AaM0UeVqaGYKAyhSxXgLqAupUOc4KCAkrlwZSA4C3lspQ5hM7OSCTCWHLIro4KkYpWtfcjEmHRYUWBHIe5FhorEqnoDVzIQiRCcpgWw1zsxn70nD1zIL0GhDkG0ESF56gz6qJlO44+1dJRIdLgakqEDyvF3rysrOJg6MoqU5BIS1SeBfI5VSjStQgrGyWDk3omElEaV2HYnjTNtLVPPvxqihXrXA/12JmFLAgyUmYJG9gcZJ/PvkZwHwMoQh/AaBrI9gAeiETkRgfSgR2htUrmMcnjj569rW+GbrKPlAfOuOOSBEmev7YJ/zJATg7GNKXCxx+beEWTCG3CN5s5ZogEjhaSlrGxvJxpCHPpoTB5XTG8Zqfk3+Zi0xVDGw3rqIIcd+RNe1tt0TSJCDJcM3Ux6M2LjEvdNCznyFujfZvVg8nkZgdspqvrSPB1npP3Za3U6t73K2l7/CVw6IuDV/748JXlhHQhPQ13Kx1MDh7u7U/2Jk9O9x+nhz+mjx6PJpPJ7yIRV5Xa9pMour7os9f+PziQWklNF33WLg4mk4uHXSoPb8te1y22G6MFKllAKUkVwD79d0wgOWfcP+zmO+K7Cz5D7sEf3tE62gQoTa2L/xvubRHdDfDw4skG4qObEI90mzKmnlNzSfq/QLjFM3QfWvcc6vWulq1Q/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvTu1ptv4TzjHbRqvodgkE618TSuR9EkaSnXcPScsyMWEcunebXnyRV+ATY53yaXnlq+ji90Lwq0EMNz/gusodWkioq6eby3pEzbO3bDYv2H1A6ncVMTczXePXvyvP/6MGn00sVnvwdvagTVLcmWtYtyloiuZqfaahUqZ5eaW5QkrRd6rFUgdaOZi7HImA6qIV+oZ5Ggxk0pye7OYYW0HgwnxI/gwpzAnx59+cAQIBS1I8VSAMuaS7QQDWAdTRR9dzLA07rLkkBJAyGovNXkPnqhXIT1HnRP0DZKAcYAaSAdy1klPgLJi4dI4oLKUuWTDPMsO8wAVapwRO0uA4+YsdGvTgzNZ7QN4o+oIJF49iUILMd7rRvBcLqgFzoftHZQKmNVsIoHcFATdaDMMXUBGPoBl9zKnaNQHdHzLWpCLAxEryVQM1vDOkaj4bjmsLRsKDrXnxdgG1Jdmkz7rDHN69FHgagTn+lyfcLPUnrgBlNSXPj3Xe3C2abMPlHkZaHq/H9LlcnljOB9c13kpw7zOwJE1W71ZPIyjPFTf/MMXx0Cu8m/LE3ILmVO3GT7jcxyFx90mxjxuYqpQqnbwf9lV4GlSMifthzP99OXxG1jAw9FEJIN19BUBj98cPXvx28kLtsvrr52//dFkNOEja3yoUA9c7bxkdkd3vaWUf/vh063HQFdhbBXKyBgR/Lrb9mdisOXS4Ztnmoi58YFF1usMPb13qmn4+FNNjjllmogFOsmRRkoopOffxebt8lnY99/1rwj4tufTrYB6EtDMAAtUdbw4J+KSVjvvuGbaJD0TcMStxLM2rr1TtrO1cIPtmchajad5TjbcKTuk1+P3pyIRWfcmq+LzTjhc8nsQlyIV5+JcxHdq3DcsFM/XQqGe1Thj+dYs8xfWXLkh+V1G8ut+MLBbU3KdFVsk/Jdx3arwE7fia1r9vBFvv3xWoUttL83lmTZN8zfUGZUV",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={},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,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)(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 y(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink