WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-12 12:47:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/0028a090.1a71e32c.js
T

1 line
9.4 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var s=t(85893),l=t(11151),i=t(58219),n=(t(62316),t(51039)),r=t.n(n),d=(t(82723),t(9487)),o=(t(41429),t(5397)),m=t(4667),c=t(9472),p=t(85162);const h={id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .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:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWjNVyKG683F3vQ7Iq8L8XsxQlSnbSIsipF5ua93wz85E7CHzlIZ/DDGureEAPiwwK9MJJG6TRkMOsQvab42VgnRG7vL1mXCmz8WxrIguGCYekENEHU8u/+VIhK5JT6CKzEUUiV4chOu0ZZ1HLx4hsMOis7mUxGLBQ8cAE12yJLHosKMMKNTrKURgRa9TBsyUnndEsVMi8RSFLScZdmVwXbDCITlFIw7CQx3JGkIGxFFEafV1ADqncTg0ZOHyM6MOvpthCvgNhdEAd6JFbq6RInuNPnkDagRcV1pyewtYi5GCWn1AEyMA6yhMketKWUmHPygcn9QoyKI2reYAcqKkf30IG+MRrS8Z7EUMtTIEFSyGaDIIM/xLrIDnG8unhAAPF0SZ8bZjk2pxtzFdF6kdojs2dTuV+ScNoSE/TkQ4LyIOLmATeGu1blF9PJvTvbJG7vWiXtWA+CoHel1Gp7XeQfasRt2LaqYOljvUSHSEVnXoJoSMeVQjW5+NxdGoYzJCWdnhYWmHqE3SkVlLjfdf7/evJ5L4IhFCTwdvJD89BuNZrrmSR7nBmHlB/w8bROeO+3F0/fWjTU6lPdUJF87rtKhklPZx025e3TXoU0cmwhXy+g6cht3LY6vP5ollkUGOoDJ23NT5VzEMFOYzPr92jW6PzKUya0WEQPvCV1Ksht3ZkLGovV1rxpadhjLmV4/UFUKaukimh1QJyUs8BFm7lB9xC1rXbt8pA0pQq5AXtS5MBDeGPIxVddVB2VPIiOxwxO7/37txPLvic8l+6SaqsNKmNfegbi3oqVzoNc33xLMqskp5Jn9QdaafFYqVx7Mz7lMxJSfI3o4uO2NudHLE7faenpk4vhjIqpqR+8PmdHrL5TVlKIblif+HSy4CL77sZbjabZ7N7lXzey1DFJXNozdF8lYRpwH2vw49XBDC62t+UU3RrKbrD/UyqcTIe7y+Ni3RpWHNJe7YX/XLuRJArKVB77N3G5fvbj+zNaAJZb03/Q8njj9fvrn6fXlFUWvR2RBejyWhCIrqOmuteotNX/vlwe+/D//EHwv5gAz6FsVVc6h6Dt0QyP/tsWGRQEdHkc9jtKP2fTjUNiR8jOmKpRQZr7iQBkDgq646dmOcBt5DDuxba4YzSk7mKLW+cUXOTdR6XQqANX7Ttc+HtzXQGGSz3nza1KcjH8Q199vAN5HAHd5C+kChC4rIk34HiehX5iuzbuMRRPBIWfYJ7SAS3f6DOOpXe9qo8Zb62FfpLjb3o8BNtxwfc/nwwbzWfddhj21nTBBdN0/wD7CPKug==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .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/drafttemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/drafttemplate",permalink:"/docs/API-docs/drafttemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"drafttemplate",title:"Draft Template",description:"The Draft Template API allows you to create customizable draft templates .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:"Draft Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVktv20YQ/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWjNVyKG683F3vQ7Iq8L8XsxQlSnbSIsipF5ua93wz85E7CHzlIZ/DDGureEAPiwwK9MJJG6TRkMOsQvab42VgnRG7vL1mXCmz8WxrIguGCYekENEHU8u/+VIhK5JT6CKzEUUiV4chOu0ZZ1HLx4hsMOis7mUxGLBQ8cAE12yJLHosKMMKNTrKURgRa9TBsyUnndEsVMi8RSFLScZdmVwXbDCITlFIw7CQx3JGkIGxFFEafV1ADqncTg0ZOHyM6MOvpthCvgNhdEAd6JFbq6RInuNPnkDagRcV1pyewtYi5GCWn1AEyMA6yhMketKWUmHPygcn9QoyKI2reYAcqKkf30IG+MRrS8Z7EUMtTIEFSyGaDIIM/xLrIDnG8unhAAPF0SZ8bZjk2pxtzFdF6kdojs2dTuV+ScNoSE/TkQ4LyIOLmATeGu1blF9PJvTvbJG7vWiXtWA+CoHel1Gp7XeQfasRt2LaqYOljvUSHSEVnXoJoSMeVQjW5+NxdGoYzJCWdnhYWmHqE3SkVlLjfdf7/evJ5L4IhFCTwdvJD89BuNZrrmSR7nBmHlB/w8bROeO+3F0/fWjTU6lPdUJF87rtKhklPZx025e3TXoU0cmwhXy+g6cht3LY6vP5ollkUGOoDJ23NT5VzEMFOYzPr92jW6PzKUya0WEQPvCV1Ksht3ZkLGovV1rxpadhjLmV4/UFUKaukimh1QJyUs8BFm7lB9xC1rXbt8pA0pQq5AXtS5MBDeGPIxVddVB2VPIiOxwxO7/37txPLvic8l+6SaqsNKmNfegbi3oqVzoNc33xLMqskp5Jn9QdaafFYqVx7Mz7lMxJSfI3o4uO2NudHLE7faenpk4vhjIqpqR+8PmdHrL5TVlKIblif+HSy4CL77sZbjabZ7N7lXzey1DFJXNozdF8lYRpwH2vw49XBDC62t+UU3RrKbrD/UyqcTIe7y+Ni3RpWHNJe7YX/XLuRJArKVB77N3G5fvbj+zNaAJZb03/Q8njj9fvrn6fXlFUWvR2RBejyWhCIrqOmuteotNX/vlwe+/D//EHwv5gAz6FsVVc6h6Dt0QyP/tsWGRQEdHkc9jtKP2fTjUNiR8jOmKpRQZr7iQBkDgq646dmOcBt5DDuxba4YzSk7mKLW+cUXOTdR6XQqANX7Ttc+HtzXQGGSz3nza1KcjH8Q199vAN5HAHd5C+kChC4rIk34HiehX5iuzbuMRRPBIWfYJ7SAS3f6DOOpXe9qo8Zb62FfpLjb3o8BNtxwfc/nwwbzWfddhj21nTBBdN0/wD7CPKug==",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",permalink:"/docs/API-docs/createtemplate"}},f={},j=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",strong:"strong",...(0,l.a)(),...e.components},{Details:t}=a;return t||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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Draft Template"})}),"\n",(0,s.jsx)(r(),{method:"post",path:"/drafttemplate"}),"\n",(0,s.jsxs)(a.p,{children:["The Draft Template API allows you to create customizable draft templates .The API returns a unique ",(0,s.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,s.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,s.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,s.jsx)(a.p,{children:"Body"})}),(0,s.jsx)("strong",{className:"openapi-schema__required",children:(0,s.jsx)(a.p,{children:"required"})})]}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}})]})]})})}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(p.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template created successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,s.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://url-to-edit-template.com"}})]})]})}),(0,s.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "objectId": 0,\n "url": "https://url-to-edit-template.com"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(p.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(t,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink