WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-07 10:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
16d5fcdede7d14ebbe73bfcacc1f25d8dfdd9bd2
OpenSign/assets/js/fa40969b.68747bab.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:()=>b,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),n=a(11151),i=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 x={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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=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:"eJztWF9v27YW/ypn7MPWQrblxGk3YbhYsPYG2YbboslQ4DZGQEnHFhuK5EjKjmHo7X6SfbR9kotDSbYcJ2m8DX3aS2KR5z9/5w+5Zp7PHUs+stc6q0pU3rFpxHJ0mRXGC61Ywp49ewbdNlyuDLrkSr1HbwUuEDhI4TzoGeSdCEi5wxy0Ar8yeKWu1HgIL168tnzmN5Jc8uLFlQIAGGzXwBfcA7cIWWUtKi9XIBTkgdN57is3JHlHJO9cDd5ZPbfo3J+SalrmIPGYJP6oSyPRY/4UeQVfIKSIClyVZejcrJJyBdlGxlL4AriUYPG3SljMwYm54r6y2OickM43tybsPVUjtvRc5cElpUFqNUcLPFghUolB+kmIOWZSqEMdyjuudAW+QKgc2uGVYhHTBi0nXJznLGFz9N2hEwhYxAy3vESPlkC1ZoqXyBKW64yQwCImCFCG+4LdRdllgQEuu0jyGmyLNBaxLpAs8bbCiDm/kiTfCYo5ixjeGqlzZMmMS0cEWYElZ8maBf0Jc94KNSdKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvWdbTxTYpS+M6z3yq0qx1DO0NaS2faln07Wz82Zpb8VpRk2UkcR53RqipTtKwmPh48TcZxzwR3I8zfZsHDOuN6SnKd0cqhI9qjOKZ/uwe5zQbYoCXEVHlUnui5MVJkYWP0yRHTet8AnX7CLEDKkhgvGpUWXSV9j45by8lh4bF0n+dvlgm9+5ig0HC/g5LOd/bvM3FzdJwWv/5EMZkJWjxMQuG9cclo1K5UVg4zXZI0L/zh4lz4QalCIpT2B0swErnDUJQ2GRec0zJH+6VC2WD4MAmNhRBY620AWefFdetCHTG9VDu+PEn+Jx0KIfFTdEI1+7OAs/r+s91qy1A/Foh7zcKSC/lZ6hTxh3ahw5optPqMmsnJy6Px8bevxkS/FPkc/V/wv9nd17dbNE6l1EvMYcFlhQ4G21YZUd8vzfBz6dDRk9G3+4Wsx71Z2XAfTSZ1xFYHcr0aU3wOZDr+to5YcSDT5CWdHJ/jgXzjfnJ4LI3kHq8vGkhfd0dbP0YV8suhys/VW7tbFlKtJXLVVxh6TR2xzCL3mJ/6x5F2FB8dD8bxIH51OX6ZTL5LTl4O4zj+L4vYbRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mlx3XfP6KI6vJ0RSR2wST/a753s02npQ2gNfcCF5KvGrv699orX63nK4Ddb9Fjzm1CSeXJ9snDrZd+pcLbgUOZy+O4dLfYPqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuLcDbsSg2U8+TmlIKtEXuh2Qw1DsC5awUX9WHq3bobhmJM8uupG5srI3LHBjhtqgovImeeqojI+4EaMFVee71M7zuVDzwaNc0639FxTjJow7XmxrvRE/IxX7Nkh9qnbgLJCHVlvT90wH5jZ0bw0qKiMh8IvxXtH/gDLTJdKQT7eMjvyP//0eOLpwBVx8BW8rC0Yv0dJkSbefmcRbuu0EYk4NxMFKVyTOIS8lOhcueh7nlnuEXMyF5zK0FqHmkHHDUyEFIYnINHFb6IHRDeFDgb5AS1tfW7rt5rhASQAEqfUNyfEaeOV1GXR09+SltjczMikCDmnlhKJrqkPsWFAVXGUI3VlEoC1wBag8WmOFQ+CiJOKZtoCzmcgECaa0sTzzUHLF50jKIiC7KQrG6oXI0YHVaeU8OC2r4AhpLBF946JCzN0QXosFNo7TYo6eC4k5zCsSEUGmc7puhiwiN1QOKToPhtSLDINQ57n1IHGBNmAvnCTdhMFoSm/BJd3o+mdLgrzlylHnagzqjmYTPmM1XSKCjpyvhkA32gsCS+WQACCFuqF3iAF83MDsA6ZOeJx+0+XDcrncy4PnuzxnwhdVChaN3vLNw2LImj775uM5i5hHW7q3swu0C5F18/0DOkeBeNQWPZ6FoteOcJRjP9xloAIkRYbKYa9EnZ69+wUWcDyMWdTL/CcYPPrl/Mc3/7l4Q3Kp0jT5Nx7GwzgMhdr5kqueqjPcvtQ0Dzwzq8v2CeZuIq+3tfyfx6J/Hos2j0VtE/F460dGchH6asDtuu2JH9md96OkeyqaRqzQzhPJek0Q+dXKuqbl5oWDWmUuHA0n2zeOG1z1XmTCXYIlLDTKB2jbp5Mt6ZQ+rCDa+3U8iPxv3rcn9xye8pZ1b3C6tqtWfaM6Y7vY1FO6QzR9l2xsdk+zDE3f772pamc0OXtzySLGK1/s9vub0O/bHyT9Xpt2B4HGAPpLob6X4XtqTz/j6l8b8mbnQYbWv46a4jOt6/r/3b3KnQ==",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"}},b={},g=[{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,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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,l.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,l.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,l.jsxs)(s.ol,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:(0,l.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.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,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"document[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(s.p,{children:"Array ["})})}),(0,l.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,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.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,l.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,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.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,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Report not available!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink