WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-11 20:27:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
268dbc16931f2c8a97aaae67e9723382f1caadaf
OpenSign/assets/js/f0ff4a36.b92fe796.js
T

1 line
10 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>x,contentTitle:()=>y,default:()=>j,frontMatter:()=>f,metadata:()=>i,toc:()=>b});const i=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9GNtuGzf2V1i+bBOMJdlWklZPNbpZ17tBE9QOAqwjCJyZoxnGHJIlz+gCYYA+9A/6B/tp/ZLF4Vw0shQ7StO82BrynMNzv204iszzyS3/p0nKAjR6Po14Cj5x0qI0mk/4TQ7sEpC1IOzizRUDLWIFnq1NydAwB+gkLIClgEIqz0RsSmSCeQuJnMuEpQ32gEfcWHCCqF+lfMIzwPaSR9wKJwpAcMTWhmtRAJ/wFmAmUx5xSWxZgTm/z6uJP0CCVykz845fHnEHv5bSQcon6EqIuMe1IrJeFlYBjzisrDIp8MlcKE8ASQ6F4JMNx7UNkOikznjE58YVAvsnsBKByoTbn07jPDnLbcyrakrPemu0B0+EzkYj+rfLry+TBLyfl4p1SuERT4xG4nyy4cJaJZNwMfzgCWmzz10tNmnPERmU9ZMeBZb+WCmkPrHOZA6851XUqfRYMv+6lHdn53H+9t9EZS7p8DgKOaL1k+GwOSmdGiSmIGoJyTgntXw20R6JHmGUeDyfPvwgDycS2hzPlFUgPDAvM90FStCaUSm4xw39ZWxUx9pxFGoOWUCttgrcBmwjAjnSUu/I8kn0PxhgMQDhk3ZCWugoCOfEmvIBQuEf15Izh227fS0B85AiDrIFhZDqUegY4IfmoPU1mxv9yDPjZ8/PTs+/e3FK8EuZZoB/Qf769jj9I6wwNqvAr8j66LosYnB99O6kQz+tIr46EudsPK4ivj4S6wU9tTwS6fy7KuL5kUjj5+TLIYF/gs4/J6Y6nVf9iEIorBIIs+s6DmatPzwIFYLSg06v9Gu3m0tiYxQI3X+aqiOlVwcCIb3Ah73zbHR2fnI6Ohm9uDl9Phl/P3n2fDAajf7LI74q1FZ6nlKe7ieH5ru06Vd5p25Wbkz5aeI7SKWDBGelOxjYD9mOnhNKmeWsMGldX+45yoF3Q9NBiGUqcYZuN6EcGeWfnY8WEpZwsIR8QVOEJP73PnKgCi0l5nUzNOvrOIC2ASMf4aoHyKRnRqs1EwshFfkWW+agGebQlW+CaeKIzZ0pmGAthUFwkhLNzEEh9aNR2bpHDT0zOoGZ1DNYgDuYJjvEEQl4T2V7GuEP6qtJQuNDzeu1KQBzqTO2JIGXzugsYk0vg27NRCakZiSy++bLdbXgnDnYR2xtdRxnfY+RWkkNs7Zzn41Ho9lpp4TxvhK6qUgbZHNT6vTrinro/YcFGs/OO4Ge7Qt0pRdCyTRMeTfmDvTXlaf/PNbP73uxrIHCPd8Rtn9eC+khKZ3EdRgnVyfCypP6fnI7pSGNPMU0c2iYPzHnEz5sQ2G46c2eFSd6btFOp6FAdCOFFzqNzWpgLGjKc0rEnpLrUFg5XFAPdx9DWHsENJQnxyF4FJnU2cNY062KrsmMtaV2FLUtRVb+B6gWNXboQzVjeQ4i9PsVfc9NQG6s89qCprYk2HZxuje8vwOVmAJon0CZtAX/8/f/BYzWDsH1vnmv3+vXpWPWLMHR/Cx0yuYKVpLScVhRFOGu21F4EIUC79WaSY2QOYHAUplJFCqMXpQvEmFFLJUkjyUwQ9iO9ZzeD9i7HDAHR1f/cMAES2EBihydUVovBBKprhIsjbubK7P0ERMsLr3U4D0DnQudEGCr/ogZx4RmoBGcdZImQnTEtax5MxqdSJAVQosMiHa0o6UUlCTfZM7EpUfmjSoDy4yWMsZBylqBNEDqB6TEl7T6cMDoNDGFdZCTpyyAZaVMwUcsMSmwesglEXTKYvDILPEiE/BEtNTKJHfBbvNSKWYN5QspFG1i+jwSOjqhPXVRNS+tDTqFWWdoKwI1g0+fvvVAFn4l9Z2fPH36Xp+w286Z3kHsJcL029brl8vlnrc/2cW5lPhTGbNfwBov0bj1FjuTmJdxiJA+ke6jpnQJGoL/9CJgSyM1id8PODod5qDs8BqQPMQPL95chRT7hP352x/sFQinWW6WtbcmpQO1Zln7FGmutnytti5DsrkJjpeTxpPa+WjjBR5Jg9Q27Ubzbtg5mIMj5QdDbp+zsiF/27LJiPu/ImbY3RiNIsFeq0pp5Yf7dEJaB1f41/NrcAuZtMubj1h4GICHPOJKJqA99MrFxeWbV2zBzgcjHvVS5CdYe/jq6seXP1+/DP0xOF9r7HQwGozCSGw8FkL3nuovSu8nuM22jP4NS9UmRdPwOLRKyFAYmwmmLmq3vLdnnfRXqtOI58YjgWw2sfDw1qmqouNfy9Bk3k4jvhBOEn+h8qXS0++025h+VNJvf2mWr0/YR7azBzlvK46mcrMQqgzTVcTvYH1vH1xNaYqvyw6xVkNcJAlY7OHu9S07xf/y5Q0PTXm+W+7uQrlrfhD1g3zt1sGaAfpLJfkgwmZTl9Kq6uDrq49iNAK20KSkaVVV/wdviDUx","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"}}');var o=n(74848),s=n(28453),a=n(33617),r=n.n(a),p=n(17543),m=n.n(p),l=n(86013),c=n.n(l),d=n(63723),u=n.n(d),g=(n(18766),n(79329),n(9303));const f={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:"eJy9GNtuGzf2V1i+bBOMJdlWklZPNbpZ17tBE9QOAqwjCJyZoxnGHJIlz+gCYYA+9A/6B/tp/ZLF4Vw0shQ7StO82BrynMNzv204iszzyS3/p0nKAjR6Po14Cj5x0qI0mk/4TQ7sEpC1IOzizRUDLWIFnq1NydAwB+gkLIClgEIqz0RsSmSCeQuJnMuEpQ32gEfcWHCCqF+lfMIzwPaSR9wKJwpAcMTWhmtRAJ/wFmAmUx5xSWxZgTm/z6uJP0CCVykz845fHnEHv5bSQcon6EqIuMe1IrJeFlYBjzisrDIp8MlcKE8ASQ6F4JMNx7UNkOikznjE58YVAvsnsBKByoTbn07jPDnLbcyrakrPemu0B0+EzkYj+rfLry+TBLyfl4p1SuERT4xG4nyy4cJaJZNwMfzgCWmzz10tNmnPERmU9ZMeBZb+WCmkPrHOZA6851XUqfRYMv+6lHdn53H+9t9EZS7p8DgKOaL1k+GwOSmdGiSmIGoJyTgntXw20R6JHmGUeDyfPvwgDycS2hzPlFUgPDAvM90FStCaUSm4xw39ZWxUx9pxFGoOWUCttgrcBmwjAjnSUu/I8kn0PxhgMQDhk3ZCWugoCOfEmvIBQuEf15Izh227fS0B85AiDrIFhZDqUegY4IfmoPU1mxv9yDPjZ8/PTs+/e3FK8EuZZoB/Qf769jj9I6wwNqvAr8j66LosYnB99O6kQz+tIr46EudsPK4ivj4S6wU9tTwS6fy7KuL5kUjj5+TLIYF/gs4/J6Y6nVf9iEIorBIIs+s6DmatPzwIFYLSg06v9Gu3m0tiYxQI3X+aqiOlVwcCIb3Ah73zbHR2fnI6Ohm9uDl9Phl/P3n2fDAajf7LI74q1FZ6nlKe7ieH5ru06Vd5p25Wbkz5aeI7SKWDBGelOxjYD9mOnhNKmeWsMGldX+45yoF3Q9NBiGUqcYZuN6EcGeWfnY8WEpZwsIR8QVOEJP73PnKgCi0l5nUzNOvrOIC2ASMf4aoHyKRnRqs1EwshFfkWW+agGebQlW+CaeKIzZ0pmGAthUFwkhLNzEEh9aNR2bpHDT0zOoGZ1DNYgDuYJjvEEQl4T2V7GuEP6qtJQuNDzeu1KQBzqTO2JIGXzugsYk0vg27NRCakZiSy++bLdbXgnDnYR2xtdRxnfY+RWkkNs7Zzn41Ho9lpp4TxvhK6qUgbZHNT6vTrinro/YcFGs/OO4Ge7Qt0pRdCyTRMeTfmDvTXlaf/PNbP73uxrIHCPd8Rtn9eC+khKZ3EdRgnVyfCypP6fnI7pSGNPMU0c2iYPzHnEz5sQ2G46c2eFSd6btFOp6FAdCOFFzqNzWpgLGjKc0rEnpLrUFg5XFAPdx9DWHsENJQnxyF4FJnU2cNY062KrsmMtaV2FLUtRVb+B6gWNXboQzVjeQ4i9PsVfc9NQG6s89qCprYk2HZxuje8vwOVmAJon0CZtAX/8/f/BYzWDsH1vnmv3+vXpWPWLMHR/Cx0yuYKVpLScVhRFOGu21F4EIUC79WaSY2QOYHAUplJFCqMXpQvEmFFLJUkjyUwQ9iO9ZzeD9i7HDAHR1f/cMAES2EBihydUVovBBKprhIsjbubK7P0ERMsLr3U4D0DnQudEGCr/ogZx4RmoBGcdZImQnTEtax5MxqdSJAVQosMiHa0o6UUlCTfZM7EpUfmjSoDy4yWMsZBylqBNEDqB6TEl7T6cMDoNDGFdZCTpyyAZaVMwUcsMSmwesglEXTKYvDILPEiE/BEtNTKJHfBbvNSKWYN5QspFG1i+jwSOjqhPXVRNS+tDTqFWWdoKwI1g0+fvvVAFn4l9Z2fPH36Xp+w286Z3kHsJcL029brl8vlnrc/2cW5lPhTGbNfwBov0bj1FjuTmJdxiJA+ke6jpnQJGoL/9CJgSyM1id8PODod5qDs8BqQPMQPL95chRT7hP352x/sFQinWW6WtbcmpQO1Zln7FGmutnytti5DsrkJjpeTxpPa+WjjBR5Jg9Q27Ubzbtg5mIMj5QdDbp+zsiF/27LJiPu/ImbY3RiNIsFeq0pp5Yf7dEJaB1f41/NrcAuZtMubj1h4GICHPOJKJqA99MrFxeWbV2zBzgcjHvVS5CdYe/jq6seXP1+/DP0xOF9r7HQwGozCSGw8FkL3nuovSu8nuM22jP4NS9UmRdPwOLRKyFAYmwmmLmq3vLdnnfRXqtOI58YjgWw2sfDw1qmqouNfy9Bk3k4jvhBOEn+h8qXS0++025h+VNJvf2mWr0/YR7azBzlvK46mcrMQqgzTVcTvYH1vH1xNaYqvyw6xVkNcJAlY7OHu9S07xf/y5Q0PTXm+W+7uQrlrfhD1g3zt1sGaAfpLJfkgwmZTl9Kq6uDrq49iNAK20KSkaVVV/wdviDUx",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,x={},b=[];function P(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,o.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,o.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,o.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,o.jsx)(m(),{parameters:[{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,o.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,o.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{status:{type:"string",format:"string",example:"in-progress"},objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},certificate:{type:"string",format:"string",example:"https://certificateurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},audit_trail:{type:"array",items:{type:"object",properties:{email:{type:"string",example:"joebee@example.com"},viewed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},signed:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}},title:"documentwithstatus_audit_trail"}},template_id:{type:"string",example:"template_id is only available when the document is created from a template."},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"documentwithstatus"},title:"documentwithstatus"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Document not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Document not found!"}},title:"inline_response_404_3"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function j(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(P,{...e})}):P(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink