WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-27 20:14:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
63a8b63c8df87c20c71d834283e080c97102ec21
OpenSign/assets/js/7ef59f7a.8f19f905.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[4865],{62634(e,t,n){n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>h,default:()=>w,frontMatter:()=>x,metadata:()=>o,toc:()=>j});const o=JSON.parse('{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","source":"@site/docs/API-docs/v1.1/getdocument.api.mdx","sourceDirName":"API-docs/v1.1","slug":"/API-docs/v1.1/getdocument","permalink":"/docs/API-docs/v1.1/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":"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1.1/opensign-api-v-1-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Document from Template","permalink":"/docs/API-docs/v1.1/createdocumentwithtemplateid"},"next":{"title":"Update Document","permalink":"/docs/API-docs/v1.1/update-document"}}');var a=n(74848),i=n(28453),r=n(57742),s=n.n(r),p=n(78178),l=n.n(p),m=n(19624),c=n.n(m),u=n(96226),d=n.n(u),f=(n(77675),n(19365),n(51107)),y=n(21312);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:"eJy9GdtuGzf2V87ypY0wluRLkq6earSp627QGLUDA+sYAmfmzAxjDsmSHMmCIKAP+wf7tK/9tHzJ4nAuGsmKHaVpXmyJPPcbzzlaMs9zxyY37EedVCUq79htxFJ0iRXGC63YhF0VCGfooQWB04tzQMVjiQ4WugKvwaK3AmcIKXoupAMe68oDB2cwEZlIIG2whyxi2qDlRP08ZROWo28vWcQMt7xEj5bEWjLFS2QT1gJMRcoiJkgsw33BtmXV8XtM/HkKOuvkZRGz+HslLKZs4m2FEXN+IYmsE6WRyCKG90bqFNkk49IRQFJgydlkyfzCBEhvhcpZxDJtS+77J3jPA5UJMz8fxkVyVJiYrVa3xNYZrRw6InQ0HtO/TXldlSToXFZJ6IzCIpZo5UnyyZJxY6RIwsXovSOk5UPparXJepbIeFGzdJ77yu2rhVAHxurconNsFXUm3ZfMT2fi7ug4Lt7+QlQyQYf7USi8N24yGjUnlZXDRJdELSEdMzLLZxPtkegR9sLvL6cLHyjCiYTS+wtlJHKH4ESuukQJVtMyRfu0o7+Mj+pc249CLSEE1NXagOuEbVSgQJqrDV0+if57jRAjEj5ZJ5SFjgK3li+oHngs3dNWsnq3b9fcEtSPGWKnWFhyIZ+EjhG/bw7aWDOFVk+wOXn+4ujw+LuXhwQ/F2mO/i/oX9/uZ3+P9z7W90FenvfRVVXGaPvo3UmHfriK2P2eOEcnJ6uILfbEekms5nsiHX+3ilixJ9LJC4rlUMA/weafk1OdzVf9jPJYGsk9Ti/rPJi28fAoVEhKhyo9V2/sZi2JtZbIVZ81vY5UXi1yj+mpfzw6j8ZHxweH44Pxy6vDF5OTf06evxiOx+N/s4jdl3KtPUupTveLQ/O9MulX4VM3K1e6+jT1LabCYuKnld2Z2I/5jthxKfV8Wuq0fl+2AmUH39B0EGKVCj/1drOg7Jnln12PZgLnuPMJ+YKuCEX872Wy4xWaC1/UzdC0b+MA2iaMeEKqHiAIB1rJBfAZF5JiC+YFKvAFds83wTR5BJnVJXBoKQxDkFReTy2WQj2ZlW141NBTrRKcCjXFGdqdZbJDHJOCWyZ7YBH2qL2aInSyq3m91CX6Qqgc5qTw3GqVR9D0Mt4ugOdcKCCV7T++XFeL1uqdfcTaV/tJ1o8YoaRQOG079+nJeDw97Ixw8tAI3VSktIdMVyr9uqru4v+4QifT406h5w8VOlczLkUaprwrfYfq6+rTZ+9r9g+jWNRA4Z5tKNs/r5V0mFRW+EUYJ+8PuBEH9f3k5paGNIoU3cyhYf70BZuwUZsKo2Vv9lwxomdn7XQaHohupHBcpbG+H2qDiuqc5LGj4jriRoxmh0Pq4rZxuDF7wWN1sC+K8zwXKn8K73ZtqktyZ+2xDYOtnyQj/oX0JjX+6EM143mBPPT9K/qe6YDceOmNQUXtSfBxYL49xl+jTHSJtFmgmjoYtCgf/vNnhzUYdMU2ROPwnXqn3lQWjJ6jpZGaqxQyifeCKnTYWpThrltbOOSlROfkAoTymFvuEVKRC89lmMaohCTc8FhIQUFMYJqwLfTywA3hukBfoKWrbywChxRnKCn2gSp9yT2R6h6HubZ3mdRzFwGHuHJCoXOAquAqIcDWExFoC1wBKo/WWEFDorcktahl08pbnngoueI5Eu0I+sZKUQoKV7A6rpwHp2UVRAba02iLKbQKKcTUBSO+om2IRaDTRJfGYkFhM0PIK5GiiyDRKUI995IKKoUYnQdDsogEHRGtlNTJXXBgVkkJRlMJEVzScqYvI6F7y5WjxqqWpfVBZzBjNS1KsBZwMHjrkDz8Wqg7NxkM3qkDuOni6hpjJzzeftumwHw+fxD6zzZxzoT/uYrhNzTaCa/tYo2dC19UcUiXPpHuS03pDBWG+Oklw5pGqhP3MPvodFSgNKNL9BQhbnR6cR6q7jP48Md/4TVyq6DQ8zpak8qiXEDesiLL1Z6vzdYVTch0CLyCLJ7UwUdLMHS+teB1wf2HP/7n4Fecg1BNSpEqg8FFFUuRwFXTsLjBYAI/hGama2Ic+IJ7SLiCGMEVnEJpJjhwMDW2FOpuCKdqAZVDC9RThGCg84C3ocbG7sNBzB2moOueqmuc1hLReelQztARLXr8YgRMBfVbvrC6ymtufWEa5SxmQkq4rucn0u00TcE0x81YRQbviYMZJYQvcAHcIjjaZMLFFkq4qYzRlqQQtfCZpnGAHIAqNVoo7yaQWp75Nf1oHeihZxRa7TiqTbjuI6OGTOeSOhMbjbvT4TsqyluFfLPeWszQEsOg9tovRjThdNOGJVC0/pWwDus7rTxPfG9aoRfl+2064WVHW7o32SXamUja/d1HMnoUgEcsYlIkqBz2OobTs4vXMDsejlnUex4/IblHr89/ePXr5aswIaF1tcEOh+PhOCxFtPMlVz1O/VX59sO2XDdSf8NavXmcaX0wMpKL0Bo1M2zd1tyw3qZ90l+q30as0M4TyHJJyffWytWKjn+vwphxcxuxGbeC5Au9TyocfU67nflHNf32t2b9/gw+sp/fKXnbayhqNGZcVmG+jtgdLrZ+EVjd0h6nbjhItBriNEnQ+B7ug851o/07e3XFwlhWbDY6d6HRaT4Q9Z1ybXZAtQD0l9qxnQjLZd1ErVYdfH31UYxGwRaajHS7Wq3+D90I7A8=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},h=void 0,g={},j=[];function b(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/document/{document_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,a.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(y.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(l(),{...n(42959)}),"\n",(0,a.jsx)(c(),{...n(58309)}),"\n",(0,a.jsx)(d(),{...n(85547)})]})}function w(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}},42959(e){e.exports=JSON.parse('{"parameters":[{"name":"document_id","in":"path","description":"objectId of Document","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"string","example":"pH1bhc2hpb"}}]}')},58309(e){e.exports={title:"Body"}},85547(e){e.exports=JSON.parse('{"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":true},"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":true},"redirect_url":{"type":"string","format":"string","example":""},"allow_modifications":{"type":"boolean","example":false},"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":false},"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"}}}}}}')}}]);
Reference in New Issue View Git Blame Copy Permalink