WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
5a1a90a3cbb70a5b0ecc1175f542fbd3cfd8af59
OpenSign/assets/js/f0ff4a36.d8bbcdae.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:()=>b,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),o=(s(82723),s(9487)),d=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(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:"eJy9V+tu2zYUfhXu/GoAxZaTtMOEYViwpJnXIikWFwOWGAElHVtMJJIlKceGoX97kj3anmQ4lCXLl6zz0PWPLZHn8p370RIcn1qI7uBCJWWB0lkYB5CiTYzQTigJEYwyZFfoWEPCzj8MGUoe52jZQpXMKWbQGYEzZCk6LnLLeKxKxzizGhMxEQlLV9w9CEBpNJykD1OIYIquuYQANDe8QIeGYC1B8gIhgvkx1+LYqSeUEIAgWBnyFA0EYPBTKQymEDlTYgDWLXLisaLQOUIAONe5ShGiCc8tESQZFhyiJbiF9pTOCDmFiki5Z4oIo7RiKnvz+XwOVdBCabA+iLSBornLYNttKn7ExA1TpiYsUdLxxH1JsAFMlCm4656s0eufB3GWnGQ6hqoak1qrlbRoSdBJGNLfJlxbJglaOylz1oYHAiDkFJhoCVzrXCT+ov9oiWm5i662muJoSIwTtcrGGYfa8fZKPJ2cxtnHXyg6I+Ho9DAR1j9Q/pGIa+UOlqBz5BYZZUObxiTrrcopAw+UdqNR3oqp/OuPP9mFETP0osThhmXOaRv1+6uT0uS9RBUk7eZZHo7rUSGL0aMheL4AWwncGL6gdHdY2M+H+9qXyq7+DW1QVQG4OqTrqmp002VikDtMz90/yzoJT06PB+Fx+O1o8CY6+y56/aYXhuHvEMC8yIm3KV3uvH2t0tV7qdOvoKfaIevk0rYfoKqI4Sw82y3VthFL5dhElTL95stVKhqj9ubO2g/79HdjKWQuJD40PefhLDx7OG0Ner1r0FDOeC5SP1hG1OO/rj1d9a5WvxssURPVI2jD2O55baTFpDTCLfwE646u6G5M3bhAl6nV6PMjz2UQQb+JfX/ZmTEVkDwzawZiafJO7VvHp0JOj7nWvWZi5Ty21An6XIv+bACksUF0S16rHbOBa13oWrxDqvTPDl4yVMiJ8swrZzS9zbtyNtiZiaNMWCasv25s9GFlE2XYFjeLucWUKclchv6Szk97g3ap8Kw9di/v5a0qkJUWaX7lQj7Z6F4es7ubyUQkgufsN4ytcDh+1Xju+fl5x2NHnudKuKyMmUGt1uRTf+jd2uVqX44gAIemsDeTWzQzkTQd+gVVfU/cX+U57QaUqwUXFN3V0Y/bTJR3uUhQWuxk5vnVh/fstBdC0EmOfwG5/3740+X17SVJpfSqQzTohb2QjrSyruCyo4iWwCZqLF6w4cV2gJfrqv0f1sZVijqcu77OufB16E1ermroDjqbZNTd1MYBZMo6IlkuKbE+mryq6PhTiYYqdRzAjBtB+HyhpcLSc9puYi9a+urX1VJ3xPYvfXuBNwUnqdpmPC/pDQJ4wsXWllmNq6Cpuv+M7CUYtbrNMm/R0NpbE5wnCWrXudvpyRuN7epyBAHwkoLS7S1PvresHsiWvV7YRFMDoF+Cs5fhe8qtd7j4oSWvb15kaD8eampyxbiqqr8BSkpv3g==",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:"eJy9V+tu2zYUfhXu/GoAxZaTtMOEYViwpJnXIikWFwOWGAElHVtMJJIlKceGoX97kj3anmQ4lCXLl6zz0PWPLZHn8p370RIcn1qI7uBCJWWB0lkYB5CiTYzQTigJEYwyZFfoWEPCzj8MGUoe52jZQpXMKWbQGYEzZCk6LnLLeKxKxzizGhMxEQlLV9w9CEBpNJykD1OIYIquuYQANDe8QIeGYC1B8gIhgvkx1+LYqSeUEIAgWBnyFA0EYPBTKQymEDlTYgDWLXLisaLQOUIAONe5ShGiCc8tESQZFhyiJbiF9pTOCDmFiki5Z4oIo7RiKnvz+XwOVdBCabA+iLSBornLYNttKn7ExA1TpiYsUdLxxH1JsAFMlCm4656s0eufB3GWnGQ6hqoak1qrlbRoSdBJGNLfJlxbJglaOylz1oYHAiDkFJhoCVzrXCT+ov9oiWm5i662muJoSIwTtcrGGYfa8fZKPJ2cxtnHXyg6I+Ho9DAR1j9Q/pGIa+UOlqBz5BYZZUObxiTrrcopAw+UdqNR3oqp/OuPP9mFETP0osThhmXOaRv1+6uT0uS9RBUk7eZZHo7rUSGL0aMheL4AWwncGL6gdHdY2M+H+9qXyq7+DW1QVQG4OqTrqmp002VikDtMz90/yzoJT06PB+Fx+O1o8CY6+y56/aYXhuHvEMC8yIm3KV3uvH2t0tV7qdOvoKfaIevk0rYfoKqI4Sw82y3VthFL5dhElTL95stVKhqj9ubO2g/79HdjKWQuJD40PefhLDx7OG0Ner1r0FDOeC5SP1hG1OO/rj1d9a5WvxssURPVI2jD2O55baTFpDTCLfwE646u6G5M3bhAl6nV6PMjz2UQQb+JfX/ZmTEVkDwzawZiafJO7VvHp0JOj7nWvWZi5Ty21An6XIv+bACksUF0S16rHbOBa13oWrxDqvTPDl4yVMiJ8swrZzS9zbtyNtiZiaNMWCasv25s9GFlE2XYFjeLucWUKclchv6Szk97g3ap8Kw9di/v5a0qkJUWaX7lQj7Z6F4es7ubyUQkgufsN4ytcDh+1Xju+fl5x2NHnudKuKyMmUGt1uRTf+jd2uVqX44gAIemsDeTWzQzkTQd+gVVfU/cX+U57QaUqwUXFN3V0Y/bTJR3uUhQWuxk5vnVh/fstBdC0EmOfwG5/3740+X17SVJpfSqQzTohb2QjrSyruCyo4iWwCZqLF6w4cV2gJfrqv0f1sZVijqcu77OufB16E1ermroDjqbZNTd1MYBZMo6IlkuKbE+mryq6PhTiYYqdRzAjBtB+HyhpcLSc9puYi9a+urX1VJ3xPYvfXuBNwUnqdpmPC/pDQJ4wsXWllmNq6Cpuv+M7CUYtbrNMm/R0NpbE5wnCWrXudvpyRuN7epyBAHwkoLS7S1PvresHsiWvV7YRFMDoF+Cs5fhe8qtd7j4oSWvb15kaD8eampyxbiqqr8BSkpv3g==",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"}},f={},g=[{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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get document by ID"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,i.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,i.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(d.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.jsxs)(s,{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)(a.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\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)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.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)(s,{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)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{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)(a.p,{children:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,i.jsx)(c.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)(a.p,{children:"]"})})})]})]})}),(0,i.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,i.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,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)(a.p,{children:"Document not found!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.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)(s,{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)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.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)(a.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.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)(s,{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)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.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:a}={...(0,l.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink