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

1 line
9.5 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:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var n=a(85893),i=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),d=(a(82723),a(9487)),c=a(41429),o=a(5397),m=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:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2WgV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfouPG8DXlxWFpB/I2G1RfQ+6daKH0STr2fh9uxNP5RZx//Z2qdi8cSY9zYf0DtSW5uFXuaA+6QG6RUZdsu7sJ4IMqqDOP9HanUU7FQn7/6292ZcQSvStx/MVy57SNwrCTVKYYJaokb3fP8nhcjwpZjB4NwfOD+aPlvvUjdBh/Jxo0TQCuLel22vrYDZ2uyoLc7E0kvGBH+mTxbvzusOd7zmJSOZapSqZvwOv+dKg7kUteiJRdfp6we+KhNx6nxaQywq09WQ1ZKprNafBKdLnqWM6zm8shgrCHF9YDOmmA/Jllz32VKQbl5FqPelIqeGypqCHXIlyeAUXqkUxpJNt07+DZ1kyLj0hF+1dupQsKmSlv3CW2b1OfiOXZAe3d58IyYf1xfzfPGSxThu1Zs5hbTJmSzOXoD0l+MTpjVmMiso5uRuxBPsipKpFVFomiCiGfbPQgT9nsLstEInjB/sDYCofzt33Gnp+fDzJ24m1uhMurmBnUaqu+8EKf1qHV5uUEAnBoSnuXTdEsRdIP2yuhQq8cdiRK9B/VgCUXVNVO9Mu+EfVfIRKUFgcdfnnz+RO7GI0hGDTFf4Acfpr8en07vSav1FZtic5G49GYRFpZV3I5CESruq8ai9dscrVf4Hq7Eg4Xe9dhDlcu1AUXkqJ4xHXX+jMYqEfDXToPIFfWkUpdU198NUXTkPhbhYYGbB7AkhvBY2rEWQ2psPScbnblq0DffunW7gl7eS2/CLyfF0nDsuRFRW8QwBOu974DmnkT9EPzw8heg9GG253SDRr6MGkVLpMEtRucHezrHT66ub6HAHhFRRlSw5Onhu6B7vJiFnbRtADol+C8aPCeBvsjrn/eqLcnrxpsPu9abUrFvGmafwAgCI4b",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJytVs1u20YQfpXNnGKAFmU7vRBBUaN2XDWBHUQOepCFYkkOxbXJ3c3uUpZA8NYn6aPlSYpZkhIl2WgV9CKRs/Pz7fx8wxocX1iIZnClkqpE6SzMA0jRJkZoJ5SECG7QMc7STgECUBoNp8NJChEs0A3ONDe8RIeGvNYgeYkQweqUa3Hq1BNKCECQ1xx5igYCMPitEgZTiJypMADr1gXZWFHqAiEAXOlCpQhRxgtLCkmOJYeoBrfWXtMZIRfQkCr3RhFhlFYs5Gi1Wq2gCTZQeqx/irSHornLYf/WKn7ExE1SpjKWKOl44v5PsAFkypTcDSVb9Pq3szhPznMdQ9PMKazVSlq05Oh8PKa/Xbi2ShK0NqsKtikPBEDIqTBRDVzrQiT+IHy0ZFQfouPG8DXlxWFpB/I2G1RfQ+6daKH0STr2fh9uxNP5RZx//Z2qdi8cSY9zYf0DtSW5uFXuaA+6QG6RUZdsu7sJ4IMqqDOP9HanUU7FQn7/6292ZcQSvStx/MVy57SNwrCTVKYYJaokb3fP8nhcjwpZjB4NwfOD+aPlvvUjdBh/Jxo0TQCuLel22vrYDZ2uyoLc7E0kvGBH+mTxbvzusOd7zmJSOZapSqZvwOv+dKg7kUteiJRdfp6we+KhNx6nxaQywq09WQ1ZKprNafBKdLnqWM6zm8shgrCHF9YDOmmA/Jllz32VKQbl5FqPelIqeGypqCHXIlyeAUXqkUxpJNt07+DZ1kyLj0hF+1dupQsKmSlv3CW2b1OfiOXZAe3d58IyYf1xfzfPGSxThu1Zs5hbTJmSzOXoD0l+MTpjVmMiso5uRuxBPsipKpFVFomiCiGfbPQgT9nsLstEInjB/sDYCofzt33Gnp+fDzJ24m1uhMurmBnUaqu+8EKf1qHV5uUEAnBoSnuXTdEsRdIP2yuhQq8cdiRK9B/VgCUXVNVO9Mu+EfVfIRKUFgcdfnnz+RO7GI0hGDTFf4Acfpr8en07vSav1FZtic5G49GYRFpZV3I5CESruq8ai9dscrVf4Hq7Eg4Xe9dhDlcu1AUXkqJ4xHXX+jMYqEfDXToPIFfWkUpdU198NUXTkPhbhYYGbB7AkhvBY2rEWQ2psPScbnblq0DffunW7gl7eS2/CLyfF0nDsuRFRW8QwBOu974DmnkT9EPzw8heg9GG253SDRr6MGkVLpMEtRucHezrHT66ub6HAHhFRRlSw5Onhu6B7vJiFnbRtADol+C8aPCeBvsjrn/eqLcnrxpsPu9abUrFvGmafwAgCI4b",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"}},j={},g=[{value:"Request",id:"request",level:2}];function b(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)(c.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)(c.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)(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)("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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(m.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)(m.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)("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)(o.Z,{responseExample:'[\n {\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",{})]}),(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",{})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.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