WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-06 01:37:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
e2ef3fa7f591fa06bfeef7b345c98164adb5277c
OpenSign/assets/js/f0ff4a36.4e6daff2.js
T

1 line
10 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7315],{56397:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>x,contentTitle:()=>f,default:()=>G,frontMatter:()=>y,metadata:()=>n,toc:()=>h});const n=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":"eJy9GFtuG8nxKrX9k7Ux4kOi7Q2/VkgcrRIjNlYyDEQWiJ6ZIqetnu7e7hpSBEEgH7lBbpCj7UmC6uEMhyItmbte/9hiT73fVStBchbE+Eb81WZViYaCuE1EjiHzypGyRozFdYFwgQQNCJy/uwQ0MtUYYGkrIAseySucI+RIUukAMrUVgYTgMFNTlUG+we6JRFiHXjL1y1yMxQyp+SgS4aSXJRJ6FmsljCxRjEUDMFG5SIRisZykQjyU1aafMKPLHOy0lVckwuMvlfKYizH5ChMRaKmZbFCl0ygSgfdO2xzFeCp1YICswFKK8UrQ0kVI8srMRCKm1peSui94LyOVsXA/DdMiOy1cKtbrW2YbnDUBAxM6HQz4v115Q5VlGMK00tAaRSQis4ZY8vFKSOe0yuKH/qfASKt96Wq12XqeyZCqWQaSVIVjtVDmxHk78xiCWCetSY8l87cLdXd6lhbv/85Upoofj6NQELkw7vc3L5XXvcyWTC1jHadslt9MtEOiQ5gUHS9niH9whDMJY48XymmUASGomWkTJVrN6hz9047+Oj6qc+04CrWEEFHXWwNuE3ajAgfSwuzo8kX0P1mEFJHx2TqxLLQUpPdyyfWAsAxPW8nbw77dcsvQPmaIg2JhKZV+EjpF/HHz0MSaK6x5gs3oxcvT4dkPr4YMv1D5DOl36F9/3ee3W5LOtbYLzGEudYUBTmJUSqo8JhBIlq73VDo08Cz0fYehqcoUfRe7fWmxT0ejdSKWR2K9GrJ9jkQ6+2GdiOJIpNFL9pyc4ZF4w25yEJZOS8LJVR3Sk8a168egYn4FNPmleet3y0JqrUZpugy50XGl9CgJ83N6PNBOB6dnJ8PByeDV9fDlePTn8YuXvcFg8C+RiPsyRnfTiLnkdvN887ty+TfhU88d17b6MvU95spjRpPKH8zRx+KY2UlOhklp87pVKGvC43zj/MCIVa5oQn63NhyZsL+5tMwVLvBgN/iKroj1+I9lcqChLBQV9Vwz6do4gjYJo56QqgMIKoA1eglyLpXm2IJFgQaowLYTM8wmj2DqbQkSGgq9GCQV2YnHUpkns7IJjxp6Yk2GE2UmOEd/sOa1iANW8IHJ9iwiHrUXV5d1IkaH5tArWyIVysxgwQovvDWzBDZjCfklyJlUBlhl/93XG1DRe3twJNj66jjJuhGjjFYGJ80QPhkNBpNha4TRvhHaBcdYgqmtTP5tVT3E/3GFRpOzVqEX+wpdmrnUKo8L27W9Q/Nt9emyp5r9fhSrGih+FzvKdt9rJQNmlVe0jJvh/Yl06qT+Pr655X2LI8VuVsq4SlIhxqLfpEJ/1Vkj14Lp+XmzaMYG0W4HQZo8tfc969BwndMyDVxc+9Kp/pzHsYcY0rkjoLE6OQ4hkJwpM3sc63Zroit2Y+2pHUNtW5FT/0DuRRs/dKE2G3aBMo7ua/49tRF54523Dg2PJdG38+HeEPkBdWZL5NMAV9IG/Nf//C9iNH6IoffdR/PRvK08OLtAz6uwNDlMNd4rLsfx2lDGb+25IaAsNYagl6AM4cxLQsjVTJHUcV7lepFJJ1OlFUcsg1nG9tAJ+tCDDwVSgZ4//ckjSMhxjpoDHbisl5KYVNsJFtbfTbVdhAQkpFVQBkMANIU0GQM25k/AepAG0BB65xUvd+RZalXLZg15mRGU0sgZMu1kx0o5asWxCd6mVSAIVldRZOD7ivWYQ6OQQcxDj434mq8YHoFfM1s6jwVHyhxhVqkcQwKZzRHqfZVVMDmkGAgcy6IyDEy0Mtpmd9Fv00prcJbrhZKajypdGRmdvDSBp6halsYHrcGct3zgwFrA58/fB2QPv1HmLoyfP/9oTuCmDaYPmAZFePt9E/WLxWIv2p/t4lwo+qlK4Wd0NiiyfrnFnikqqjRmSJdI+6OmdIEGY/x0MmBLI7dZ2E84fu0XqF3/CokjJPTP313GEvsMfv33f+ENSm+gsIs6WrPKo17CrGHFlqs9X5utrZAwtTHwCrZ4VgcfH68wEFuQx6bdbN5NO49T9Gz86MgtO6c25G8aMYGl/z1qxjOMNSQz6oyqXFZ+fEgnlnX0ZXg7vUI/V1lzh/mMh/sRuC8SoVWGJmCnXZxfvHsDczjrDUTSKZFf4O3+m8u/vP7n1es4H6MPtcWGvUFvELdxG6iUpsOqe/N8WOBW2zb6B9xHNyWa8J76TksVG+Nmg6mb2o3onEzH3evobSIKG4hBVqtUBnzv9XrNz79Ucci8uU3EXHrF8sXOl6vAf+ft8fOzmn7/8+aO+gw+c2g9KHnTcQy3m3hW4O0qEXe4fHDaXd/ySl63HRathjjPMnTUwd2bW3aa/8XraxGH8mK33d3Fdrf5g6kflGu3D9YC8L/ckg8irFZ1K12vW/j602cxNgo20Gyk2/V6/X/ZtCMd","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 i=a(74848),o=a(28453),s=a(33617),r=a.n(s),p=a(17543),l=a.n(p),m=a(86013),d=a.n(m),c=a(63723),u=a.n(c),g=(a(18766),a(79329),a(9303));const y={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:"eJy9GFtuG8nxKrX9k7Ux4kOi7Q2/VkgcrRIjNlYyDEQWiJ6ZIqetnu7e7hpSBEEgH7lBbpCj7UmC6uEMhyItmbte/9hiT73fVStBchbE+Eb81WZViYaCuE1EjiHzypGyRozFdYFwgQQNCJy/uwQ0MtUYYGkrIAseySucI+RIUukAMrUVgYTgMFNTlUG+we6JRFiHXjL1y1yMxQyp+SgS4aSXJRJ6FmsljCxRjEUDMFG5SIRisZykQjyU1aafMKPLHOy0lVckwuMvlfKYizH5ChMRaKmZbFCl0ygSgfdO2xzFeCp1YICswFKK8UrQ0kVI8srMRCKm1peSui94LyOVsXA/DdMiOy1cKtbrW2YbnDUBAxM6HQz4v115Q5VlGMK00tAaRSQis4ZY8vFKSOe0yuKH/qfASKt96Wq12XqeyZCqWQaSVIVjtVDmxHk78xiCWCetSY8l87cLdXd6lhbv/85Upoofj6NQELkw7vc3L5XXvcyWTC1jHadslt9MtEOiQ5gUHS9niH9whDMJY48XymmUASGomWkTJVrN6hz9047+Oj6qc+04CrWEEFHXWwNuE3ajAgfSwuzo8kX0P1mEFJHx2TqxLLQUpPdyyfWAsAxPW8nbw77dcsvQPmaIg2JhKZV+EjpF/HHz0MSaK6x5gs3oxcvT4dkPr4YMv1D5DOl36F9/3ee3W5LOtbYLzGEudYUBTmJUSqo8JhBIlq73VDo08Cz0fYehqcoUfRe7fWmxT0ejdSKWR2K9GrJ9jkQ6+2GdiOJIpNFL9pyc4ZF4w25yEJZOS8LJVR3Sk8a168egYn4FNPmleet3y0JqrUZpugy50XGl9CgJ83N6PNBOB6dnJ8PByeDV9fDlePTn8YuXvcFg8C+RiPsyRnfTiLnkdvN887ty+TfhU88d17b6MvU95spjRpPKH8zRx+KY2UlOhklp87pVKGvC43zj/MCIVa5oQn63NhyZsL+5tMwVLvBgN/iKroj1+I9lcqChLBQV9Vwz6do4gjYJo56QqgMIKoA1eglyLpXm2IJFgQaowLYTM8wmj2DqbQkSGgq9GCQV2YnHUpkns7IJjxp6Yk2GE2UmOEd/sOa1iANW8IHJ9iwiHrUXV5d1IkaH5tArWyIVysxgwQovvDWzBDZjCfklyJlUBlhl/93XG1DRe3twJNj66jjJuhGjjFYGJ80QPhkNBpNha4TRvhHaBcdYgqmtTP5tVT3E/3GFRpOzVqEX+wpdmrnUKo8L27W9Q/Nt9emyp5r9fhSrGih+FzvKdt9rJQNmlVe0jJvh/Yl06qT+Pr655X2LI8VuVsq4SlIhxqLfpEJ/1Vkj14Lp+XmzaMYG0W4HQZo8tfc969BwndMyDVxc+9Kp/pzHsYcY0rkjoLE6OQ4hkJwpM3sc63Zroit2Y+2pHUNtW5FT/0DuRRs/dKE2G3aBMo7ua/49tRF54523Dg2PJdG38+HeEPkBdWZL5NMAV9IG/Nf//C9iNH6IoffdR/PRvK08OLtAz6uwNDlMNd4rLsfx2lDGb+25IaAsNYagl6AM4cxLQsjVTJHUcV7lepFJJ1OlFUcsg1nG9tAJ+tCDDwVSgZ4//ckjSMhxjpoDHbisl5KYVNsJFtbfTbVdhAQkpFVQBkMANIU0GQM25k/AepAG0BB65xUvd+RZalXLZg15mRGU0sgZMu1kx0o5asWxCd6mVSAIVldRZOD7ivWYQ6OQQcxDj434mq8YHoFfM1s6jwVHyhxhVqkcQwKZzRHqfZVVMDmkGAgcy6IyDEy0Mtpmd9Fv00prcJbrhZKajypdGRmdvDSBp6halsYHrcGct3zgwFrA58/fB2QPv1HmLoyfP/9oTuCmDaYPmAZFePt9E/WLxWIv2p/t4lwo+qlK4Wd0NiiyfrnFnikqqjRmSJdI+6OmdIEGY/x0MmBLI7dZ2E84fu0XqF3/CokjJPTP313GEvsMfv33f+ENSm+gsIs6WrPKo17CrGHFlqs9X5utrZAwtTHwCrZ4VgcfH68wEFuQx6bdbN5NO49T9Gz86MgtO6c25G8aMYGl/z1qxjOMNSQz6oyqXFZ+fEgnlnX0ZXg7vUI/V1lzh/mMh/sRuC8SoVWGJmCnXZxfvHsDczjrDUTSKZFf4O3+m8u/vP7n1es4H6MPtcWGvUFvELdxG6iUpsOqe/N8WOBW2zb6B9xHNyWa8J76TksVG+Nmg6mb2o3onEzH3evobSIKG4hBVqtUBnzv9XrNz79Ucci8uU3EXHrF8sXOl6vAf+ft8fOzmn7/8+aO+gw+c2g9KHnTcQy3m3hW4O0qEXe4fHDaXd/ySl63HRathjjPMnTUwd2bW3aa/8XraxGH8mK33d3Fdrf5g6kflGu3D9YC8L/ckg8irFZ1K12vW/j602cxNgo20Gyk2/V6/X/ZtCMd",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,x={},h=[];function j(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,i.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(l(),{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,i.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,i.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."},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 G(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink