Files
OpenSign/assets/js/e2a6fad1.af09ba9d.js
T

1 line
9.7 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6741],{57755:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>h,default:()=>b,frontMatter:()=>p,metadata:()=>x,toc:()=>j});var t=s(85893),i=s(11151),l=s(58219),r=(s(62316),s(51039)),n=s.n(r),o=(s(82723),s(9487)),d=(s(41429),s(5397)),c=s(4667),m=s(9472),u=s(85162);const p={id:"createdocumentwithbinary",title:"Create Document from binary",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 from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGCoG4SBEaC2oBc9CALzoockmOTu5vdpR4V+N+LWZIyZctGCvTWi0TN85tvHtQevCwcJAv4qNOmRuUdLCPI0KWWjCetIIGbEsUHi9KjGKzExfWlkFWlN040Dq0TXosCFVq2UrgR2RBPrHbCWL2mjFQhMuml8KXVTVGKb3VTeTLS+jjXtp6w8ttU3JTkRF7hllYVihp9qbMhWa6t8CUKUmnVONJK6FyspSXduD74zqCLRC0fOB954RrykiOxrxQbylBYqQpk1wGmSLlAjudSVBzPTSECbbgi0uoygwSCDQ4uG/LlipS0O4jA4vcGnf9dZztI9pBq5VF5fjxRI4tdWmIdnhgwJKBX95h6iMBYzuoJHWtzqnBk5bwlVUAEHEx6SKCH0EbgyZ+ybZ/084ReaX/a0VGh0LpXAUhr5Q7aRwAv8nS3YnpaNmW+yGIGibcNBoEzWrmu6PPZjL+Ox/DjUaswE65JU3Qub6pq9xNEY9KlMRWloXPxveuq/lHGOzE3/JWiDxLcytqEqst7Ov97m67Pr5m5xlb/OoD3xiVx3Nhq4vUEM/KTgcRpqusjjklVpPBuoO3ufDa7O2Nu2wh+mf36nL5LtZYVZWFzb/QDqv+QMrRW21PlPhY3Tu+79Ax1WwealKy7ooJR0MNRsWN5V6TDtLHkd5As9rCdSEOTTp8slu0ygu5uQAJGu4BY+hISiF9ZYod2HaZ9se/6d2iJ87IgVUykMVNtUPFeVHLluC2xNBSvz4CTDqDmTFzHzRG0A0PS0BfknH3lY6sIiBtWoszQBpZI5To493xcGVRzKlRgc30Gzy82OUEuqIdKu+vGN/CJt1hJh5nQKhxWVrL87fRMOIMp5f1QTMWtulVzXSNf/LypREXqwSW3aiIWV3lOKclK/IUrRx6XPw/MbTabZ4y9CT6fyZfNSlg0+tG8CMJA69jr8OMNRODR1u4qn6NdUzoszgup4mAc96Mu0zDqWEvi7vai35468ehVlKJyOBrOi8/XX8Xb6Qyi0XD8AOT46+WHT3/MP3FUHq+uRWfT2XTGIh7PWqpRoqfv2tzqWhyG9MktP2zw//k13S+Vx62PTSVJjS5wt/eLl1/eywhKPhHJAvZ73oU/bdW2LP7eoOX7soyAsTO6cF2iYTf5UDzgjnvWtWFyw0jYvGoY0amXfxsNThdpisaPzJ/d4KNDdn01v4EIVv1/jFpn7MOBQ9zo8bEDKRuufHxyHsLJ6R8Y/KBSuxGK41vUQeVPBn7S4R2P2RfcvT+Yd5oXHXr6Bmvu17Jt238Aq7ew7g==",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/createdocumentwithbinary",title:"Create Document from binary",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/createdocumentwithbinary.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocumentwithbinary",permalink:"/docs/API-docs/createdocumentwithbinary",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocumentwithbinary",title:"Create Document from binary",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 from binary",hide_title:!0,hide_table_of_contents:!0,api:"eJzlVktv20YQ/ivbOTUAJcpOeyGCoG4SBEaC2oBc9CALzoockmOTu5vdpR4V+N+LWZIyZctGCvTWi0TN85tvHtQevCwcJAv4qNOmRuUdLCPI0KWWjCetIIGbEsUHi9KjGKzExfWlkFWlN040Dq0TXosCFVq2UrgR2RBPrHbCWL2mjFQhMuml8KXVTVGKb3VTeTLS+jjXtp6w8ttU3JTkRF7hllYVihp9qbMhWa6t8CUKUmnVONJK6FyspSXduD74zqCLRC0fOB954RrykiOxrxQbylBYqQpk1wGmSLlAjudSVBzPTSECbbgi0uoygwSCDQ4uG/LlipS0O4jA4vcGnf9dZztI9pBq5VF5fjxRI4tdWmIdnhgwJKBX95h6iMBYzuoJHWtzqnBk5bwlVUAEHEx6SKCH0EbgyZ+ybZ/084ReaX/a0VGh0LpXAUhr5Q7aRwAv8nS3YnpaNmW+yGIGibcNBoEzWrmu6PPZjL+Ox/DjUaswE65JU3Qub6pq9xNEY9KlMRWloXPxveuq/lHGOzE3/JWiDxLcytqEqst7Ov97m67Pr5m5xlb/OoD3xiVx3Nhq4vUEM/KTgcRpqusjjklVpPBuoO3ufDa7O2Nu2wh+mf36nL5LtZYVZWFzb/QDqv+QMrRW21PlPhY3Tu+79Ax1WwealKy7ooJR0MNRsWN5V6TDtLHkd5As9rCdSEOTTp8slu0ygu5uQAJGu4BY+hISiF9ZYod2HaZ9se/6d2iJ87IgVUykMVNtUPFeVHLluC2xNBSvz4CTDqDmTFzHzRG0A0PS0BfknH3lY6sIiBtWoszQBpZI5To493xcGVRzKlRgc30Gzy82OUEuqIdKu+vGN/CJt1hJh5nQKhxWVrL87fRMOIMp5f1QTMWtulVzXSNf/LypREXqwSW3aiIWV3lOKclK/IUrRx6XPw/MbTabZ4y9CT6fyZfNSlg0+tG8CMJA69jr8OMNRODR1u4qn6NdUzoszgup4mAc96Mu0zDqWEvi7vai35468ehVlKJyOBrOi8/XX8Xb6Qyi0XD8AOT46+WHT3/MP3FUHq+uRWfT2XTGIh7PWqpRoqfv2tzqWhyG9MktP2zw//k13S+Vx62PTSVJjS5wt/eLl1/eywhKPhHJAvZ73oU/bdW2LP7eoOX7soyAsTO6cF2iYTf5UDzgjnvWtWFyw0jYvGoY0amXfxsNThdpisaPzJ/d4KNDdn01v4EIVv1/jFpn7MOBQ9zo8bEDKRuufHxyHsLJ6R8Y/KBSuxGK41vUQeVPBn7S4R2P2RfcvT+Yd5oXHXr6Bmvu17Jt238Aq7ew7g==",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",permalink:"/docs/API-docs/createdocument"},next:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"}},f={},j=[{value:"Request",id:"request",level:2}];function y(e){const a={code:"code",h2:"h2",p:"p",...(0,i.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:"Create Document from binary"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createdocumentwithbinary"}),"\n",(0,t.jsxs)(a.p,{children:["The Create Document API allows users to generate new documents by providing data through ",(0,t.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,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"multipart/form-data",value:"multipart/form-data-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)(c.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"array",qualifierMessage:void 0,schema:{type:"string",format:"array"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document.com"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);