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
56ab0161ab152a6d14e8b1e84a54bf64e9cd761e
OpenSign/assets/js/28b19cd2.9bcc0265.js
T

1 line
13 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var l=a(85893),i=a(11151),r=a(58219),n=(a(62316),a(51039)),t=a.n(n),c=(a(82723),a(9487)),o=a(41429),m=a(5397),d=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V1tv2zYU/ivseVkDKL6lfRGGoVkXdEGLJWgy7MExDFo6kphQJEtSdjxD/304lGTLjpOsQDfAsCXy4+G5fOfiDXieO4in8JtOqhKVdzCLIEWXWGG80ApiuC2QfbTIPbIOxc6vLxmXUq8cW+uKec1yVGgJo3DF0k4aW6yZsXopUqFy5rE0knuci3QAEWhDJ4RWlynEkIQrupMr4YsOLlKIwHDLS/RoSd0NKF4ixNCTCBEIUtdwX8ChDXpxj4m/TJnOWKKV54mHCCx+q4TFFGJvK4zA+bUkqU6URiJEgI9G6hQhzrh0BEgKLDnEG/BrE5DeCpVDBJm2Jff9FXzkQUoM5vfxokgmhVlAXc+aa9H5X3W6JlGkDypPj9wYKZLgk+G9I803T+9sbCGXWPKgF+gCTuQqeGcL5NbyNbnFY+leF2A1afvUtJ0h50miK6+48lBHgCUX8kVfBEBfwL3GD+3bINElSWkC+dKt9xrZApHAptDqFfR4ckafszHUdQRe+LC6T64ea+Y3rdvq5+HzPn5BUQvgffaEBWe0co03J6MR/ezT8FIxVyUJOsc6cMiflZCS5ehZZSUTarcpsrDPLTIunWZNkAnSKce0L9CuhEOmlVwHKR3bI1aic47nxOUfRLNO9vcmQXEvJn8/JsvJNQWysi8z55gA742Lh8MD/pCFZOB3SttWMhe+mqBklZTrN3vEEUoKhfMuIPPJaDSfUPzrCN4dDXETsYIvUf3kGU9TthJpjt4xrtI2gI4i2LGKacuU9m2dxC2ES61yRoWQ+QKFZZSg4WTg4A+LKFqr7ff671oid8gc+srsLGkEv+bDd6PRfLz14ftjabLkUqShy9zqB1Rv/gdrd7b1r/fN9aTqYxk423Ye0YDCPuwZ219vjHSYVFb4dehcj6fciNNmP57OqCGU6AtNPdBoFzSmFhbDcL8MDTe9OlQDibXLrh+GhNrmiPM8Fyo/5cYMtEFFlJJ84ShphtyI4XIMdHGn2A05r/HPnnq7VmLEZyTOtdb3UW3fLZCnaIOnKCZfd03uovNsr0lNu37TbyrbnvKkUWwv7prBthf0C/6sJl0yHRRv43FlUFGND9Fcjp9MBreFcEy4sN15OjCLZdqyg9NswR2mTCvKyLBJ62eDMXMGE5G1pBywO3WnbnSJrHKYVZJJoR5cfKdO2fQqy0QiuGR/4cIJj7O3XdRWq9WTaJ2EM5+EL6oFs2j0Dp6HxRDS/qntywlE4NGW7iq7QbsUSVdFn7lqGMDDNtVoQqJ0aQPSLn04PETUlyJB5bCXHOefrr+ws8EIoh4x/4XKwy+XHy/+uLkgqUTtJkTjwWgwCu1fO19y1bvocC7NrC7ZbZsmh7HujVr/3VDbJozHRz80kgvVa3dNXk8PxguIIO7PsbMICqoD8RQ2GyLcn1bWNS1/q9BSEZlFsORW8AUxfLqBVDh6Trdz6rNmv/3aDi0n7PhIfFT9rggoqgBLLit6gwgecH0wg4cUbCsBadYgPjb3n96SnJ2EJ2W8jroT50mCxr+I7dfN66ubW4hg0U7UZZjZwfIVDfl8BTHcwR2EvxwkoRl3aX0Dkqu8CgMENHKpgPGKAtWvfg+h+rUPZNlRn+yXxcYU+ibDjh74mTj3Gde/bOHNzrMHWt92aIrPrK7rfwANGsS0",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",source:"@site/docs/API-docs/createdocumentwithtemplateid.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithtemplateid",permalink:"/docs/API-docs/createdocumentwithtemplateid",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithtemplateid",title:"Create Document from Template",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create Document from Template",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V1tv2zYU/ivseVkDKL6lfRGGoVkXdEGLJWgy7MExDFo6kphQJEtSdjxD/304lGTLjpOsQDfAsCXy4+G5fOfiDXieO4in8JtOqhKVdzCLIEWXWGG80ApiuC2QfbTIPbIOxc6vLxmXUq8cW+uKec1yVGgJo3DF0k4aW6yZsXopUqFy5rE0knuci3QAEWhDJ4RWlynEkIQrupMr4YsOLlKIwHDLS/RoSd0NKF4ixNCTCBEIUtdwX8ChDXpxj4m/TJnOWKKV54mHCCx+q4TFFGJvK4zA+bUkqU6URiJEgI9G6hQhzrh0BEgKLDnEG/BrE5DeCpVDBJm2Jff9FXzkQUoM5vfxokgmhVlAXc+aa9H5X3W6JlGkDypPj9wYKZLgk+G9I803T+9sbCGXWPKgF+gCTuQqeGcL5NbyNbnFY+leF2A1afvUtJ0h50miK6+48lBHgCUX8kVfBEBfwL3GD+3bINElSWkC+dKt9xrZApHAptDqFfR4ckafszHUdQRe+LC6T64ea+Y3rdvq5+HzPn5BUQvgffaEBWe0co03J6MR/ezT8FIxVyUJOsc6cMiflZCS5ehZZSUTarcpsrDPLTIunWZNkAnSKce0L9CuhEOmlVwHKR3bI1aic47nxOUfRLNO9vcmQXEvJn8/JsvJNQWysi8z55gA742Lh8MD/pCFZOB3SttWMhe+mqBklZTrN3vEEUoKhfMuIPPJaDSfUPzrCN4dDXETsYIvUf3kGU9TthJpjt4xrtI2gI4i2LGKacuU9m2dxC2ES61yRoWQ+QKFZZSg4WTg4A+LKFqr7ff671oid8gc+srsLGkEv+bDd6PRfLz14ftjabLkUqShy9zqB1Rv/gdrd7b1r/fN9aTqYxk423Ye0YDCPuwZ219vjHSYVFb4dehcj6fciNNmP57OqCGU6AtNPdBoFzSmFhbDcL8MDTe9OlQDibXLrh+GhNrmiPM8Fyo/5cYMtEFFlJJ84ShphtyI4XIMdHGn2A05r/HPnnq7VmLEZyTOtdb3UW3fLZCnaIOnKCZfd03uovNsr0lNu37TbyrbnvKkUWwv7prBthf0C/6sJl0yHRRv43FlUFGND9Fcjp9MBreFcEy4sN15OjCLZdqyg9NswR2mTCvKyLBJ62eDMXMGE5G1pBywO3WnbnSJrHKYVZJJoR5cfKdO2fQqy0QiuGR/4cIJj7O3XdRWq9WTaJ2EM5+EL6oFs2j0Dp6HxRDS/qntywlE4NGW7iq7QbsUSVdFn7lqGMDDNtVoQqJ0aQPSLn04PETUlyJB5bCXHOefrr+ws8EIoh4x/4XKwy+XHy/+uLkgqUTtJkTjwWgwCu1fO19y1bvocC7NrC7ZbZsmh7HujVr/3VDbJozHRz80kgvVa3dNXk8PxguIIO7PsbMICqoD8RQ2GyLcn1bWNS1/q9BSEZlFsORW8AUxfLqBVDh6Trdz6rNmv/3aDi0n7PhIfFT9rggoqgBLLit6gwgecH0wg4cUbCsBadYgPjb3n96SnJ2EJ2W8jroT50mCxr+I7dfN66ubW4hg0U7UZZjZwfIVDfl8BTHcwR2EvxwkoRl3aX0Dkqu8CgMENHKpgPGKAtWvfg+h+rUPZNlRn+yXxcYU+ibDjh74mTj3Gde/bOHNzrMHWt92aIrPrK7rfwANGsS0",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from binary",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get Document from ID",permalink:"/docs/API-docs/getdocument"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{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)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(r.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"In success response you will get url in response if you are also signer in document otherwise only get objectId, messsage"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"If you haven't add widgets and signers in template or not provide signers along with their roles in body"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.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 b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink