WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 12:34:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
b6f6d989d2f7300d951a3eae98c5b4c28dfaaa24
OpenSign/assets/js/f0ff4a36.4600e4ad.js
T

1 line
9.9 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:()=>h,contentTitle:()=>y,default:()=>D,frontMatter:()=>g,metadata:()=>i,toc:()=>f});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":"eJy9GNty2zb2V07xss0MrYutJF091bPNum47TWbtTmbW0WhA8pBEDAIoAErWaPjWL9lP2y/ZOeBFlKXYUTfNiy0C534/2DLPc8fmd+wHnVQlKu/YImIpusQK44VWbM5uC4Qr9NCBwOW7a0DFY4kONroCr8GitwJXCCl6LqQDHuvKAwdnMBGZSCBtsUcsYtqg5UT9OmVzlqPvLlnEDLe8RI+WxNoyxUtkc9YBLEXKIiZILMN9wR7LquOPmPjrFHTWy8siZvH3SlhM2dzbCiPm/EYSWSdKI5FFDB+M1CmyecalI4CkwJKz+Zb5jQmQ3gqVs4hl2pbcD0/wgQcqc2Z+nMZFcl6YmNX1gtg6o5VDR4TOJxP6ty+vq5IEncsqCb1RWMQSrTxJPt8ybowUSbgYf3SEtD2UrlGbrGeJjBcNS+e5r9ypWgh1ZqzOLTrH6qg36alk/nkl7s8v4uK3n4hKJujwNAqF98bNx+P2pLJylOiSqCWkY0Zm+dNEByQGhL3wp8vpwg+KcCKh9OlCGYncITiRqz5RgtW0TNE+7+gv46Mm106j0EgIAbXeGXCXsK0KFEhrtafLZ9H/qBFiRMIn64Sy0FPg1vIN1QOPpXveSlYf9+2OW4L6KUMcFQtLLuSz0DHi9+1BF2um0OoZNrOXr86nF9+9nhL8WqQ5+v9D/+b2kN9+SbqUUq8xhRWXFTo4C1HJfWUxAud5aUbPpUMHT0I/DBiqqozRDrH7kx77fDarI7Y5Eev1lOxzItLFd3XEihORZq/IczzHE/Gmw+TwWBrJPS5vmpBedq6tn4IK+eVQpdfqrd0vC7HWErkaMqRGR5XSIveYXvqnA+18cn5xNp2cTV7fTl/NZ3+fv3w1mkwm/2YReyhDdHeNmEruMM/b78qkX4VPM3fc6urz1LeYCouJX1b2aI4+FcfEjlMyLEudNq1CaOWe5hvmB0KsUuGX3u7XhhMT9k+XlpXANR7tBl/QFaEe/7VMjjSUtfBFM9cshzYOoF3CiGekGgCCcKCV3ABfcSEptmBdoAJfYN+JCabNI8isLoFDR2EUGD9S5UBS9qQelPV1xGbH5sMbXaIvhMphTYKsrVZ5BO244O0GeM6FAhLFfvPlBke0Vh9t1TsbnibZ0JNCSaFw2Q3Hy9lkspz2RpgdGqFfPJT2kOlKpV9X1WP8n1ZotrzoFXp5qNC1WnEp0rBI3ep7VF9XnyF737A/jGLRAIV7tqfs8LxR0mFSWeE3YWN7OONGnDX387sF7UEUKbpd9cKK5ws2Z+MuFcbbwXpXM6JnV90CGAp3P7U7rtJYP4y0QUX1R/LYUdEbcyPGKxqTHmNwY06AxursNATneS5U/jTWYmeiG3Jj46k9Q+1ahBE/I/WI1g9DqHbzLZCHkbqm70wH5NY7bw0qGheCb1fTg+HuPcpEl0grO1W4Dvy/f/wnYHR+CKH3DbytLBi9Rkv7KVcpZBIfBNVIAg69sX8BcMhLic7JDQjlMbfcI6QiF57LMEJSqUi44bGQgoKVwDRhWxjEuxvB+wJ9gZau/mYROKS4QkkxDlLre6LjNfDK6zLw6LJzre19RiJFwCGunFDoHDjEDgVVwVWC0PkiAm2BK0Dl0RorHAIXJQFn2gJmmUgEEabMtDzxUHLFcyRmEZDcZAVj9Uqk6MDquHIenJZVUIQ4loi+UVEhpm4EP4gVNorTYfNYginkFZGIINEpQpuopIZKIUbnwRB7kWAg6jy3HiSu0IbYC57MKinBaKoggkt6/hj6lgh5y5WjeacRqHNNbz5jNT1FBB4p34zgg/qgqMpD5ZACQAp17+Yf1Bnc9WH2HmMnPC6+7fJhvV4f5MGLfZwr4YsqBotG7/DycBiyZojef7ygiWE/YfYj22KGlrQJNspRYYhAbkRT4+Du8t11KLZQoDQ7zoRymLp0OibA8Q16L1Tuxh3+i/ACoZXniR9MaZS53z+mEyon2tK9zW7QrkTSPUF8wlTjADxmEZMiQeVwUJEvr979Aiu4GE1YNKhCn2G88S/X/3jz682bMBqidY3FpqPJaBIWUe18ydWA1fC573EN2e461V/wNNhWQY8PfmwkF6H3tMN70zfu2OC1cD58GFxErNDOE8h2G3OHv1lZ13T8e4WWutMiYituBckXmksqHP1O+3e/T2r67b/aJ8QX8Ik3xqOSd0VdUUUPGzUtFhG7x82jV816QdtoU9lJtAbiMknQ+AHuwWiw11+v3twy2j18sd9R7kNHaX8Q9aNy7beaRgD6S13vKMJ223Sruu7hm6tPYrQKdtBkpEVd1/8DPLvBeA==","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 r=n(74848),a=n(28453),o=n(33617),p=n.n(o),s=n(17543),m=n.n(s),l=n(86013),c=n.n(l),d=n(63723),u=n.n(d),b=(n(18766),n(79329),n(9303));const g={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:"eJy9GNty2zb2V07xss0MrYutJF091bPNum47TWbtTmbW0WhA8pBEDAIoAErWaPjWL9lP2y/ZOeBFlKXYUTfNiy0C534/2DLPc8fmd+wHnVQlKu/YImIpusQK44VWbM5uC4Qr9NCBwOW7a0DFY4kONroCr8GitwJXCCl6LqQDHuvKAwdnMBGZSCBtsUcsYtqg5UT9OmVzlqPvLlnEDLe8RI+WxNoyxUtkc9YBLEXKIiZILMN9wR7LquOPmPjrFHTWy8siZvH3SlhM2dzbCiPm/EYSWSdKI5FFDB+M1CmyecalI4CkwJKz+Zb5jQmQ3gqVs4hl2pbcD0/wgQcqc2Z+nMZFcl6YmNX1gtg6o5VDR4TOJxP6ty+vq5IEncsqCb1RWMQSrTxJPt8ybowUSbgYf3SEtD2UrlGbrGeJjBcNS+e5r9ypWgh1ZqzOLTrH6qg36alk/nkl7s8v4uK3n4hKJujwNAqF98bNx+P2pLJylOiSqCWkY0Zm+dNEByQGhL3wp8vpwg+KcCKh9OlCGYncITiRqz5RgtW0TNE+7+gv46Mm106j0EgIAbXeGXCXsK0KFEhrtafLZ9H/qBFiRMIn64Sy0FPg1vIN1QOPpXveSlYf9+2OW4L6KUMcFQtLLuSz0DHi9+1BF2um0OoZNrOXr86nF9+9nhL8WqQ5+v9D/+b2kN9+SbqUUq8xhRWXFTo4C1HJfWUxAud5aUbPpUMHT0I/DBiqqozRDrH7kx77fDarI7Y5Eev1lOxzItLFd3XEihORZq/IczzHE/Gmw+TwWBrJPS5vmpBedq6tn4IK+eVQpdfqrd0vC7HWErkaMqRGR5XSIveYXvqnA+18cn5xNp2cTV7fTl/NZ3+fv3w1mkwm/2YReyhDdHeNmEruMM/b78qkX4VPM3fc6urz1LeYCouJX1b2aI4+FcfEjlMyLEudNq1CaOWe5hvmB0KsUuGX3u7XhhMT9k+XlpXANR7tBl/QFaEe/7VMjjSUtfBFM9cshzYOoF3CiGekGgCCcKCV3ABfcSEptmBdoAJfYN+JCabNI8isLoFDR2EUGD9S5UBS9qQelPV1xGbH5sMbXaIvhMphTYKsrVZ5BO244O0GeM6FAhLFfvPlBke0Vh9t1TsbnibZ0JNCSaFw2Q3Hy9lkspz2RpgdGqFfPJT2kOlKpV9X1WP8n1ZotrzoFXp5qNC1WnEp0rBI3ep7VF9XnyF737A/jGLRAIV7tqfs8LxR0mFSWeE3YWN7OONGnDX387sF7UEUKbpd9cKK5ws2Z+MuFcbbwXpXM6JnV90CGAp3P7U7rtJYP4y0QUX1R/LYUdEbcyPGKxqTHmNwY06AxursNATneS5U/jTWYmeiG3Jj46k9Q+1ahBE/I/WI1g9DqHbzLZCHkbqm70wH5NY7bw0qGheCb1fTg+HuPcpEl0grO1W4Dvy/f/wnYHR+CKH3DbytLBi9Rkv7KVcpZBIfBNVIAg69sX8BcMhLic7JDQjlMbfcI6QiF57LMEJSqUi44bGQgoKVwDRhWxjEuxvB+wJ9gZau/mYROKS4QkkxDlLre6LjNfDK6zLw6LJzre19RiJFwCGunFDoHDjEDgVVwVWC0PkiAm2BK0Dl0RorHAIXJQFn2gJmmUgEEabMtDzxUHLFcyRmEZDcZAVj9Uqk6MDquHIenJZVUIQ4loi+UVEhpm4EP4gVNorTYfNYginkFZGIINEpQpuopIZKIUbnwRB7kWAg6jy3HiSu0IbYC57MKinBaKoggkt6/hj6lgh5y5WjeacRqHNNbz5jNT1FBB4p34zgg/qgqMpD5ZACQAp17+Yf1Bnc9WH2HmMnPC6+7fJhvV4f5MGLfZwr4YsqBotG7/DycBiyZojef7ygiWE/YfYj22KGlrQJNspRYYhAbkRT4+Du8t11KLZQoDQ7zoRymLp0OibA8Q16L1Tuxh3+i/ACoZXniR9MaZS53z+mEyon2tK9zW7QrkTSPUF8wlTjADxmEZMiQeVwUJEvr979Aiu4GE1YNKhCn2G88S/X/3jz682bMBqidY3FpqPJaBIWUe18ydWA1fC573EN2e461V/wNNhWQY8PfmwkF6H3tMN70zfu2OC1cD58GFxErNDOE8h2G3OHv1lZ13T8e4WWutMiYituBckXmksqHP1O+3e/T2r67b/aJ8QX8Ik3xqOSd0VdUUUPGzUtFhG7x82jV816QdtoU9lJtAbiMknQ+AHuwWiw11+v3twy2j18sd9R7kNHaX8Q9aNy7beaRgD6S13vKMJ223Sruu7hm6tPYrQKdtBkpEVd1/8DPLvBeA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},y=void 0,h={},f=[];function x(e){const t={p:"p",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,r.jsx)(p(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,r.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.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,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.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",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},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},page:{type:"number",format:"number",example:1}},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."}},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 D(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink