mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 01:24:54 +02:00
1 line
17 KiB
JavaScript
1 line
17 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoB+d1NO2EYGmxdlrZYiiXFgKWGQUlni41EsiRlxzD034ejJFt+SVJjW74kFnmvD+85Htfg+NxCeAu/qrjIUToLkwAStLER2gklIYSbFNkFOtaIsPNPlwwljzK0bKUK5hQz6IzABbIEHReZZTxShWOcWY2xmImYJbV2FwJQGg0n65cJhDBH12xCAJobnqNDQ2GtQfIcIYRGYCoSCEBQWJq7FPZjVdFXjN1lwtRsEy8EYPBbIQwmEDpTYADWrTIya0WuM4QA8F5nKkEIZzyzJBCnmHMI1+BW2ks6I+QcApgpk3PXXsF77q2EoH8fRGk8THUEZTkht1YradGSoWG/T/9247VFHKO1syJjG1AggFhJR5GHa+BaZyL2G72vlpTWh9FVaRN6hsw4Ubls0Dg1j98uxN1wFKWf30MZwEzQ4mkWUue0DXu9eqUwWTdWOVlzwp1uzvofVENkQip3sgWdIbfIrJjLTSn65FSWoHkuKKtqPs1CFSHzquUWwC0l6hTKANRS7uTyXfa/KmQRIukTOp54GwvcGL4ixjnM7dMoGXX8bLfeYlSPAXE0LMy5yJ6UjhDf1gtNrelUySfcjF+dDQejN68HJL8UyRzdv8i/2j30t0v68yxTS0zYgmcFWtbxVcldYTBg1vFcd5+iQyNPQd+3HMoij9C0tTcrG+3heFwGsDpR6/WA8DlRafSmDCA9UWl8RifH53ii3qBNDoe5zrjD6XVV0tPmaMvHpDy/LMrkUl6Z3bYQKZUhl22H/qooA4gNcofJuXu80ob94agz6Hf6r28GZ+H4x/DVWbff7/8NAdznvrybu447hDbR6+9CJ8/gpzwQa3XL/d5DcJYBjI9dbdcqR5cKOWdLGhqWRsl5wOo+7MyK8TkXkhH+5of/7s5DY9TRHrhF6LTI2gUjZCYkTpt7fTru96eDDQjjQxA2M5NUjs1UIZPnTfWY/8cTGk9Hm4ReHSZ0KRc8E4mfAW/UHcrnzaft3lXuDytWVEJ+H3aSba9XSVqMCyPcyg+b9x2uRafaD28nNMJRpah6SvXTqUshhF5DgN66NZmWQPbMopldC5O1RiGudVdplNS8Mx5ZuqR6XIvegu6efWnr+FzIeedRrck2/mvCuIJxJ4vtTabFB6SrrAapLVVP1ClyP0iU9D1TXrmG7kqjpCbpgV8MDq60m1RYJqzfbhDxRcBmyrA9bRZxiwlTkrkU/Satj7qDzWvBq3bZF/lFEllZYZFG5EzIOxt+kR12ezWbiVjwjP2FkRUOJy8a5JbL5QFiL73OhXBpETGDWm3F537Rw9rW2ny8hAAcmtxeza7RLETcjLcPuOp54V7NCh57VtQTTLP0dl+JqjQTMUqLrTo+v/j0kS3YqNuHoFUe3xF07+PlL+/+uH5Hdqkcq0MadPvdvp+LlHU5ly1X7ffd/uGut/z+H96CdXk6vHc9nXHhGeuTXddsu4XW8zBsvwQnAaTKOhJZr6moPpusLGn5W4GGOD0JYMGNoPg8JRNh6Xeyeeg9mOmLP+s340v2wKPyaOQN2yRRzQ94EAIEcIervWdsOaHhqKIchVZJnMcxatfSPWioO13p4t0NBMALl+5S/c5Tvf5B1o/GtdsDqgDoL7Wjowo/0XF/wNXPG/Fq50GFOr9GmjCalGX5D6lumKg=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const a={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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Document"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.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)(s,{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)(a.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:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{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:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(a.p,{children:"]"})})})]})]})}),(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)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.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)(s,{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)(a.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:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.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)(s,{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)(a.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:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.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)(s,{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)(a.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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); |