WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-24 02:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
49f688244d953bbf083811139ed56bbb765bb559
OpenSign/assets/js/f0ff4a36.c0d4e545.js
T

1 line
9.1 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:()=>b,contentTitle:()=>f,default:()=>A,frontMatter:()=>x,metadata:()=>o,toc:()=>y});const o=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":"eJy9GNtu2zb0V1i+rAUUXxI37fzUYO2ybMVSLCkKLDUMSjqW2FAkRx7ZMQy97Uv2afuS4VCXyImb1FvXl8Qiz/1+uOEoMs+nV/y1ScoCNHo+i3gKPnHSojSaT/llDuwUkLUg7OTdGQMtYgWerU3J0DAH6CQsgaWAQirPRGxKZIJ5C4lcyISlDfaAR9xYcIKon6V8yjPA9pJH3AonCkBwJNaGa1EAn/IWYC5THnFJYlmBOb8rq4k/QYJnKTOLTl4ecQd/lNJByqfoSoi4x7Uisl4WVgGPONxYZVLg04VQngCSHArBpxuOaxsg0Umd8YgvjCsE9k/gRgQqU25/Gsd5cpjbmFfVjNh6a7QHT4QORyP6ty2vL5MEvF+UinVG4RFPjEaSfLrhwlolk3Ax/OQJaXNfulptsp4jMihrlh4Fln5fLaQ+sM5kDrznVdSZdF8yP57K68OjOH//M1FZSDrcj0KOaP10OGxOSqcGiSmIWkI6Lsgs/5poj0SPMErcX04fflCEEwlt9hfKKhAemJeZ7hIlWM2oFNzjjv46PqpzbT8KtYQsoFa3BrxN2EYFCqSV3tLli+h/MsBiAMIn64Sy0FEQzok11QOEwj9uJWd2+/aWWwLmIUPsFAsKIdWj0DHAq+agjTWbG/0Im8nz48Px0csXY4JfyTQD/A/617f3+W2XpBOlzApSthSqBM8OQlQKLB1EzKMo7OCxdGjhSeibHkNdFjG4PnZ30mEfTiZVxNd7Yr0Yk332RDp6WUU83xNpckyeExnsiTfuJwdCYZVAmF/UIT1vXVs9BBXyy4NOz/S52y4LsTEKhO4zpEZHldKBQEhP8OFAOxwdHh2MRwejF5fj4+nk++nz48FoNPqdR/ymCNHdNmIquf08b75Lm34TPvXccWnKL1PfQSodJDgv3c4cfSiOiZ2gZJgXJq1bhTTaP8w3zA/kqDvqNOVwJTFvuvKOYtm/DaEw2TUzXJgCMJc6YyuaxlbO6CxiTQtBt2YiE1IzCh335OsNE+Cc2Vm+by22n2T9WJdaSQ3zdmCaT0aj+bgzwuS+EbphVBtkC1Pq9Nuquov/wwpN5kedQs/vK3Sml0LJNAzXl+Ya9LfVp88ea/b3o1jWQOGebynbP6+V9JCUTuI6TPE3B8LKg/p+ejWj2ZgixTTjfxj7MedTPmxTYbjpjfwVJ3pu2S4FIZm7Sc4LncbmZmAsaOo9SsSeeuxQWDlcUuu8iyGs3QMayoP9EDyKTOrsYazZrYkuyI21p7YMddvnrfwFqNE3fuhDNdtQDiKMWRV9L0xAbrxzbkFTCwm+XY7vNfwPoBJTAK1xmANrwf/+86+A0fohhN4Tdl46Zs0KHO0sQqdsoeBGxgoCcKiX3VboQRQKvFdrJjVC5gQCS2UmUagwVlCpSIQVsVSSgpXADGE71ot3P2AfcsAcHF1954AJlsISFMU4U8ZcEx00TJRoisCjzc6VcdcLEiligsWllxq8Zx6gRQGdC50Aa30RMeOY0Aw0grNOemBCFgS8MI7BYiETSYQpM51IkBVCiwyIWcRIbrKCdWYpU/DMmbj0yLxRZVCEOBYAWKuoAVI/YK/lEmrF6bBeoCFlWUkkIpaYFFiTqKSGTlkMHpkl9jKBQNSjcMgULMGF2AueXJRKMWuogkihaCXu+5YIoRPaUw+sBWpd05nPOkPraeCRivWAfdQfNVV5VnqgAFBSX/vpR33Arrow+wCxlwizp20+rFare3nwbBvnVGJexsyBNbd4WTgMWdNH7z6e8YgjuMKfLy7ALWXS7nef4TkMwMOmrook1NVmfKcce3UXgWqckgloD70qeHL67i1bsqPBiEe9zP8CgYdvz3548+vFG6JLxazOv/FgNBiFhcB4LITuseo/u9zN281td/gfnmiayoNwg0OrhAz1vhmi6lp9xXuvNtP+A80s4rnxSCCbTSw8vHeqquj4jxIcdYRZxJfCSZIvFPRUevqddu8vn9X06W/NU84z9pm3np2St4VUUxUNmw0NeBG/hvWd16VqRltBXU1JtBriJEnAYg/3Xjve6mmnby55xEWJ+XYVvw5VvPlB1HfKtV3eawHoL3WanQibTd0hqqqDr68+i9Eo2EKTkWZVVf0D3IrsDQ==","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=n(74848),a=n(28453),s=n(33617),r=n.n(s),p=n(17543),l=n.n(p),m=n(86013),d=n.n(m),c=n(63723),u=n.n(c),g=(n(18766),n(79329),n(9303));const x={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:"eJy9GNtu2zb0V1i+rAUUXxI37fzUYO2ybMVSLCkKLDUMSjqW2FAkRx7ZMQy97Uv2afuS4VCXyImb1FvXl8Qiz/1+uOEoMs+nV/y1ScoCNHo+i3gKPnHSojSaT/llDuwUkLUg7OTdGQMtYgWerU3J0DAH6CQsgaWAQirPRGxKZIJ5C4lcyISlDfaAR9xYcIKon6V8yjPA9pJH3AonCkBwJNaGa1EAn/IWYC5THnFJYlmBOb8rq4k/QYJnKTOLTl4ecQd/lNJByqfoSoi4x7Uisl4WVgGPONxYZVLg04VQngCSHArBpxuOaxsg0Umd8YgvjCsE9k/gRgQqU25/Gsd5cpjbmFfVjNh6a7QHT4QORyP6ty2vL5MEvF+UinVG4RFPjEaSfLrhwlolk3Ax/OQJaXNfulptsp4jMihrlh4Fln5fLaQ+sM5kDrznVdSZdF8yP57K68OjOH//M1FZSDrcj0KOaP10OGxOSqcGiSmIWkI6Lsgs/5poj0SPMErcX04fflCEEwlt9hfKKhAemJeZ7hIlWM2oFNzjjv46PqpzbT8KtYQsoFa3BrxN2EYFCqSV3tLli+h/MsBiAMIn64Sy0FEQzok11QOEwj9uJWd2+/aWWwLmIUPsFAsKIdWj0DHAq+agjTWbG/0Im8nz48Px0csXY4JfyTQD/A/617f3+W2XpBOlzApSthSqBM8OQlQKLB1EzKMo7OCxdGjhSeibHkNdFjG4PnZ30mEfTiZVxNd7Yr0Yk332RDp6WUU83xNpckyeExnsiTfuJwdCYZVAmF/UIT1vXVs9BBXyy4NOz/S52y4LsTEKhO4zpEZHldKBQEhP8OFAOxwdHh2MRwejF5fj4+nk++nz48FoNPqdR/ymCNHdNmIquf08b75Lm34TPvXccWnKL1PfQSodJDgv3c4cfSiOiZ2gZJgXJq1bhTTaP8w3zA/kqDvqNOVwJTFvuvKOYtm/DaEw2TUzXJgCMJc6YyuaxlbO6CxiTQtBt2YiE1IzCh335OsNE+Cc2Vm+by22n2T9WJdaSQ3zdmCaT0aj+bgzwuS+EbphVBtkC1Pq9Nuquov/wwpN5kedQs/vK3Sml0LJNAzXl+Ya9LfVp88ea/b3o1jWQOGebynbP6+V9JCUTuI6TPE3B8LKg/p+ejWj2ZgixTTjfxj7MedTPmxTYbjpjfwVJ3pu2S4FIZm7Sc4LncbmZmAsaOo9SsSeeuxQWDlcUuu8iyGs3QMayoP9EDyKTOrsYazZrYkuyI21p7YMddvnrfwFqNE3fuhDNdtQDiKMWRV9L0xAbrxzbkFTCwm+XY7vNfwPoBJTAK1xmANrwf/+86+A0fohhN4Tdl46Zs0KHO0sQqdsoeBGxgoCcKiX3VboQRQKvFdrJjVC5gQCS2UmUagwVlCpSIQVsVSSgpXADGE71ot3P2AfcsAcHF1954AJlsISFMU4U8ZcEx00TJRoisCjzc6VcdcLEiligsWllxq8Zx6gRQGdC50Aa30RMeOY0Aw0grNOemBCFgS8MI7BYiETSYQpM51IkBVCiwyIWcRIbrKCdWYpU/DMmbj0yLxRZVCEOBYAWKuoAVI/YK/lEmrF6bBeoCFlWUkkIpaYFFiTqKSGTlkMHpkl9jKBQNSjcMgULMGF2AueXJRKMWuogkihaCXu+5YIoRPaUw+sBWpd05nPOkPraeCRivWAfdQfNVV5VnqgAFBSX/vpR33Arrow+wCxlwizp20+rFare3nwbBvnVGJexsyBNbd4WTgMWdNH7z6e8YgjuMKfLy7ALWXS7nef4TkMwMOmrook1NVmfKcce3UXgWqckgloD70qeHL67i1bsqPBiEe9zP8CgYdvz3548+vFG6JLxazOv/FgNBiFhcB4LITuseo/u9zN281td/gfnmiayoNwg0OrhAz1vhmi6lp9xXuvNtP+A80s4rnxSCCbTSw8vHeqquj4jxIcdYRZxJfCSZIvFPRUevqddu8vn9X06W/NU84z9pm3np2St4VUUxUNmw0NeBG/hvWd16VqRltBXU1JtBriJEnAYg/3Xjve6mmnby55xEWJ+XYVvw5VvPlB1HfKtV3eawHoL3WanQibTd0hqqqDr68+i9Eo2EKTkWZVVf0D3IrsDQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,b={},y=[];function j(e){const t={p:"p",...(0,a.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}},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 A(e={}){const{wrapper:t}={...(0,a.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