WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
efbb51cf15f2ce2d7f51c72cd5cb94aac3aa89af
OpenSign/assets/js/5a2de241.62506cb5.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:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),p=s(41429),m=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template from ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVkbpMGKxWgcDFhiGLR0splQJEtSdgxD/304SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbLj+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4KOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0nkIdWb0UGbIZSr1iW9oEso1nmyN2xD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7h152xxC17N7TD1F3FJKvEBHb+uA/z1BCg4PYUrAhT9bvFBFoLR/tZkRUURmcSlwFQrLiblifiEcy3RaFkSv2kv561xsq6JroyIdmaGlinydvcd7N+PDC/44gqqKwAv/xM20U7fTGZVBVZGcRWe0cnXEj+P4sDq2N6+pVubKNEXn8lLK9U8/Lt318fPEdzS5y44/udHpJ0PBaiCd+ZeVjuPjk94w7sXvx8N3yenPydt3/TiO/4QIHgu5qzXImpppo1c/dw6EkkLhtI3a9DiOpydNKE+fi15TSaa5YksuRcZygTJj5NP9wACitdr+w0p/Ad9L9IlyS/70hdJR2rNclyr7v+k+h+hlgqfT91uKbw8pXqo6ZDSWxvoB1X/BcMen697X7gnq06oWtVB4D0/Ids9rkgX6haZxaMoAiEZbAoO2eww2nT5SQQQO7bKdkKWVkMDCe+OSwcB5Phdq3uPG9LVBRR1U8pnrp7oYcCMGyyHQaHKYllb49TVFpSb+2ONG9GpcO/rciN9wDVFLqyvVTOIF8gxtCAEF+8tu6p23IdtGZX9UtJPi+5r//rh/tp13u/mTBk1wcx24Nbm4MqiuyQ1lcjk8sD8m78KF1y2IUFUs15btabMZd5gxrcL+QS/p/KQ/3O5BQbXP7tSdutYFstJhXkomhXpwyZ3qsdurPBep4JL9gTMnPE6O2sSuVquDhL4JOhfCL8oZs2j0TnweDkPWu1rbB9oYPNrCXeXXaJcixaaIvuFqEIQHzTXjabhmWHBBxdcc/bKvRCGXIkXluiVwdjH6zE76MUSd2v0OyIPPlx/Of78+J6tU/XWKhv24H9OR0c4XXHUc7S+xudUFu/y4n+XNrnP827tvc6c8PvqBkVyExhCCsGku/S10rkbSXXsnESy08ySy2VCp3VhZVXT8tUS7huR2EsGSW0FIQ2fIhKP/2XZ9/Sbtoy/tIslet0E/S6jtHIraxpLLkp4gggdc763y1aSK2vZBiGuJDzWu3pjs7CwcNPUqajXO0hSNf1F20umyo5sxRDBr1vIibPhg+Yo+CfgKEriDOwifKmQgNMdwvgHJ1bzkc5KvzdLvLwq+nGw=",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 from ID",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 from ID",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2ZaTtMX0aVkbpMGKxWgcDFhiGLR0splQJEtSdgxD/304SrIVO82aodv8yaLu5XnujnenDXg+d5DcwhgLI7lHB5MIMnSpFcYLrSCB8QLZjcm4R9ZKsbPRJUPFZxIdW+uSec0KnYl8zbjKWFlL+wWyDD0X0jGdM86cwVTkImW+sdOHCLRBy8nVZQYJ1KqtH4jAcMsL9GgJ5gYULxASaA1MRQYRCIJpuF/APvbLj+SZgLQazC+4Zwoxc4R6hg1asmPxayksZpB4W2IEzq8leXOiMJLA4KOROkNIci4dCaQLLDgkG/BrEyS9FWoOEeTaFtzvTqpqUttH53/V2Zp0nkIdWb0UGbIZSr1iW9oEso1nmyN2xD2TyJ1nWmFHtiXwBiJItfKoPDnixkiRhiAP7h152xxC17N7TD1F3FJKvEBHb+uA/z1BCg4PYUrAhT9bvFBFoLR/tZkRUURmcSlwFQrLiblifiEcy3RaFkSv2kv561xsq6JroyIdmaGlinydvcd7N+PDC/44gqqKwAv/xM20U7fTGZVBVZGcRWe0cnXEj+P4sDq2N6+pVubKNEXn8lLK9U8/Lt318fPEdzS5y44/udHpJ0PBaiCd+ZeVjuPjk94w7sXvx8N3yenPydt3/TiO/4QIHgu5qzXImpppo1c/dw6EkkLhtI3a9DiOpydNKE+fi15TSaa5YksuRcZygTJj5NP9wACitdr+w0p/Ad9L9IlyS/70hdJR2rNclyr7v+k+h+hlgqfT91uKbw8pXqo6ZDSWxvoB1X/BcMen697X7gnq06oWtVB4D0/Ids9rkgX6haZxaMoAiEZbAoO2eww2nT5SQQQO7bKdkKWVkMDCe+OSwcB5Phdq3uPG9LVBRR1U8pnrp7oYcCMGyyHQaHKYllb49TVFpSb+2ONG9GpcO/rciN9wDVFLqyvVTOIF8gxtCAEF+8tu6p23IdtGZX9UtJPi+5r//rh/tp13u/mTBk1wcx24Nbm4MqiuyQ1lcjk8sD8m78KF1y2IUFUs15btabMZd5gxrcL+QS/p/KQ/3O5BQbXP7tSdutYFstJhXkomhXpwyZ3qsdurPBep4JL9gTMnPE6O2sSuVquDhL4JOhfCL8oZs2j0TnweDkPWu1rbB9oYPNrCXeXXaJcixaaIvuFqEIQHzTXjabhmWHBBxdcc/bKvRCGXIkXluiVwdjH6zE76MUSd2v0OyIPPlx/Of78+J6tU/XWKhv24H9OR0c4XXHUc7S+xudUFu/y4n+XNrnP827tvc6c8PvqBkVyExhCCsGku/S10rkbSXXsnESy08ySy2VCp3VhZVXT8tUS7huR2EsGSW0FIQ2fIhKP/2XZ9/Sbtoy/tIslet0E/S6jtHIraxpLLkp4gggdc763y1aSK2vZBiGuJDzWu3pjs7CwcNPUqajXO0hSNf1F20umyo5sxRDBr1vIibPhg+Yo+CfgKEriDOwifKmQgNMdwvgHJ1bzkc5KvzdLvLwq+nGw=",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 from ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template from ID",permalink:"/docs/API-docs/delete-template"}},f={},y=[{value:"Request",id:"request",level:2}];function g(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 from ID"})}),"\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)(p.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",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)(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)(m.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)(m.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)(m.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,t.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