WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 17:44:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
4bc4b9804c44889d00ea031d60ffb1f8b5a2c963
OpenSign/assets/js/7ef59f7a.8f6972fe.js
T

1 line
12 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:()=>y,contentTitle:()=>b,default:()=>w,frontMatter:()=>h,metadata:()=>a,toc:()=>f});const a=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":"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxYWk1Ae6pQruSVJ3sS21vc2kXroIOMSlEwqdA1Q5VwkRtoGIQFvgClB5tMYKGnC9JaVFrZpW3vLEQ8EVnyPJjqDvqxSloGwFq+PSeXBalkFjoDcmbTGF1h6FmLrgwzf0kmMRaDXRhbGYU9YsEOalSNFFkOgUoZ7ZyQSVQozOgyFdRIKOhJZK6uQ2xC8rpQSjqYMILulhqa8jsXvLlSNQWOvShqBzmLGaHnmwVnAweO+QAvxWqFs3GQw+qAO46dLqGmMnPE6/aytguVw+yPwX2zxnwv9UxvArGu2E13a14Z4Ln5dxqJa+kO5HLekMFYb06dXCRkaqE/ew+Gh1lKM0o0v0lCFudHpxHpruC/j0+3/gLXKrINfLOlmT0qJcwbw9ijxXR752W9czIdMh8XLyeFInHz3gofOtB69z7j/9/l8Hv+AShGoqikwZDC7KWIoErhqw5QaDCfwYgFgHwBz4nHtIuIIYweWcUmkhOHAwNbcU6nYIp2oFBEyAIEVIBloPfFtmbL3bOIi5wxR0jQc70LfRiNYLh3KBjmTR3RcjYCoIK/rc6nJen9ZXpjHOYiakhOt69iPbTtMUTLPcjITk8J46mFFB+BxXwC2Co1dYuLjHEnZKY7QlLUStfKZplKEAoEqNFsq7CaSWZ34jP9okesC7QqsdS7ULNxg4asR0IakrsbG4Wx1+oJ58r49vt1uLGVo6MJi9iYsRTTrdtGkJlK1/JK3D06NWnie+N2nRhfLDfTnhYkdbuHfZJdqFSNq3x89U9CgQj1jEpEhQOewBhtOzi7ewOB6OCSd3t+Mzinv09vzHN79cvgnTHVpXO+xwOB6Ow4OOdr7gqndS/5n//r223uCoP+GTQHM309PHyEguAjJq5u8a1dyw3leCSf+DwDRiuXaeSNZrKr73VlYVLf9WhhHpZhqxBbeC9AvQJxWO/k679/7PWvrdr82ngxfwmW8LOzVvoYYinLHgNEFNGIvYLa7ufc2oaJZq8AapVlOcJgka3+N9AFy30N/ZmysWRsp8G+fcBpzT/EHSd+q1DYBqBehfQmM7GdbrGkNVVUdfb32WozGwpSYnTauq+j//5iuT","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 i=n(74848),o=n(28453),r=n(57742),s=n.n(r),p=n(78178),m=n.n(p),l=n(19624),d=n.n(l),c=n(96226),u=n.n(c),x=(n(77675),n(19365),n(51107)),g=n(21312);const h={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:"eJy9Wc1uGzkSfpVaXnYitCX5J8msTmPMZj2eDSbG2IGBdQSB3V2tZswmOSRbsiA0MId9gz3tdR8tT7Io9o9atmJbmUwuiUVWFeufX7HXzPO5Y5Mb9nedlAUq79g0Yim6xArjhVZswq5yhDP00JLA6cU5oOKxRAcrXYLXYNFbgQuEFD0X0gGPdemBgzOYiEwkkDbcQxYxbdBykn6esgmbo283WcQMt7xAj5bUWjPFC2QT1hLMRMoiJkgtw33O7uuq44+Y+PMUdNbpyyJm8bdSWEzZxNsSI+b8SpJYJwojkUUM74zUKbJJxqUjgiTHgrPJmvmVCZTeCjVnEcu0Lbjvr+AdD1ImzPx0GOfJUW5iVlVTOtYZrRw6EnQ0HtN/2/q6MknQuayU0DmFRSzRypPmkzXjxkiRhI3RR0dM64fa1WaT9yyJ8aI+0nnuS7evFUIdGKvnFp1jVdS5dF8x/zgTt0fHcf7+Z5KSCVrcT0LuvXGT0ahZKa0cJrogaQnZmJFbvlhoT0RPsBd+fz1d+IMynEQovb9SRiJ3CE7MVVcowWtapmifDvTXiVFda/tJqDWEwFptHLgp2MYESqSl2rLlWfI/aoQYkfjJO6EtdBK4tXxF/cBj4Z72ktW7Y7s5LUH9mCN2qoUFF/JJ6hjxh2ahzTWTa/XEMScvXx0dHn//+pDolyKdo/8D9te7+/nf452P9V3Ql8/77KosYrR99m6lYz+sIna3J8/RyUkVsdWeXK/pqOWeTMffVxHL92Q6eUW5HBr4M3z+JTXV+bzqV5THwkjucXZZ18GszYdHqUJROlTpuXpnt3tJrLVErvpH0+1I7dUi95ie+sez82h8dHxwOD4Yv746fDU5+dvk5avheDz+F4vYXSE31rOU+nS/OTS/S5N+k3NqsHKly+eZbzEVFhM/K+3Own4sdnQcl1IvZ4VO6/vlXqLsODeADmIsU+Fn3m43lD2r/Iv70ULgEndeIV8xFKGJ/7mH7LiFlsLnNRia9X0cSNuCEU9o1SME4UAruQK+4EJSbsEyRwU+x+76JpqmjiCzugAOrYRhSJLS65nFQqgnq7JNj5p6plWCM6FmuEC7s012jGPq2qhmiZb6WRdnY3bVk3HDYlliwNAEvWPJk1s2rSIWJ8mXSiwd2q3si8LS0dbalKJzL94PwskeDXbTQU92Ie9LXaDPhZrDkqK1tFrNI2iAmLcr4HMuFFC87F++HiRHa/VOELRJtP0066e7UFIonLVjx+xkPJ4ddk44eeiEbqRT2kOmS5V+W1N3nf+4QSez486glw8NOlcLLkUaRtQrfYvq29rTP97Xxz/MYlEThX22ZWx/vTbSYVJa4VdhFr474EYc1PuTmylNmJQpuhmiw/DsczZho7YURuve4FwxkmcX7WgdbrduHnJcpbG+G2qDipq05LGjOhxxI0aLwyFB0Ps83Ji96LE82JfFeT4Xav4U33TjqksKZx2xLYdtWpUR/0TqVU08+lTN20KOPAwtFf3OdGBuovTOoCJsFWIcDr//BnGNMtEF0rMIXQiDQcvy6d//67gGg+6mCNk4/KA+qHelBaOXaOk9gKsUMol3gq6X8ORShL3uzcUhLyQ6J1cglMe55R4hFXPhuQyjJLWQhBseCykoiYlME7eFXh24IVzn6HO0tPVXi8AhxYWk1Ae6pQruSVJ3sS21vc2kXroIOMSlEwqdA1Q5VwkRtoGIQFvgClB5tMYKGnC9JaVFrZpW3vLEQ8EVnyPJjqDvqxSloGwFq+PSeXBalkFjoDcmbTGF1h6FmLrgwzf0kmMRaDXRhbGYU9YsEOalSNFFkOgUoZ7ZyQSVQozOgyFdRIKOhJZK6uQ2xC8rpQSjqYMILulhqa8jsXvLlSNQWOvShqBzmLGaHnmwVnAweO+QAvxWqFs3GQw+qAO46dLqGmMnPE6/aytguVw+yPwX2zxnwv9UxvArGu2E13a14Z4Ln5dxqJa+kO5HLekMFYb06dXCRkaqE/ew+Gh1lKM0o0v0lCFudHpxHpruC/j0+3/gLXKrINfLOlmT0qJcwbw9ijxXR752W9czIdMh8XLyeFInHz3gofOtB69z7j/9/l8Hv+AShGoqikwZDC7KWIoErhqw5QaDCfwYgFgHwBz4nHtIuIIYweWcUmkhOHAwNbcU6nYIp2oFBEyAIEVIBloPfFtmbL3bOIi5wxR0jQc70LfRiNYLh3KBjmTR3RcjYCoIK/rc6nJen9ZXpjHOYiakhOt69iPbTtMUTLPcjITk8J46mFFB+BxXwC2Co1dYuLjHEnZKY7QlLUStfKZplKEAoEqNFsq7CaSWZ34jP9okesC7QqsdS7ULNxg4asR0IakrsbG4Wx1+oJ58r49vt1uLGVo6MJi9iYsRTTrdtGkJlK1/JK3D06NWnie+N2nRhfLDfTnhYkdbuHfZJdqFSNq3x89U9CgQj1jEpEhQOewBhtOzi7ewOB6OCSd3t+Mzinv09vzHN79cvgnTHVpXO+xwOB6Ow4OOdr7gqndS/5n//r223uCoP+GTQHM309PHyEguAjJq5u8a1dyw3leCSf+DwDRiuXaeSNZrKr73VlYVLf9WhhHpZhqxBbeC9AvQJxWO/k679/7PWvrdr82ngxfwmW8LOzVvoYYinLHgNEFNGIvYLa7ufc2oaJZq8AapVlOcJgka3+N9AFy30N/ZmysWRsp8G+fcBpzT/EHSd+q1DYBqBehfQmM7GdbrGkNVVUdfb32WozGwpSYnTauq+j//5iuT",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1.1/opensign-api-v-1-1",custom_edit_url:null},b=void 0,y={},f=[];function J(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(x.default,{as:"h1",className:"openapi__heading",children:"Get Document"}),"\n",(0,i.jsx)(s(),{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)(x.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,i.jsx)(g.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,i.jsx)(m(),{...n(42959)}),"\n",(0,i.jsx)(d(),{...n(58309)}),"\n",(0,i.jsx)(u(),{...n(85547)})]})}function w(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(J,{...e})}):J(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},"pen_colors":{"type":"array","items":{"type":"string"},"example":["blue","red","black"]},"bcc":{"type":"array","items":{"type":"string"},"example":["user@example.com","user2@example.com"]}},"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