WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-02 23:38:43 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/f0ff4a36.a5657d8a.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),c=s(41429),m=s(5397),o=s(4667),p=s(9472),h=s(85162);const u={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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",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",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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",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"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Document"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.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,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.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,t.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,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.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,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink