WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-07 10:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fda95286f00a9425ce8ecacff55c4be1156769a8
OpenSign/assets/js/2c586be5.4d88da29.js
T

1 line
9.5 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>h,default:()=>v,frontMatter:()=>u,metadata:()=>x,toc:()=>j});var i=s(85893),t=s(11151),r=s(58219),l=(s(62316),s(51039)),n=s.n(l),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=s(9472),p=s(85162);const u={id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGKom4cBEaC2IBU9CALzoockmOTu5vdpR4V+N+LWZIyZStFCvTWi0TNe76Z+agDeFk4SJZwrdOmRuUdrCLI0KWWjCetIIFFieKdRelRDFbi6u5GyKrSWycah9YJr0WBCi1bKdyKbIgn1nthrN5QRqoQmfRS+NLqpijFl7qpPBlpfZxrW09Y+WUqFiU5kVe4o3WFokZf6mxIlmsrfImCVFo1jrQSOhcbaUk3rg++N+giUcsnzkdeuIa85EjsK8WWMhRWqgLZdShTpNwgx3MpKo7nphCBNtwRaXWTQQLBBgcXiMDi1wad/11ne0gOkGrlWZEc4ExnLHZpiXV44jIhAb1+xJRDGcu5PKFjbU4Vjqyct6QKiICDSQ8JrElJu4c2ggX5c7ZtBNfjKZ7Rf9b+vOOcCoXWjXTSWrmHCMhj7c74tG0EvivkBUoPawYnGDBaZDGDxNsGg8AZrVzX8uVsxl+nq3d9Mh7MhGvSFJ3Lm6ra/wDRGHJpTEVpmFb86LqevxfvTsxD/gfMjxLcydqEXstHuvxrl24u7xi3xlb/OoD3xiVx3Eumqa5hDCapihQ+DEg9XM5mDxcMZxvBT7OfXyN2ozayoiwc6EI/ofoPUUJrtT3X4XM/4/S+S8+l7uqAjJJ111QwCno4aXYs75p0mDaW/B6S5QF2E2lo0umT5apdRdDRAyRgtAsVS19CAvGrW3VoN2Gpl4duUEfsnZcFqWIijZlqg8pRoSq5djyMWBqKNxfAqYZS5gxXh8hJQc/XYugj8rn0/Y6tIiAeU4kyQxuwIZXr4NyjcGtQ8QUGDDcX8JqOyQlyQT3011EXE9wLb7GWDjOhVWBNVrL87fRCOIMp5f0qTMW9uldzXSPTed5UoiL15JJ7NRHL2zynlGQl/sS1I4+rHwfkttvtK8TeBJ8P5MtmLSwa/WxeBGGAdex1/PEGIvBoa3ebz9FuKB0u5Bup4mAc9wsu07DgWEvi6fai31468cJVlKJyOFrJqw93n8Tb6Qyi0XJ8R8nxp5t37z/P33NUXq9uRBfT2XTGIl7KWqpRov5FOlrM7JSmj7f6f37v9ofkcedjU0lSI3rtLnz58m28iqBkCkiWcDjw1v9hq7Zl8dcGLfPHKgKumGsK7BENV8iU8IR7nk4H/mTB+dm8ariOc2/zNhqcrtIUjR+Zv+LYE6K6u50vIIJ1/6eh1hn7cOAQN3p+7IqUDfc7JpenQC79Axc/qNR+VMUp63Sl8icXftbhF16uj7j/9Wjeab7p0MM3WPOUVm3b/g2P0JkM",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGKom4cBEaC2IBU9CALzoockmOTu5vdpR4V+N+LWZIyZStFCvTWi0TNe76Z+agDeFk4SJZwrdOmRuUdrCLI0KWWjCetIIFFieKdRelRDFbi6u5GyKrSWycah9YJr0WBCi1bKdyKbIgn1nthrN5QRqoQmfRS+NLqpijFl7qpPBlpfZxrW09Y+WUqFiU5kVe4o3WFokZf6mxIlmsrfImCVFo1jrQSOhcbaUk3rg++N+giUcsnzkdeuIa85EjsK8WWMhRWqgLZdShTpNwgx3MpKo7nphCBNtwRaXWTQQLBBgcXiMDi1wad/11ne0gOkGrlWZEc4ExnLHZpiXV44jIhAb1+xJRDGcu5PKFjbU4Vjqyct6QKiICDSQ8JrElJu4c2ggX5c7ZtBNfjKZ7Rf9b+vOOcCoXWjXTSWrmHCMhj7c74tG0EvivkBUoPawYnGDBaZDGDxNsGg8AZrVzX8uVsxl+nq3d9Mh7MhGvSFJ3Lm6ra/wDRGHJpTEVpmFb86LqevxfvTsxD/gfMjxLcydqEXstHuvxrl24u7xi3xlb/OoD3xiVx3Eumqa5hDCapihQ+DEg9XM5mDxcMZxvBT7OfXyN2ozayoiwc6EI/ofoPUUJrtT3X4XM/4/S+S8+l7uqAjJJ111QwCno4aXYs75p0mDaW/B6S5QF2E2lo0umT5apdRdDRAyRgtAsVS19CAvGrW3VoN2Gpl4duUEfsnZcFqWIijZlqg8pRoSq5djyMWBqKNxfAqYZS5gxXh8hJQc/XYugj8rn0/Y6tIiAeU4kyQxuwIZXr4NyjcGtQ8QUGDDcX8JqOyQlyQT3011EXE9wLb7GWDjOhVWBNVrL87fRCOIMp5f0qTMW9uldzXSPTed5UoiL15JJ7NRHL2zynlGQl/sS1I4+rHwfkttvtK8TeBJ8P5MtmLSwa/WxeBGGAdex1/PEGIvBoa3ebz9FuKB0u5Bup4mAc9wsu07DgWEvi6fai31468cJVlKJyOFrJqw93n8Tb6Qyi0XJ8R8nxp5t37z/P33NUXq9uRBfT2XTGIl7KWqpRov5FOlrM7JSmj7f6f37v9ofkcedjU0lSI3rtLnz58m28iqBkCkiWcDjw1v9hq7Zl8dcGLfPHKgKumGsK7BENV8iU8IR7nk4H/mTB+dm8ariOc2/zNhqcrtIUjR+Zv+LYE6K6u50vIIJ1/6eh1hn7cOAQN3p+7IqUDfc7JpenQC79Axc/qNR+VMUp63Sl8icXftbhF16uj7j/9Wjeab7p0MM3WPOUVm3b/g2P0JkM",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const a={code:"code",h2:"h2",p:"p",...(0,t.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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Create document"})}),"\n",(0,i.jsx)(n(),{method:"post",path:"/createdocument"}),"\n",(0,i.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,i.jsx)(a.code,{children:"multipart/form-data"}),". This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios."]}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,i.jsxs)(s,{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)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.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:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(r.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{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)(a.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)(p.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}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{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)(a.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)(p.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 v(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink