WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-29 04:54:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3c61c034f5dfa5294e91d7aba24865512b5b02db
OpenSign/assets/js/f0ff4a36.1b07ddca.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var n=s(85893),l=s(11151),t=s(58219),i=(s(62316),s(51039)),r=s.n(i),d=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(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/ZXtPMUALVG2k6BEUdSoHVdNYAeVgwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiO7hQcZGjdBbGASRoYyO0E0pCBFfoGGdJwwABKI2G0+MwgQhm6Dpvmhueo0NDWkuQPEeIYHHMtTh26gklBCBIa4o8QQMBGPxcCIMJRM4UGIB1y4xkrMh1hhAALnSmEoRoyjNLDHGKOYeoBLfUntMZIWdQESv3QhFhlFbMZG+xWCygClZQWqwPImmhaO5S2PZaTR4xdsOEqSmLlXQ8dl8TbABTZXLuupQ1ev3LYJLGJ6meQFWNyazVSlq0pOgkDOnfJlxbxDFaOy0ytkoPBEDIKTFRCVzrTMT+of9oSajcRVd7TXk0pMaJ2mQbjEP9eHclnk5OJ+mnXyk7t8IR9TAV1v+g8iMV18odrEFnyC0yqoZ1FVcBvFMZVeCB2m40ypGYyb///ItdGDFHr0oc7ljqnLZRv99QCpP1YpWTtptneTiuR4Vsgh4NwfMNuNLAjeFLKneHuf1yuq99q+za37AGVRWAq1O67qrWNj3GBrnD5Nz9u66T8OT0eBAeh29vB2+is++j1296YRj+AQEs8oxk29blzvu3Mtp8Fzr5BnaqHbZOLW3HAaqKBM7Cs91WbUctk8qxqSpk8t3X61Q0Ru2tnXUc9tnv5lLITEh8aGfOw1l49nC6cuj1rkNDOeeZSNj5xyG7pRn/bf3pmne1+d1kiZqpXkEbznbptZMW48IIt/QbrLu6orsxTeMcXaqa1edXnkshgn6b+37Z2TEVkD4zbxdiYbJO73Ote+2myvjE0gTocy368wGQpRbJiKJVB2QDz7rBtXiP1OFfXLjkoJBT5YWbILQzzYdwPtjZhbepsExY/9z65tPJpsqwLWk24RYTpiRzKfpHop/2BsxqjMW0qYQeu5f3cqRyZIVF2luZkE82upfH7O5mOhWx4Bn7HSdWOBy/aiP2/Py8E7EjL3MlXFpMmEGt1uwzT/Rh7UqtPo4gAIcmtzfTEZq5iNvJ/IKpvmfuN/VNNwHVaM4FZbUh/bQtRPWWiRilxU5Fnl99/MBOeyEEnaL4D5D7H4Y/X16PLkkrlVWdokEv7IVE0sq6nMuOIbrf2qyxyZINL7YTXK67dffaayrM4cL1dcaFbx+PuGxK/w467FH3wBoHkCrriKUsqS4+mayqiPy5QEMNNg5gzo3gEyrEuxISYel3sjqgXgT66rfmFjti+2+1vcDbfpHULHOeFfQFATzhcus4rMZV0DbN/0b2Eoza3GaXrtDQtVoznMcxatd52xmlG/Po6vIWAuAFJaU7Gp78aGh+kC97o7CJpgZAfwnOXoEfqLHf4/LHFXv98qLA6uavuSkU46qq/gFblj3m",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/ZXtPMUALVG2k6BEUdSoHVdNYAeVgwK1BWNFjsS1yd3N7lKWQPCtX9JP65cUsyQl6uKmKoK82OLsXM7cpwTHZxaiO7hQcZGjdBbGASRoYyO0E0pCBFfoGGdJwwABKI2G0+MwgQhm6Dpvmhueo0NDWkuQPEeIYHHMtTh26gklBCBIa4o8QQMBGPxcCIMJRM4UGIB1y4xkrMh1hhAALnSmEoRoyjNLDHGKOYeoBLfUntMZIWdQESv3QhFhlFbMZG+xWCygClZQWqwPImmhaO5S2PZaTR4xdsOEqSmLlXQ8dl8TbABTZXLuupQ1ev3LYJLGJ6meQFWNyazVSlq0pOgkDOnfJlxbxDFaOy0ytkoPBEDIKTFRCVzrTMT+of9oSajcRVd7TXk0pMaJ2mQbjEP9eHclnk5OJ+mnXyk7t8IR9TAV1v+g8iMV18odrEFnyC0yqoZ1FVcBvFMZVeCB2m40ypGYyb///ItdGDFHr0oc7ljqnLZRv99QCpP1YpWTtptneTiuR4Vsgh4NwfMNuNLAjeFLKneHuf1yuq99q+za37AGVRWAq1O67qrWNj3GBrnD5Nz9u66T8OT0eBAeh29vB2+is++j1296YRj+AQEs8oxk29blzvu3Mtp8Fzr5BnaqHbZOLW3HAaqKBM7Cs91WbUctk8qxqSpk8t3X61Q0Ru2tnXUc9tnv5lLITEh8aGfOw1l49nC6cuj1rkNDOeeZSNj5xyG7pRn/bf3pmne1+d1kiZqpXkEbznbptZMW48IIt/QbrLu6orsxTeMcXaqa1edXnkshgn6b+37Z2TEVkD4zbxdiYbJO73Ote+2myvjE0gTocy368wGQpRbJiKJVB2QDz7rBtXiP1OFfXLjkoJBT5YWbILQzzYdwPtjZhbepsExY/9z65tPJpsqwLWk24RYTpiRzKfpHop/2BsxqjMW0qYQeu5f3cqRyZIVF2luZkE82upfH7O5mOhWx4Bn7HSdWOBy/aiP2/Py8E7EjL3MlXFpMmEGt1uwzT/Rh7UqtPo4gAIcmtzfTEZq5iNvJ/IKpvmfuN/VNNwHVaM4FZbUh/bQtRPWWiRilxU5Fnl99/MBOeyEEnaL4D5D7H4Y/X16PLkkrlVWdokEv7IVE0sq6nMuOIbrf2qyxyZINL7YTXK67dffaayrM4cL1dcaFbx+PuGxK/w467FH3wBoHkCrriKUsqS4+mayqiPy5QEMNNg5gzo3gEyrEuxISYel3sjqgXgT66rfmFjti+2+1vcDbfpHULHOeFfQFATzhcus4rMZV0DbN/0b2Eoza3GaXrtDQtVoznMcxatd52xmlG/Po6vIWAuAFJaU7Gp78aGh+kC97o7CJpgZAfwnOXoEfqLHf4/LHFXv98qLA6uavuSkU46qq/gFblj3m",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={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(a.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(a.p,{children:"Get a document"}),"\n",(0,n.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(o.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)(s,{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)(a.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(o.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)(t.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(s,{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)(a.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,n.jsx)(c.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)(a.p,{children:"]"})})})]})]})}),(0,n.jsx)(c.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)(c.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)(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,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(c.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)(m.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)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(c.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,n.jsx)(a,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink