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

1 line
14 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=a(4667),p=a(9472),h=a(85162);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:"eJy9V21v2zYQ/ivcfWoA2ZYdJ92EYWiwZVnaYimWFAOWGAEtnS0mEsmSlB3D0H8fjpJs+SVJDWz5YkvkvT0P746nJTg+tRDdwm8qLnKUzsIogARtbIR2QkmI4CZFdoGONSLs7MslQ8nHGVq2UAVzihl0RuAMWYKOi8wyPlaFY5xZjbGYiJgltXYXAlAaDSfrlwlEMEXXbEIAmhueo0NDYS1B8hwhgkbgXiQQgKCwNHcpbMeqxg8Yu8uEqckqXgjA4LdCGEwgcqbAAKxbZGTWilxnCAHgk85UghBNeGZJIE4x5xAtwS20l3RGyCkEMFEm5669gk/cW4lA/9Efp/Eg1WMoyxG5tVpJi5YMDcKQ/jbjtUUco7WTImMrUiCAWElHkUdL4FpnIvYbvQdLSsvd6CrYxJ4hM05ULhs2DsXx+4V4HByP068foQxgImjxMAupc9pGvV69UpisG6ucrDnhDjdn/QPlEJmQyh1sQWfILTIrpnKVih6cyhI0b0Vllc2HWagiZF61XBO4LokaQhmAmssNLN9l/0EhGyOSPrHjC29lgRvDF1RxDnP7OkvP4dvrDXMuslelx4gf6oUmhXSq5Ctuhieng/7xj+/7G5Q5zHXGHd5f10BpMzbIHSZn7mWLg3Bw3OmHnfD9Tf80Gv4UnZx2wzD8BwJ4yrM1eEi4Q2ifU/1e6OQN/JQ7Yq1k304dKEtSGO7rTNcqR5cKOWVz6vlzo+Q0YHUZObNgfMqFZESn+eG/a1lojNqbwmuGDousff5CZkLifdOW74dheN9fkTDcJWF15Unl2EQVMnlbqPv8vwxoeH+8AnSyC+hSzngmEn+F36hHlG+Lp+3eVe53M1ZUQn4fNsC21yuQFuPCCLfws8JTh2vRqfaj2xHdwJQpqh4y/HDhUoig1xRAb9kaLEoge2bWjB6FyVo3Gde6qzRK6pEZH1tqRj2uRW/WhzLYlraOT4Wcdl7UGq3jvyaOKxo3UKwbsRafkDpxTVJbqh6IUuT+HijpfaK8ck3dlUZJPc8TP+vvjE03qbBMWL/dMOKTgE2UYVvabMwtJkxJ5lL0m7R+3O2vhj2v2mV38k5SsbLCIk04mZCPNrqTHXZ7NZmIWPCM/Y1jKxyO3jXMzefzHcaOvM6FcGkxZga1WotP/aKnta21ejmCABya3F5NrtHMRNxMJ8+46nnhXl0VPPZVUd9UzdKHbSXK0kzEKC228vjs4stnNmPH3RCCVnp8R9C9z5e/nv95fU52KR2rQ+p3w27o7z9lXc5ly1V7PN8+3OW6vv+HUb5OT4dPrqczLnzFerDLutpuoTXdR+1BfhRAqqwjkeWSkuqrycqSlr8VaKimRwHMuBEUny/JRFh6TlZz+rNI3/1Vj/xH7Jlvgr2RN9UmqdRmPCvoDQJ4xMXWV0g5KoOm5Ci0SuIsjlG7lu5OQ93oShfnNxAAL4indqk/+lKvH8j63rg2e0AVAP1SO9qr8DMd9ydc/LISr3aeVajxNdLE0agsy38BH6HWbA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJy9V21v2zYQ/ivcfWoA2ZYdJ92EYWiwZVnaYimWFAOWGAEtnS0mEsmSlB3D0H8fjpJs+SVJDWz5YkvkvT0P746nJTg+tRDdwm8qLnKUzsIogARtbIR2QkmI4CZFdoGONSLs7MslQ8nHGVq2UAVzihl0RuAMWYKOi8wyPlaFY5xZjbGYiJgltXYXAlAaDSfrlwlEMEXXbEIAmhueo0NDYS1B8hwhgkbgXiQQgKCwNHcpbMeqxg8Yu8uEqckqXgjA4LdCGEwgcqbAAKxbZGTWilxnCAHgk85UghBNeGZJIE4x5xAtwS20l3RGyCkEMFEm5669gk/cW4lA/9Efp/Eg1WMoyxG5tVpJi5YMDcKQ/jbjtUUco7WTImMrUiCAWElHkUdL4FpnIvYbvQdLSsvd6CrYxJ4hM05ULhs2DsXx+4V4HByP068foQxgImjxMAupc9pGvV69UpisG6ucrDnhDjdn/QPlEJmQyh1sQWfILTIrpnKVih6cyhI0b0Vllc2HWagiZF61XBO4LokaQhmAmssNLN9l/0EhGyOSPrHjC29lgRvDF1RxDnP7OkvP4dvrDXMuslelx4gf6oUmhXSq5Ctuhieng/7xj+/7G5Q5zHXGHd5f10BpMzbIHSZn7mWLg3Bw3OmHnfD9Tf80Gv4UnZx2wzD8BwJ4yrM1eEi4Q2ifU/1e6OQN/JQ7Yq1k304dKEtSGO7rTNcqR5cKOWVz6vlzo+Q0YHUZObNgfMqFZESn+eG/a1lojNqbwmuGDousff5CZkLifdOW74dheN9fkTDcJWF15Unl2EQVMnlbqPv8vwxoeH+8AnSyC+hSzngmEn+F36hHlG+Lp+3eVe53M1ZUQn4fNsC21yuQFuPCCLfws8JTh2vRqfaj2xHdwJQpqh4y/HDhUoig1xRAb9kaLEoge2bWjB6FyVo3Gde6qzRK6pEZH1tqRj2uRW/WhzLYlraOT4Wcdl7UGq3jvyaOKxo3UKwbsRafkDpxTVJbqh6IUuT+HijpfaK8ck3dlUZJPc8TP+vvjE03qbBMWL/dMOKTgE2UYVvabMwtJkxJ5lL0m7R+3O2vhj2v2mV38k5SsbLCIk04mZCPNrqTHXZ7NZmIWPCM/Y1jKxyO3jXMzefzHcaOvM6FcGkxZga1WotP/aKnta21ejmCABya3F5NrtHMRNxMJ8+46nnhXl0VPPZVUd9UzdKHbSXK0kzEKC228vjs4stnNmPH3RCCVnp8R9C9z5e/nv95fU52KR2rQ+p3w27o7z9lXc5ly1V7PN8+3OW6vv+HUb5OT4dPrqczLnzFerDLutpuoTXdR+1BfhRAqqwjkeWSkuqrycqSlr8VaKimRwHMuBEUny/JRFh6TlZz+rNI3/1Vj/xH7Jlvgr2RN9UmqdRmPCvoDQJ4xMXWV0g5KoOm5Ci0SuIsjlG7lu5OQ93oShfnNxAAL4indqk/+lKvH8j63rg2e0AVAP1SO9qr8DMd9ydc/LISr3aeVajxNdLE0agsy38BH6HWbA==",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"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Document"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink