mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-28 04:24:57 +02:00
1 line
11 KiB
JavaScript
1 line
11 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>y,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var i=a(85893),t=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"createdocumentwithtemplateid",title:"Create document by template_id",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create document by template_id",hide_title:!0,hide_table_of_contents:!0,api:"eJy1Vm1v2zYQ/ivcfWoAxbKd7YswFM2yoAtaNEGcYR8cw6Ckk8REIlmS8ksN/ffhKMmR4yTtgA4IHOl4vJfn7h7dDhzPLURz+FMldYXSWVgEkKJNjNBOKAkR3BXILgxyh6zXYuc3V4yXpVpbtlU1c4rlKNGQjsQ1S3trLN4ybdRKpELmzGGlS+5wKdIRBKA03RBKXqUQQeJd9DfXwhW9ukghAM0Nr9ChoXB3IHmFEMHAIgQgKFzNXQHPc1DxAybuKmUqY4mSjicOAjD4tRYGU4icqTEA67YlWbWi0iVCALjRpUoRooyXlhSSAisO0Q7cVntNZ4TMIYBMmYq7oQQ33FuJQP81iYtkWugYmmbRukXr/lDplkxRPCgdPXKtS5F4TMIHS5Hvjn22uRAkhhB0Ai2dzkQuPTp7RW4M3xIsDiv7fQO3iqI9Tu0pkfMkUbWTXDpoArisuCjfxMIrDA08KPzQvY0SVZGVL76Qb3l9UMhiRFK+KZT8jvZkekZ/ZxNomgCccF562FyDrln2sDWvqy+H+jFVzSsfdo8XWK2kbdGcjsf077AN9/PTOWC2ThK0NqvLcvsLBD+rF/p2/6+dWjyI6bdNspreENq1ebu8LxlwTtsoDA+KPABWyFJIXPZILafj8XJKcDYB/Dr+7RixK7nipUg94dypR5Q/ESU0Rpm3u2no3rXuKdRN5ZHpSEi0Sv4cDpIdytskLSa1EW7rSWxzyrU4bc+j+YK4oUJXKKJDrayPmNgsgvCwI8PdoCUbILNm1VOjL9u+EtbxXMj8lGs9UhqlFbkseWypNCHXIlxNgBz3gc0IvBafg/CeWEWLT0i00mU/1OoouECeovFIUU1un/juskd2wFfznnqG/LKnlyPO6Cljzwt7WhjO/qKhWDLlA+/qca1RkldfzdXk6CNxVwjLhPXHPdK+s1imDHt2m8XcYsqUZK5Af0jys9GEWY2JyLqmHLF7eS9nqkJWW8zqkpVCPtroXp6y+XWWiUTwkv2DsRUOF+/6qq3X66Nqnfg7H4Ur6pgZ1OpJPfdCX9Lhrf3LCQTg0FT2OpuhWYmkn9VXXIVeOexGjT6WNC5dQTrRh+eXqPVLkaC0OBiO8483n9nZaAzBoDF/IOTw89XF5ZfZJVml1m5LNBmNR2MS0XhUXA4cdStKXzjaPA63g4NiDz67/9+C002Mw40LdcmFHLBqO9jzZ58aCCAaRr0IoCAiiOaw21HH/W3KpiHx1xoNscgigBU3gsfU4vMdpMLSc7rfWV5N+91t9wE7YS+vRy+G37OAJApY8bKmNwjgEbfP9jE/gx0VUGStxkXr//SO7DxZOOLxJuhvnCcJavem7pA4b65ndxBA3G1Xld/fwPA1LXx8DRHcwz349ZMseKbz8h2UXOY1zz25eLvEYLymQg3p79HTX/dAmb2IySEvtqnQLyX24oXfqec+4fb9Xr09efVCh22vTfVZNE3zLwn+EiE=",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 by template_id",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 by template_id",description:"The Create Document API allows you to generate new documents by providing template_id.",sidebar_label:"Create document by template_id",hide_title:!0,hide_table_of_contents:!0,api:"eJy1Vm1v2zYQ/ivcfWoAxbKd7YswFM2yoAtaNEGcYR8cw6Ckk8REIlmS8ksN/ffhKMmR4yTtgA4IHOl4vJfn7h7dDhzPLURz+FMldYXSWVgEkKJNjNBOKAkR3BXILgxyh6zXYuc3V4yXpVpbtlU1c4rlKNGQjsQ1S3trLN4ybdRKpELmzGGlS+5wKdIRBKA03RBKXqUQQeJd9DfXwhW9ukghAM0Nr9ChoXB3IHmFEMHAIgQgKFzNXQHPc1DxAybuKmUqY4mSjicOAjD4tRYGU4icqTEA67YlWbWi0iVCALjRpUoRooyXlhSSAisO0Q7cVntNZ4TMIYBMmYq7oQQ33FuJQP81iYtkWugYmmbRukXr/lDplkxRPCgdPXKtS5F4TMIHS5Hvjn22uRAkhhB0Ai2dzkQuPTp7RW4M3xIsDiv7fQO3iqI9Tu0pkfMkUbWTXDpoArisuCjfxMIrDA08KPzQvY0SVZGVL76Qb3l9UMhiRFK+KZT8jvZkekZ/ZxNomgCccF562FyDrln2sDWvqy+H+jFVzSsfdo8XWK2kbdGcjsf077AN9/PTOWC2ThK0NqvLcvsLBD+rF/p2/6+dWjyI6bdNspreENq1ebu8LxlwTtsoDA+KPABWyFJIXPZILafj8XJKcDYB/Dr+7RixK7nipUg94dypR5Q/ESU0Rpm3u2no3rXuKdRN5ZHpSEi0Sv4cDpIdytskLSa1EW7rSWxzyrU4bc+j+YK4oUJXKKJDrayPmNgsgvCwI8PdoCUbILNm1VOjL9u+EtbxXMj8lGs9UhqlFbkseWypNCHXIlxNgBz3gc0IvBafg/CeWEWLT0i00mU/1OoouECeovFIUU1un/juskd2wFfznnqG/LKnlyPO6Cljzwt7WhjO/qKhWDLlA+/qca1RkldfzdXk6CNxVwjLhPXHPdK+s1imDHt2m8XcYsqUZK5Af0jys9GEWY2JyLqmHLF7eS9nqkJWW8zqkpVCPtroXp6y+XWWiUTwkv2DsRUOF+/6qq3X66Nqnfg7H4Ur6pgZ1OpJPfdCX9Lhrf3LCQTg0FT2OpuhWYmkn9VXXIVeOexGjT6WNC5dQTrRh+eXqPVLkaC0OBiO8483n9nZaAzBoDF/IOTw89XF5ZfZJVml1m5LNBmNR2MS0XhUXA4cdStKXzjaPA63g4NiDz67/9+C002Mw40LdcmFHLBqO9jzZ58aCCAaRr0IoCAiiOaw21HH/W3KpiHx1xoNscgigBU3gsfU4vMdpMLSc7rfWV5N+91t9wE7YS+vRy+G37OAJApY8bKmNwjgEbfP9jE/gx0VUGStxkXr//SO7DxZOOLxJuhvnCcJavem7pA4b65ndxBA3G1Xld/fwPA1LXx8DRHcwz349ZMseKbz8h2UXOY1zz25eLvEYLymQg3p79HTX/dAmb2IySEvtqnQLyX24oXfqec+4fb9Xr09efVCh22vTfVZNE3zLwn+EiE=",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 with binary file type",permalink:"/docs/API-docs/createdocumentwithbinary"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},y={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,t.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 by template_id"})}),"\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)(c.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,i.jsx)(d.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.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.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)(o.Z,{collapsible:!1,name:"Role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(o.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:"]"})})})]})]})})})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\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)(d.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)(o.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); |