WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-27 12:04:52 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
64fa80139ab2c8b6b71fc411f815f7932670e49e
OpenSign/assets/js/bbdfc22d.37f9a006.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>j});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),c=(a(82723),a(9487)),o=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const u={id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktv2zgQ/ivcOW0NxY+k3YNOzQZBEWyxCdYu9uAYBkWNJSYSyZCUHdfQf18MZcmKkz5S5Li5RJ4XZz7OfMMdeJ45iOcww9IU3KODRQQpOmGl8VIriGGWI2vV7MIiJzk7v7livCj0xrHKoXXMayZIiUxUzutSfuVJgcy3gSO2yaXImUO7RsYdS4oKjZXKO7bSlmWo0HIvVcZSLaoSSbGRPmfGYoorqTBlzttK+MqiG7IvRivmKiHQuVVVdCc1aUitIuZzDIla9JVVjnFWKflQIRsMWuulTAcD5nPumeCKJUjlpFTNPiHspZNw0mkVAjuDQq4kGbcnc5WywaCyBYXUDFPpO+UQItAmlKjVVQoxNHC1eojA4kOFzv+p0y3EOxBaeVSePrkxhRTBdXTn6Fp24ESOJacvvzUIMejkDoWHCIylg7xER9qVLLBn5byVKoMIVtqW3EMMVNUf7yECfOSlIeO9iKESOsWUhRB1BF76H8TqJIdYLnx0OFAcpf2vhgmu9VGP/lKkfoQ6Aiczhdb1gnFr+RYikB5L92OcseSyeG0udxoTxI+NYCh0GeDh5avhudPIEgzQmFyrV/tPTs8mp5OzySnUh4vet2g7AMtEp9tlC1T93LAbKjJsDKinpcUUYm8rDAJntHINZqfjMf07Ipwng0xT3w15sf0NorcajEZMo9hZqqpM0BKIlX3xLg+A5d4bF49Ge0ll99fXA0WqQipcthUvT8fj5QeCpY7g/fjD88qv1JoXMg2cNdP3qN6wWrRW2++X1D/eN8dTqo9lgKLpSpCNUdDDk2L78qbIEn2uieqMdiEj7nOIYfSM+cJSoOGb7xrkO3id55lU2Qk3ZqgNKuq+gieOwB5xI0frCdQLiiAqK/12SnA0FT+ecCNPmoR6U23kX0hjva+nbxWBpGvIkafUBXUEhPI/B1q+bLFqafVFpjyAcsx9LfU9YbPjhfsCP/Xoad4xzQvk0VXV0kHHBv0BX9RU6EoHVPaZXhtUU5k1i309eZbULJeOSRfULR80LwFa3kfeTxclKUl+Npy0S7Pp4SG7VbdqqsuwdGmHF1Ldu/hWnbD59WolheQF+xcTJz0ufm9bYrPZPGuFd8Hnk/R5lTCLRh/MsyAM/dL36n68o/tCW7rr1RTtWop2ur9x1CgYj/aTyYXvkX8r+njsRJNSSIHKYW+Wzj/dfGZnwzFEva7/iZRHn68uLv+eXlJUmpvmiibD8XAcFoB2vuSqd9BF8zKbHfrwaH92JPP/c+/tnnt7xvH46Eem4FL1FktDhfPjR+Aigpy4Mp7Dbkfnf7FFXZP4oUK7hXi+iGDNrSS06VcdtXRFzHCPW7rt5jJPZnQ+mRdVw3xH26OOWo9zIdD479ouenR+cz2dQQTJ/qFa6pR8LN/QI5ZvIIZbuIXw4KUIgY2DfAcFV1nFs8BRIS79/QdgbV1+",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create Template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.",sidebar_label:"Create Template",hide_title:!0,hide_table_of_contents:!0,api:"eJztVktv2zgQ/ivcOW0NxY+k3YNOzQZBEWyxCdYu9uAYBkWNJSYSyZCUHdfQf18MZcmKkz5S5Li5RJ4XZz7OfMMdeJ45iOcww9IU3KODRQQpOmGl8VIriGGWI2vV7MIiJzk7v7livCj0xrHKoXXMayZIiUxUzutSfuVJgcy3gSO2yaXImUO7RsYdS4oKjZXKO7bSlmWo0HIvVcZSLaoSSbGRPmfGYoorqTBlzttK+MqiG7IvRivmKiHQuVVVdCc1aUitIuZzDIla9JVVjnFWKflQIRsMWuulTAcD5nPumeCKJUjlpFTNPiHspZNw0mkVAjuDQq4kGbcnc5WywaCyBYXUDFPpO+UQItAmlKjVVQoxNHC1eojA4kOFzv+p0y3EOxBaeVSePrkxhRTBdXTn6Fp24ESOJacvvzUIMejkDoWHCIylg7xER9qVLLBn5byVKoMIVtqW3EMMVNUf7yECfOSlIeO9iKESOsWUhRB1BF76H8TqJIdYLnx0OFAcpf2vhgmu9VGP/lKkfoQ6Aiczhdb1gnFr+RYikB5L92OcseSyeG0udxoTxI+NYCh0GeDh5avhudPIEgzQmFyrV/tPTs8mp5OzySnUh4vet2g7AMtEp9tlC1T93LAbKjJsDKinpcUUYm8rDAJntHINZqfjMf07Ipwng0xT3w15sf0NorcajEZMo9hZqqpM0BKIlX3xLg+A5d4bF49Ge0ll99fXA0WqQipcthUvT8fj5QeCpY7g/fjD88qv1JoXMg2cNdP3qN6wWrRW2++X1D/eN8dTqo9lgKLpSpCNUdDDk2L78qbIEn2uieqMdiEj7nOIYfSM+cJSoOGb7xrkO3id55lU2Qk3ZqgNKuq+gieOwB5xI0frCdQLiiAqK/12SnA0FT+ecCNPmoR6U23kX0hjva+nbxWBpGvIkafUBXUEhPI/B1q+bLFqafVFpjyAcsx9LfU9YbPjhfsCP/Xoad4xzQvk0VXV0kHHBv0BX9RU6EoHVPaZXhtUU5k1i309eZbULJeOSRfULR80LwFa3kfeTxclKUl+Npy0S7Pp4SG7VbdqqsuwdGmHF1Ldu/hWnbD59WolheQF+xcTJz0ufm9bYrPZPGuFd8Hnk/R5lTCLRh/MsyAM/dL36n68o/tCW7rr1RTtWop2ur9x1CgYj/aTyYXvkX8r+njsRJNSSIHKYW+Wzj/dfGZnwzFEva7/iZRHn68uLv+eXlJUmpvmiibD8XAcFoB2vuSqd9BF8zKbHfrwaH92JPP/c+/tnnt7xvH46Eem4FL1FktDhfPjR+Aigpy4Mp7Dbkfnf7FFXZP4oUK7hXi+iGDNrSS06VcdtXRFzHCPW7rt5jJPZnQ+mRdVw3xH26OOWo9zIdD479ouenR+cz2dQQTJ/qFa6pR8LN/QI5ZvIIZbuIXw4KUIgY2DfAcFV1nFs8BRIS79/QdgbV1+",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Create Template from binary",permalink:"/docs/API-docs/createtemplatewithbinary"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",strong:"strong",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create Template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(s.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(s.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(s.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(s.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://exampleurl.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink