WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-26 11:34:52 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1beb63cac7a5e7a2d2d3409164b7eb2a6faade0e
OpenSign/assets/js/f0ff4a36.37f7ec3b.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:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),t=(a(62316),a(51039)),r=a.n(t),d=(a(82723),a(9487)),m=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={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:"eJy9Vttu20YQ/ZXtPMUAJVG2k6BEUdSoHVdNYAe1gwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiOzhXcZGjdBbGASRoYyO0E0pCBJfoGGdJwwABKI2G0+MogQhm6Dpvmhueo0NDWkuQPEeIYNHjWvScekIJAQjSmiJP0EAABj8XwmACkTMFBmDdMiMZK3KdIQSAC52pBCGa8swSQ5xiziEqwS2153RGyBlUxMq9UEQYpRUz2V8sFguoghWUFuuDSFoomrsUtr1Wk0eM3ShhaspiJR2P3dcEG8BUmZy7LmWNXv8ynKTxcaonUFVjMmu1khYtKToOQ/q3CdcWcYzWTouMrdIDARBySkxUAtc6E7F/GDxaEip30dVeUx4NqXGiNtkG41A/3l2Kp+OTSfrpV8rOrXBEPUyF9T+o/EjFlXIHa9AZcouMqmFdxVUA71RGFXigtmuN8kbM5N9//sXOjZijVyUOdyx1TttoMGgohcn6scpJ2/WzPBzXo0I2QY+G4PkGXGngxvAllbvD3H453Ve+VXbtb1iDqgrA1Sldd1Vrmx5jg9xhcub+XddxeHzSG4a98O3t8E10+n30+k0/DMM/IIBFnpFs27rcef9WRpvvQiffwE61w9appe04QFWRwGl4utuq7ahlUjk2VYVMvvt6nYrGqL21s47DPvvdXAqZCYkP7cx5OA1PH05WDr3edWgk5zwTCTv7OGK3NOO/rT9d8642v5ssUTPVK2jD2S69dtJiXBjhln6DdVdXdDemaZyjS1Wz+vzKcylEMGhzPyg7O6YC0mfm7UIsTNbpfev4TMhZj2vdbzdWxieWJsGAazGYD4EstohuKGp1YDZwrRtdi/dInf7FxUuOCjlVXrgJRjvbfCjnw52deJsKy4T1z62PPq1sqgzbkmYTbjFhSjKXon8k+kl/yKzGWEybiuize3kvb1SOrLBI+ysT8slG97LH7q6nUxELnrHfcWKFw/GrNnLPz887ETvyMpfCpcWEGdRqzT7zRB/WrtTq4wgCcGhyez29QTMXcTuhXzA18MyDps7pNqBazbmg7Dakn7aFqO4yEaO02KnMs8uPH9hJP4SgUxz/AfLgw+jni6ubC9JK5VWnaNgP+yGRtLIu57JjiO64NmtssmSj8+0El+uu3b36mgpzuHADnXHh28gjLpsWuIMOe9Q9tMYBpMo6YilLqotPJqsqIn8u0FCjjQOYcyP4hArxroREWPqdrA6pF4G++q25yY7Y/pttL/C2XyQ1y5xnBX1BAE+43DoSq3EVtE3zv5G9BKM2t9mlKzR0tdYMZ3GM2nXedkbqxly6vLiFAHhBSemOhic/Gpof5MveKGyiqQHQX4KzV+AHauz3uPxxxV6/vCiwuv1rbgrFuKqqfwBRxEEA",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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:"eJy9Vttu20YQ/ZXtPMUAJVG2k6BEUdSoHVdNYAe1gwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiOzhXcZGjdBbGASRoYyO0E0pCBJfoGGdJwwABKI2G0+MogQhm6Dpvmhueo0NDWkuQPEeIYNHjWvScekIJAQjSmiJP0EAABj8XwmACkTMFBmDdMiMZK3KdIQSAC52pBCGa8swSQ5xiziEqwS2153RGyBlUxMq9UEQYpRUz2V8sFguoghWUFuuDSFoomrsUtr1Wk0eM3ShhaspiJR2P3dcEG8BUmZy7LmWNXv8ynKTxcaonUFVjMmu1khYtKToOQ/q3CdcWcYzWTouMrdIDARBySkxUAtc6E7F/GDxaEip30dVeUx4NqXGiNtkG41A/3l2Kp+OTSfrpV8rOrXBEPUyF9T+o/EjFlXIHa9AZcouMqmFdxVUA71RGFXigtmuN8kbM5N9//sXOjZijVyUOdyx1TttoMGgohcn6scpJ2/WzPBzXo0I2QY+G4PkGXGngxvAllbvD3H453Ve+VXbtb1iDqgrA1Sldd1Vrmx5jg9xhcub+XddxeHzSG4a98O3t8E10+n30+k0/DMM/IIBFnpFs27rcef9WRpvvQiffwE61w9appe04QFWRwGl4utuq7ahlUjk2VYVMvvt6nYrGqL21s47DPvvdXAqZCYkP7cx5OA1PH05WDr3edWgk5zwTCTv7OGK3NOO/rT9d8642v5ssUTPVK2jD2S69dtJiXBjhln6DdVdXdDemaZyjS1Wz+vzKcylEMGhzPyg7O6YC0mfm7UIsTNbpfev4TMhZj2vdbzdWxieWJsGAazGYD4EstohuKGp1YDZwrRtdi/dInf7FxUuOCjlVXrgJRjvbfCjnw52deJsKy4T1z62PPq1sqgzbkmYTbjFhSjKXon8k+kl/yKzGWEybiuize3kvb1SOrLBI+ysT8slG97LH7q6nUxELnrHfcWKFw/GrNnLPz887ETvyMpfCpcWEGdRqzT7zRB/WrtTq4wgCcGhyez29QTMXcTuhXzA18MyDps7pNqBazbmg7Dakn7aFqO4yEaO02KnMs8uPH9hJP4SgUxz/AfLgw+jni6ubC9JK5VWnaNgP+yGRtLIu57JjiO64NmtssmSj8+0El+uu3b36mgpzuHADnXHh28gjLpsWuIMOe9Q9tMYBpMo6YilLqotPJqsqIn8u0FCjjQOYcyP4hArxroREWPqdrA6pF4G++q25yY7Y/pttL/C2XyQ1y5xnBX1BAE+43DoSq3EVtE3zv5G9BKM2t9mlKzR0tdYMZ3GM2nXedkbqxly6vLiFAHhBSemOhic/Gpof5MveKGyiqQHQX4KzV+AHauz3uPxxxV6/vCiwuv1rbgrFuKqqfwBRxEEA",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:"Update document by ID",permalink:"/docs/API-docs/update-document"}},g={},y=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,i.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)(r(),{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)(m.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)(m.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)(l.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)(d.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:"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)(o.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,n.jsx)(o.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,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\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 "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\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)(d.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",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 "error": "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)(d.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",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 "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink