WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-01 04:38:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/f0ff4a36.5ab2b8c7.js
T

1 line
12 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:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",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 by ID",description:"Get a 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 by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",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",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink