WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 21:27:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
8bd76bc3db39e4bbc28c4c6c406dbba12e3e9303
OpenSign/assets/js/28b19cd2.fcbda936.js
T

1 line
14 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:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),o=a(41429),c=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:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={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:"eJy9V21v2zYQ/ivsfVkLKH5Jty/CMDTLii5osQRNhn1wDIOWThITimRJyo5n6L8PR0k27by0BbYBgWMf7453z71yC56XDtIZ/KazpkblHcwTyNFlVhgvtIIUbipk5xa5RzZwsbOrC8al1GvHNrphXrMSFVriUbhm+aCNLTfMWL0SuVAl81gbyT0uRD6CBLQhCaHVRQ4pZOGKQXItfDWwixwSMNzyGj1aMncLitcIKUQaIQFB5hruKzj2QS/vMPMXOdMFu+llIAGLXxphMYfU2wYTcH4jSa0TtZHEgA9G6hwhLbh0xJBVWHNIt+A3JnB6K1QJCRTa1tzHFHzgQUsK5vfpsspOK7OEtp1316Lzv+p8Q6oyrTwqT1+5MVJkAZTxnSPTt9Gde3Nn4ESpCIx5MpjS+UhQWULWC3RBvGfc28yt5RuCy2Md059RYDU58djjvX9nWaYbr7jy0CaANRfyRYgCQ6zgTuO7/tco0zVp6QL80q13GtkSkZhNpdVXuKenb+nv7RTaNgEvfKAeJl2UTYvrHjbiLrTM0VKWHt/QJuBQ5Ytjn5daS+QqtoAybEBn4ZoO6ydMPkzc88Z5XTMSYr0QK7RlFFXuG4usT6Yd8otln1bfpPiRHhaUMFIyYudcMaEy2eTIfIWs0FTzVMpsux1QWwQw25Ztt4QF2gXFrm2TPYFUHhBCwDqKxQzF6kBqR8K94I4WieKDEXazyLnvCZmuDVeb2ABRKqHKRWNl245eiP0iDn6AsCXmww4RCM5o5brSOJ1M6N8hsheKuSbL0Dk2MIcmuRZSshI9a6xkQu0PRRHOuUXGpdOsq1hiGYxj2ldo18Ih00pugpahpSWsRuccL6lffXMrebnkB93f2+iqO3H690O2Or2idGzsy23gKQXeG5eOx0fNgDwkB79T225cufDRBaVopNy8OsgEoaRQuBgCsjidTBanFP82gR+fDHEXsYqvUP3gGc9zthZ5id4xrvI+gI4iOGQV05Yp7fthiDsWLrUqGU07KjBhGXXbIBly8F+LKFqr7ffidyWRO2QOfWP2nnSKv4bhj5PJYrrD8KenymTFpcjDKnGj71G9+h+83fsWX++768nUhzrkbL9eiI4pnMOBszG9c9Jh1ljhN2E9eTjhRpx05+lsTkO/Rl9pWnSMdsFi2lNSGB+2ofE26kMtkFq7GpaeUFC7GnGel0KVJ9yYkTaoKKUkXzoqmjE3YryaAl08GHZN4HX4HJi33wuM+IiUc733MVe/XFXIc7QBKYrJ5/0i835ANto4ZsPyEG8IuwXh0dTfXTxM9t1gj6f3PJ7H+8jGY7hb5o4mbZQE0ZiMBrlQhQ5o9EG+NKhoCwgpspo+mqA3lXBMuHA8hC+kaxjQR9JsyR3mTKswR+mQ6G9HU+YMZqLoM33EbtWtutY1ssZh0Ugmhbp36a06YbPLohCZ4JL9hUsnPM5fD6mwXq8fpcCbIPNB+KpZMotG79nLQAx5EkvtfryBBDza2l0W12hXIhta8zNXjQPzuK9f3u01Q5R70rtjIYJcigyVw6jizj5cfWJvRxNIomz/BpPHny7O3/9x/Z60Ur10IZqOJqNJWBC18zVX0UXHL5rC6jp+GhzEOtrR/7vnUF+FHh/82EguVDRDu2YxO9pZIIE0fgHNE6iouaQz2G4p4f6krYfIXxq01JnmCay4FXxJGT7bQi4cfc93D5xn3X79ud+E3rBnHlNP2j+0FkV9ZcVlQ78ggXvcHD3f2nmbDP2FTOs4zjsDTm5Iz17Do+HQJoPEWZah8S/yxt346vL6BhIYluY6vPbA8jU9D/kaUriFWwivVdLQvYiIvgXJVdmEtQQ6vdQWeUORinvqfeip/Rfy7ElMDptt5wp9kmNPCvxMSfcRN7/s2LuTZwV6bAduis+8bdt/AIJYl7Q=",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",permalink:"/docs/API-docs/getdocument"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Create Document from Template"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/createdocument/{template_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Create Document API allows you to generate new documents by providing template_id."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"objectId of Template",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}."}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.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,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink