WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 18:14:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c4fb901174b535b11a91c20fca670b375880ece9
OpenSign/assets/js/0028a090.da7ff0bb.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7917],{58760:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>j});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),d=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),c=s(9472),p=s(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/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWhBU5JDde7q73IVkV+N+LWYoSJTtuGwQ99GJT855vZr/dHXheOkjnMMPaSO7RwSKBHF1mhfFCK0hhViH7xfLCs86IXd5eMy6l3ji21YF5zTKLpMiC87oWf/KVRJZHJ99FZiOKRK4WfbDKMc6CEg8B2WDQWS1FPhgwX3HPMq7YCllwmFOGEhVaypHrLNSovGMrTjqtmK+QOYOZKAQZd2VylbPBIFhJITXDXBzLGUEC2lBEodV1DinEcjs1JGDxIaDzP+t8C+kOMq08Kk+f3Bgpsug5/uQIpB24rMKa05ffGoQU9OoTZh4SMJbyeIGOtIWQ2LNy3gpVQgKFtjX3kAI19f1bSAAfeW3IeC9iqDKdY85iiCYBL/zfxDpIjrFc/DjAQHGU9l8aJro2ZxvzRZH6EZpjc6dTWa5oGA3paTrCYg6ptwGjwBmtXIvy68mE/p0tcrcX7bLmzIUsQ+eKIOX2G0i+1ohbMe3UwVKFeoWWkApWPofQEY/Ke+PS8ThYOfR6SEs7PCxtpusTdISSQuGy6335ejJZ5p4QahJ4+xwIU12jr4Qq2QaVZxurVZkwI5E7ZN5uGS+5UIyy2a+ICVqr7cuN/7vKXkLh7WSyvDiA8N1TEK7VmkuRRzKa6XtU/22n/fS+TU+lPtZxNRSv26aiUdTDSbN9edukwyxY4beQznfwOORGDFt9Ol80iwQIWE0cZ7SLFXNfQQrjc8pzaNdoXQwTF/WwjdyYkTaonCiV5CtHmzjmRozXF9Ak59bO81Kocvii1+JY95SwbeE7qf4AIjfiA24h6cDpWyUgaKYV8pyOWJMAjey3I3tfdcB37PssoR4RPqfIjiFPSO/8lnyOxqiyQsc29qFvDKqpKFUc/friSZRZJRwTLqq7ey6uISu0ZWfep/cfKUn+ZnTR3YXtBo/YnbpTdLroLi2CZFKoe5feqSGb3xSFyASX7A9cOeFx8W03w81m82R2r6LPe+GrsGIWjT6al1EYB9z3Ovx4RQCjrd1NMUW7FlnHdZ9JNY7G4/255Fk8l1hzQXu2F/107kSQS5Ghctg7SZfvbz+yNXszmkDSW9R/UPT44/W7q1+nVxSXDkY7pIvRZDQhEZ2mmqteqtN30vl4e4+I//Gran9kPT76sZFcqN611xLP/OyttUigImJK57DbUfrfrWwaEj8EtMRqiwTW3AoCIHJa0h13Yqp73EIK71pohzNKT+YytMxxRuXEVq3HZZah8S/a9rnz9mY6gwRW+/dgrXPysXxDb0W+gRTu4A7is5IiRDaL8h1IrsrAS7Jv4xJL8UBY9CnuPlLc/oM661Rq26vylPvaVugvNfasww+0HR9w++PBvNV81mGPbWdNE1w0TfMX23M3Iw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={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/ivbOTUC9XCS9kAURd3UCIwEtVGp6EEWhBU5JDde7q73IVkV+N+LWYoSJTtuGwQ99GJT855vZr/dHXheOkjnMMPaSO7RwSKBHF1mhfFCK0hhViH7xfLCs86IXd5eMy6l3ji21YF5zTKLpMiC87oWf/KVRJZHJ99FZiOKRK4WfbDKMc6CEg8B2WDQWS1FPhgwX3HPMq7YCllwmFOGEhVaypHrLNSovGMrTjqtmK+QOYOZKAQZd2VylbPBIFhJITXDXBzLGUEC2lBEodV1DinEcjs1JGDxIaDzP+t8C+kOMq08Kk+f3Bgpsug5/uQIpB24rMKa05ffGoQU9OoTZh4SMJbyeIGOtIWQ2LNy3gpVQgKFtjX3kAI19f1bSAAfeW3IeC9iqDKdY85iiCYBL/zfxDpIjrFc/DjAQHGU9l8aJro2ZxvzRZH6EZpjc6dTWa5oGA3paTrCYg6ptwGjwBmtXIvy68mE/p0tcrcX7bLmzIUsQ+eKIOX2G0i+1ohbMe3UwVKFeoWWkApWPofQEY/Ke+PS8ThYOfR6SEs7PCxtpusTdISSQuGy6335ejJZ5p4QahJ4+xwIU12jr4Qq2QaVZxurVZkwI5E7ZN5uGS+5UIyy2a+ICVqr7cuN/7vKXkLh7WSyvDiA8N1TEK7VmkuRRzKa6XtU/22n/fS+TU+lPtZxNRSv26aiUdTDSbN9edukwyxY4beQznfwOORGDFt9Ol80iwQIWE0cZ7SLFXNfQQrjc8pzaNdoXQwTF/WwjdyYkTaonCiV5CtHmzjmRozXF9Ak59bO81Kocvii1+JY95SwbeE7qf4AIjfiA24h6cDpWyUgaKYV8pyOWJMAjey3I3tfdcB37PssoR4RPqfIjiFPSO/8lnyOxqiyQsc29qFvDKqpKFUc/friSZRZJRwTLqq7ey6uISu0ZWfep/cfKUn+ZnTR3YXtBo/YnbpTdLroLi2CZFKoe5feqSGb3xSFyASX7A9cOeFx8W03w81m82R2r6LPe+GrsGIWjT6al1EYB9z3Ovx4RQCjrd1NMUW7FlnHdZ9JNY7G4/255Fk8l1hzQXu2F/107kSQS5Ghctg7SZfvbz+yNXszmkDSW9R/UPT44/W7q1+nVxSXDkY7pIvRZDQhEZ2mmqteqtN30vl4e4+I//Gran9kPT76sZFcqN611xLP/OyttUigImJK57DbUfrfrWwaEj8EtMRqiwTW3AoCIHJa0h13Yqp73EIK71pohzNKT+YytMxxRuXEVq3HZZah8S/a9rnz9mY6gwRW+/dgrXPysXxDb0W+gRTu4A7is5IiRDaL8h1IrsrAS7Jv4xJL8UBY9CnuPlLc/oM661Rq26vylPvaVugvNfasww+0HR9w++PBvNV81mGPbWdNE1w0TfMX23M3Iw==",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"}},x={},j=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",strong:"strong",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Draft Template"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/drafttemplate"}),"\n",(0,t.jsxs)(a.p,{children:["The Draft Template API allows you to create customizable draft templates .The API returns a unique ",(0,t.jsx)(a.strong,{children:"template_id"})," that can be used to generate documents based on the specified template and ",(0,t.jsx)(a.strong,{children:"url"})," to edit template."]}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{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)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded file"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample note"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.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,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://url-to-edit-template.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.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:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink