WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 12:34:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
02c0faacf63240299d33e664cdc0dbd4f8457459
OpenSign/assets/js/f0ff4a36.2cd591b0.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:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>j,toc:()=>y});var i=a(85893),l=a(11151),n=a(58219),t=(a(62316),a(51039)),r=a.n(t),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),u=a(85162);const h={id:"getdocument",title:"Get document by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMtJ2mLCMCxY0sxrkRSLiwFLjICSzhYbimRJyolh6NueZI+2JxmOkhw5TrYZ2PolsY53v/v/Zw2eLxwk13Cqs6pE5R3MIsjRZVYYL7SCBKYFsnP0rGNhJx8nDBVPJTq20hXzmln0VuASWY6eC+kYT3XlGWfOYCbmImN5Kz2ECLRBywl9kkMCC/TdI0RguOUlerRk1hoULxES6BhuRQ4RCDLLcF/AU1t1+hkzP8mZnrNMK88zwrT4pRIWc0i8rTAC51eSUJ0ojUSIAB+M1DlCMufSEUNWYMkhWYNfmcDprVALiGCubcl9n4IPPKAkYH4ap0V2WJgU6npGap3RyqEjoMM4pn/b5roqy9C5eSXZJiYQAVlO0UjWwI2RIgsPo8+OhNa71jVeU/AswXjRqOyCsa8f787F3eFRWnz6GeoIpsITdT8IF35Q0gniQvu9EYxE7pA5sVCb2iGsd1rmaPdFuzSorsRC/fn7H+zUiiUGKLG/Y4X3xiWjUUuprBxmuiS0y3u1v12fNbIUgzVkXqj6DQK3lq+o3D2W7p/TfRFaZVf/ljao6wh8k1LwWBrJPd52uukxs8g95if+77EO48OjwTgexG+n4zfJ8bfJ6zfDOI5/gwgeSkmyXetyH/zrlHbflcm/gp56h61XSxvWDa0mgeP4eLdVN9NPac/mulL5N/9dp6K1+tnaeYzDc/r7uRRKCoW33cy5PY6Pb482Dr3edWiillyKPEzzqb5D9XX96av3jfrdZImGKbzDlrN9euOkw6yywq/C2ngYcCMGzXtyPaNpXKIvdLtvwp7xBSQw6nI/Wvd2TA2EZ5fdFqqs7PW+83wh1GLAjRlqg4pmlOSpo0kw4kaMlmMgjZ1FVxS1JjBbdj02uhHvkTq9dbvP1W67AjmNPXJUqLkOwm0wutkWQrkc7+zEaSEcEy48dz6GtLK5tuyJNEu5w5xpxXyB4ZHoR8PxZpMH0SG7UTfqSpfIKoe0v6RQdy65UQN2fTmfi0xwyX7F1AmPs1dd5O7v73cidhBkzoUvqpRZNPqRfRGIIax9qc3HAUTg0Zbucn6FdimybkK/oGoUmEdtndNtQLVackHZbUk/PBWiupMiQ+WwV5kn5x8/sKNhDFGvOP6FyaMPkx/PLq7OCJXKq0nReBgPYyIZ7XzJVU8RXV5d1li6YpPTpwleP3bt/3CrtSXq8cGPjOQi9GFwed320DX0zrekf6nNIii088SyXlNhfbKyron8pUJLnTqLYMmtIPtCo+XC0e98c4m96OmrX9qj7oA9f/Q9a3jXcIq6bcllRV8QwR2unlyZ9ayOuq4jyxqOkyxD43uyO1Nya9Scn00hAl5RmPrdfhe6vf1B6M/atT0GGgPobx29IPAdZfs9rr7fsDcvLwq0/nXcFKNZXdd/AasIG6U=",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:"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 by ID",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vu9u2zYQfxXuPjWAbMtJ2mLCMCxY0sxrkRSLiwFLjICSzhYbimRJyolh6NueZI+2JxmOkhw5TrYZ2PolsY53v/v/Zw2eLxwk13Cqs6pE5R3MIsjRZVYYL7SCBKYFsnP0rGNhJx8nDBVPJTq20hXzmln0VuASWY6eC+kYT3XlGWfOYCbmImN5Kz2ECLRBywl9kkMCC/TdI0RguOUlerRk1hoULxES6BhuRQ4RCDLLcF/AU1t1+hkzP8mZnrNMK88zwrT4pRIWc0i8rTAC51eSUJ0ojUSIAB+M1DlCMufSEUNWYMkhWYNfmcDprVALiGCubcl9n4IPPKAkYH4ap0V2WJgU6npGap3RyqEjoMM4pn/b5roqy9C5eSXZJiYQAVlO0UjWwI2RIgsPo8+OhNa71jVeU/AswXjRqOyCsa8f787F3eFRWnz6GeoIpsITdT8IF35Q0gniQvu9EYxE7pA5sVCb2iGsd1rmaPdFuzSorsRC/fn7H+zUiiUGKLG/Y4X3xiWjUUuprBxmuiS0y3u1v12fNbIUgzVkXqj6DQK3lq+o3D2W7p/TfRFaZVf/ljao6wh8k1LwWBrJPd52uukxs8g95if+77EO48OjwTgexG+n4zfJ8bfJ6zfDOI5/gwgeSkmyXetyH/zrlHbflcm/gp56h61XSxvWDa0mgeP4eLdVN9NPac/mulL5N/9dp6K1+tnaeYzDc/r7uRRKCoW33cy5PY6Pb482Dr3edWiillyKPEzzqb5D9XX96av3jfrdZImGKbzDlrN9euOkw6yywq/C2ngYcCMGzXtyPaNpXKIvdLtvwp7xBSQw6nI/Wvd2TA2EZ5fdFqqs7PW+83wh1GLAjRlqg4pmlOSpo0kw4kaMlmMgjZ1FVxS1JjBbdj02uhHvkTq9dbvP1W67AjmNPXJUqLkOwm0wutkWQrkc7+zEaSEcEy48dz6GtLK5tuyJNEu5w5xpxXyB4ZHoR8PxZpMH0SG7UTfqSpfIKoe0v6RQdy65UQN2fTmfi0xwyX7F1AmPs1dd5O7v73cidhBkzoUvqpRZNPqRfRGIIax9qc3HAUTg0Zbucn6FdimybkK/oGoUmEdtndNtQLVackHZbUk/PBWiupMiQ+WwV5kn5x8/sKNhDFGvOP6FyaMPkx/PLq7OCJXKq0nReBgPYyIZ7XzJVU8RXV5d1li6YpPTpwleP3bt/3CrtSXq8cGPjOQi9GFwed320DX0zrekf6nNIii088SyXlNhfbKyron8pUJLnTqLYMmtIPtCo+XC0e98c4m96OmrX9qj7oA9f/Q9a3jXcIq6bcllRV8QwR2unlyZ9ayOuq4jyxqOkyxD43uyO1Nya9Scn00hAl5RmPrdfhe6vf1B6M/atT0GGgPobx29IPAdZfs9rr7fsDcvLwq0/nXcFKNZXdd/AasIG6U=",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 by template_id",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update document by ID",permalink:"/docs/API-docs/update-document"}},f={},y=[{value:"Request",id:"request",level:2}];function g(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(s.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.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,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(u.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.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,i.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,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.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,i.jsxs)(u.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(u.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink