WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-25 19:14:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafd020dc5b4a76df7f26bc156fe78d325567178
OpenSign/assets/js/fa40969b.a3e642f7.js
T

1 line
20 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5mKbYCSNbDnpDhaLGk3WcFtsgthFgI0FgzNzpGHMIVmSox8Ic7dP0kfrkywOZ0YaWXZidYtc9cbWkOef3/khN8zzuWPJR/ZaZ1WJyjs2jViOLrPCeKEVS9izZ8+g24brtUGX3Kj36K3ABQIHKZwHPYO8EwEpd5iDVuDXBm/UjRoP4cWL15bP/FaSS168uFEAAIPdGviCe+AWIausReXlGoSCPHA6z33lhiTvhORdqsE7q+cWnftDUk3LHCSeksQfdGkkesyfIq/gC4QUUYGrsgydm1VSriHbylgKXwCXEiz+WgmLOTgxV9xXFhudE9L5ZmXC3lM1YkvPVR5cUhqkVnO0wIMVIpUYpJ+FmGMmhTrWobzjStfgC4TKoR3eKBYxbdBywsVlzhI2R98dOoGARcxwy0v0aAlUG6Z4iSxhuc4ICSxiggBluC/YfZRdFxjgso8kr8G2SGMR6wLJEm8rjJjza0nynaCYs4jhykidI0tmXDoiyAosOUs2LOhPmPNWqDlRqqok3AdoBcM6OLCIbc+wERlUkr1NVNi0rqOtb1KUwnee/VqhXe8Z2hnSWjrTtuzb2fqxNbPkK1GSZWdxHHVGq6pM0bKa+HjwNBnHPRPcnTB/mgWP64zrKcl1RiuHjmhP4pj+7R/kLhtgi5YQU+VReaLnxkiRhY3RJ0dMm0MDdPoJswApS2K8aFRadJX0PTpuLSeHhcfSfZm/WSb0HmKCQsP9Hko639m/LsTdyWla/PIjxWQmaPE4CYX3xiWjUbtSWTnMdEnSvPDHi3PhB6UKiVDaHy3BSOQOQ1HaZlxwTssc7dcKZYPh4yQ0FkJgrXcBZJ0Xt60LdcT0Uu358iT5n3QohMRP0QnV7I8CzuqHz3anLUP9uUA8aBaWXMgvUqeI37cLHdZModUX1EzOXp6MT797NSb6pcjn6P8P/5vdQ337ReNcSr3EHBZcVuhgsGuVEfX90gy/lA4dPRm9OixkPe7typb7ZDKpI7Y+kuvVmOJzJNPpd3XEiiOZJi/p5Pgcj+Qb95PDY2kk93h71UD6tjva+nNUIb8cqvxSvbX7ZSHVWiJXfYWh19QRyyxyj/m5/zzSTuKT08E4HsSvrscvk8nfk7OXwziO/8MitioDvLsBgntk/URvvyuTfwU99QFZr1rerz374RSKRobbrmvensTx7YRI6ohN4slh93yPRlsPSnvgCy4kTyV+8+e1T7RWP1gOd8F62ILPOTWJJ7dnW6fODp26VAsuRQ7n7y7hWt+h+roe9dX7Rv3hmYqGKOyzPWf7642TDrPKCr8OM+5qwI0YNPvJxykNSSX6QrcDchiKfcESNurPyqNNOxTXjOTZRTcyV1b2hgVuzFAbVFTeJE8dlfERN2K0oOp8n9p5PhdqPjiSi6s81avHOaY7j6/oVJrA7/m96w5G/ITUHtqw9qnaEbVAHppzTd8zHZjbYL81qKjwhKNajA/axAeUmS6RrgV0L+nIf//vb4GjC3BA0jfwtrJg9BItzaJ0X5pJXNH9KBBzajkO1roicQ55KdG5cDX0OLfcI+RiLjyXoRkJNYeMG54KKQh7RKaJ20IPvm4IHwr0BVra+pul+3GOC5QEWZBa35Ecr4FXXpdBR3ezXmp7NyOTIuCQVk4outg6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmkLOJuJTJBgSjTLMw8lV3yOpCwCspuiYKxeiBwdWJ1WzoPTsgqOkMYS0TcuKsTcDeG1WGDjOC3m6LmQmMO8IhERZDqnC2rIO3JD5ZCi82BIvcgwCHWeWw8SF2gDWsNJ0t0ZjKaCILikO2D/bEmQt1w56nWNQd3RbMNnrKZrR9CR8/UQ6A58RWCpHBIApFB39HIxgI9bmH3A1AmP02+7XFgulwd58Hyf50L4okrBotE7vnlYDFnTZ99+PGcR82hL93Z2hXYhsu5G8IjOUSAetWWSZ6FMtkMf5dj39xmoZEmRoXLYK2rnF+9+hgWcDmMW9bL+CQaPfr784c2/r96QXKpNTf6Nh/EwDmOkdr7kqqfqAndvO82T0Mzqsn20uZ/Im131/+t56a/npe3zUttEPK78yEguQicOuN20XfQju/filHSPS9OIFdp5ItlsCCK/WFnXtNy8iVBzzYWjcWb3KnKH694bTrh9sISFJvkIbfvYsiOd0ocVRPuwjkeR/+379uSew1Nevx4MTtd21bpvVGdsF5t6SreOpu+Sjc3ueZah6ft9MIftDTMXb65ZxHjli/1+fxf6ffuDpD9o0/4g0BhAfynUDzL8g9rTT7j+55a82XmUofWvo6b4TOu6/h9h3txv",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/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5mKbYCSNbDnpDhaLGk3WcFtsgthFgI0FgzNzpGHMIVmSox8Ic7dP0kfrkywOZ0YaWXZidYtc9cbWkOef3/khN8zzuWPJR/ZaZ1WJyjs2jViOLrPCeKEVS9izZ8+g24brtUGX3Kj36K3ABQIHKZwHPYO8EwEpd5iDVuDXBm/UjRoP4cWL15bP/FaSS168uFEAAIPdGviCe+AWIausReXlGoSCPHA6z33lhiTvhORdqsE7q+cWnftDUk3LHCSeksQfdGkkesyfIq/gC4QUUYGrsgydm1VSriHbylgKXwCXEiz+WgmLOTgxV9xXFhudE9L5ZmXC3lM1YkvPVR5cUhqkVnO0wIMVIpUYpJ+FmGMmhTrWobzjStfgC4TKoR3eKBYxbdBywsVlzhI2R98dOoGARcxwy0v0aAlUG6Z4iSxhuc4ICSxiggBluC/YfZRdFxjgso8kr8G2SGMR6wLJEm8rjJjza0nynaCYs4jhykidI0tmXDoiyAosOUs2LOhPmPNWqDlRqqok3AdoBcM6OLCIbc+wERlUkr1NVNi0rqOtb1KUwnee/VqhXe8Z2hnSWjrTtuzb2fqxNbPkK1GSZWdxHHVGq6pM0bKa+HjwNBnHPRPcnTB/mgWP64zrKcl1RiuHjmhP4pj+7R/kLhtgi5YQU+VReaLnxkiRhY3RJ0dMm0MDdPoJswApS2K8aFRadJX0PTpuLSeHhcfSfZm/WSb0HmKCQsP9Hko639m/LsTdyWla/PIjxWQmaPE4CYX3xiWjUbtSWTnMdEnSvPDHi3PhB6UKiVDaHy3BSOQOQ1HaZlxwTssc7dcKZYPh4yQ0FkJgrXcBZJ0Xt60LdcT0Uu358iT5n3QohMRP0QnV7I8CzuqHz3anLUP9uUA8aBaWXMgvUqeI37cLHdZModUX1EzOXp6MT797NSb6pcjn6P8P/5vdQ337ReNcSr3EHBZcVuhgsGuVEfX90gy/lA4dPRm9OixkPe7typb7ZDKpI7Y+kuvVmOJzJNPpd3XEiiOZJi/p5Pgcj+Qb95PDY2kk93h71UD6tjva+nNUIb8cqvxSvbX7ZSHVWiJXfYWh19QRyyxyj/m5/zzSTuKT08E4HsSvrscvk8nfk7OXwziO/8MitioDvLsBgntk/URvvyuTfwU99QFZr1rerz374RSKRobbrmvensTx7YRI6ohN4slh93yPRlsPSnvgCy4kTyV+8+e1T7RWP1gOd8F62ILPOTWJJ7dnW6fODp26VAsuRQ7n7y7hWt+h+roe9dX7Rv3hmYqGKOyzPWf7642TDrPKCr8OM+5qwI0YNPvJxykNSSX6QrcDchiKfcESNurPyqNNOxTXjOTZRTcyV1b2hgVuzFAbVFTeJE8dlfERN2K0oOp8n9p5PhdqPjiSi6s81avHOaY7j6/oVJrA7/m96w5G/ITUHtqw9qnaEbVAHppzTd8zHZjbYL81qKjwhKNajA/axAeUmS6RrgV0L+nIf//vb4GjC3BA0jfwtrJg9BItzaJ0X5pJXNH9KBBzajkO1roicQ55KdG5cDX0OLfcI+RiLjyXoRkJNYeMG54KKQh7RKaJ20IPvm4IHwr0BVra+pul+3GOC5QEWZBa35Ecr4FXXpdBR3ezXmp7NyOTIuCQVk4outg6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmkLOJuJTJBgSjTLMw8lV3yOpCwCspuiYKxeiBwdWJ1WzoPTsgqOkMYS0TcuKsTcDeG1WGDjOC3m6LmQmMO8IhERZDqnC2rIO3JD5ZCi82BIvcgwCHWeWw8SF2gDWsNJ0t0ZjKaCILikO2D/bEmQt1w56nWNQd3RbMNnrKZrR9CR8/UQ6A58RWCpHBIApFB39HIxgI9bmH3A1AmP02+7XFgulwd58Hyf50L4okrBotE7vnlYDFnTZ99+PGcR82hL93Z2hXYhsu5G8IjOUSAetWWSZ6FMtkMf5dj39xmoZEmRoXLYK2rnF+9+hgWcDmMW9bL+CQaPfr784c2/r96QXKpNTf6Nh/EwDmOkdr7kqqfqAndvO82T0Mzqsn20uZ/Im131/+t56a/npe3zUttEPK78yEguQicOuN20XfQju/filHSPS9OIFdp5ItlsCCK/WFnXtNy8iVBzzYWjcWb3KnKH694bTrh9sISFJvkIbfvYsiOd0ocVRPuwjkeR/+379uSew1Nevx4MTtd21bpvVGdsF5t6SreOpu+Sjc3ueZah6ft9MIftDTMXb65ZxHjli/1+fxf6ffuDpD9o0/4g0BhAfynUDzL8g9rTT7j+55a82XmUofWvo6b4TOu6/h9h3txv",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(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 list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\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:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\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:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.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)(m.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.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:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.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:"folder"})}),(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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.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)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(o.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:"widgets"})}),(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)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,n.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,n.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,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)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\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:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(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",{children:(0,n.jsx)(m.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.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink