WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
e637dc5e07817ef5011dcce498dc416f7cc181a9
OpenSign/assets/js/f0ff4a36.86ea4c77.js
T

1 line
9.9 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:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var i=a(85893),n=a(11151),t=a(58219),l=(a(62316),a(51039)),r=a.n(l),o=(a(82723),a(9487)),d=a(41429),c=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:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+ObCfpPMwfbJN87vjwXh6yAMfnFoJbOFNRnqF0FqYexGgjI7QTSkIAF+gYZ3EDAA+URsNpcRxDAHN0nTXNDc/QoSGvBUieIQSwPORaHDr1iBI8EOQ1QR6jAQ8Mfs+FwRgCZ3L0wLpVSjZWZDpF8ACXOlUxQjDjqSVAlGDGISjArXSFdEbIOZQE5ZVRQBylFXPZWy6XSyi9NZWW672IWyqauwS2T63CB4zcOGZqxiIlHY/c/0nWg5kyGXfdmWf2+o9BmETDRIdQllPa1molLVpyNPR9+tmka/MoQmtnecrW6QEPiDklJiiAa52KqFroP1gyKnbZcWP4iuLiMLOd+ToalF9D7p2oqbRB2vd8v1+Ix+EoTL5dUta+VpnZz8OlQvYbIpmfZ1yk+9o/KAwRPzYTvUhl5Oo6UXJvKkfHJx9+Gg0HwxG5uFThjXDp3l5iXJD5J5VpLlf7WrflXrnIrVMZGqrwF9w8G0UdYOnBJA/XFWVfMX6Lg922p9Ti0t2HIk2FnN/H3OGPa+r+vl5/i/kZeSo9EFa9DRz6w9HhwD/0P9wMToKjn4Pjk57v+39DWXqwzKqyaYWh8enq7DXjHVhu0XRh9Zg+Hhz5R7ud2Sork8qxmcpl/A4q7PEudiwXPBUxO70esxtSy3cVA4tRboRbVZLa1dLgdkrykKFLVKPFlQa7BALot1LXLzqiVwL5M4tWoXOTkho7p23Q73Ote20tpTy01Bh9rkV/MQDaqWUyIeGo87XB51lItPiMpCQ/vAHogELO6kQ2Qb3SKCdiLqtALAY74nyTCMuErZbbs1XKxmbKsC1rFnKLMVOSuQSrRZof9QbMaozErBHFHruTd3KiMmS5RRLSVMhHG9zJQ3Z7NZuJSPCU/YWhFQ6n79uIPT097UTsoLK5EC7JQ2ZQq2f4vJqswtq1Wg8OwAOHJrNXswmahYiwyc4rW/UrcL+RerqkggKwVsR26uO2EdVfKiKUFjuVfXpx/YWNej54naL4F5T7X8afzr9OzskrlVWdokHP7/k0pZV1GZedjehB0WaNhSs2PttOcPF8ce0+P5oKc7h0fZ1yUYlexbhoSv8WOvCge+NPPUiUdQQpCqqLbyYtS5r+nqOhBpt6sOBG8JAK8baAWFj6H69v9FeJvv+zeRwcsJcfDy8Sb/tFUrMseJrTCDx4xNXWa6Wcll7bNP+Z2Ws06u02u3TNhp5PNeA0ilC7ztrOq2JDjy7Ob8ADnlNSutLwWElD84fO8mIUNtnUBOib6Lxo8As19mdc/bqG1yuvGqwfoTWaQjEty/IfnPnAPw==",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:"eJytVm1v2zYQ/ivsfWoAxZbtJN2EYWjWZJnTognmFAOWGAElnS0mEsmSlGND0H8fTi+ObCfpPMwfbJN87vjwXh6yAMfnFoJbOFNRnqF0FqYexGgjI7QTSkIAF+gYZ3EDAA+URsNpcRxDAHN0nTXNDc/QoSGvBUieIQSwPORaHDr1iBI8EOQ1QR6jAQ8Mfs+FwRgCZ3L0wLpVSjZWZDpF8ACXOlUxQjDjqSVAlGDGISjArXSFdEbIOZQE5ZVRQBylFXPZWy6XSyi9NZWW672IWyqauwS2T63CB4zcOGZqxiIlHY/c/0nWg5kyGXfdmWf2+o9BmETDRIdQllPa1molLVpyNPR9+tmka/MoQmtnecrW6QEPiDklJiiAa52KqFroP1gyKnbZcWP4iuLiMLOd+ToalF9D7p2oqbRB2vd8v1+Ix+EoTL5dUta+VpnZz8OlQvYbIpmfZ1yk+9o/KAwRPzYTvUhl5Oo6UXJvKkfHJx9+Gg0HwxG5uFThjXDp3l5iXJD5J5VpLlf7WrflXrnIrVMZGqrwF9w8G0UdYOnBJA/XFWVfMX6Lg922p9Ti0t2HIk2FnN/H3OGPa+r+vl5/i/kZeSo9EFa9DRz6w9HhwD/0P9wMToKjn4Pjk57v+39DWXqwzKqyaYWh8enq7DXjHVhu0XRh9Zg+Hhz5R7ud2Sork8qxmcpl/A4q7PEudiwXPBUxO70esxtSy3cVA4tRboRbVZLa1dLgdkrykKFLVKPFlQa7BALot1LXLzqiVwL5M4tWoXOTkho7p23Q73Ote20tpTy01Bh9rkV/MQDaqWUyIeGo87XB51lItPiMpCQ/vAHogELO6kQ2Qb3SKCdiLqtALAY74nyTCMuErZbbs1XKxmbKsC1rFnKLMVOSuQSrRZof9QbMaozErBHFHruTd3KiMmS5RRLSVMhHG9zJQ3Z7NZuJSPCU/YWhFQ6n79uIPT097UTsoLK5EC7JQ2ZQq2f4vJqswtq1Wg8OwAOHJrNXswmahYiwyc4rW/UrcL+RerqkggKwVsR26uO2EdVfKiKUFjuVfXpx/YWNej54naL4F5T7X8afzr9OzskrlVWdokHP7/k0pZV1GZedjehB0WaNhSs2PttOcPF8ce0+P5oKc7h0fZ1yUYlexbhoSv8WOvCge+NPPUiUdQQpCqqLbyYtS5r+nqOhBpt6sOBG8JAK8baAWFj6H69v9FeJvv+zeRwcsJcfDy8Sb/tFUrMseJrTCDx4xNXWa6Wcll7bNP+Z2Ws06u02u3TNhp5PNeA0ilC7ztrOq2JDjy7Ob8ADnlNSutLwWElD84fO8mIUNtnUBOib6Lxo8As19mdc/bqG1yuvGqwfoTWaQjEty/IfnPnAPw==",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"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",...(0,n.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:"Get a 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)(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)(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:"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)(t.Z,{children:[(0,i.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.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)("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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Customer_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"customer_id"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Subscriptions_id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"subscriptions_id"}}),(0,i.jsx)(m.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:"Next_billing_date"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"date"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"__type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Date"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"iso",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z"}})]})]})}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'[\n {\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "Customer_id": "customer_id",\n "Subscriptions_id": "subscriptions_id",\n "Next_billing_date": {\n "__type": "Date",\n "iso": "2023-10-07T16:49:56.000Z"\n }\n }\n]',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document not found!"})}),(0,i.jsx)("div",{})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink