WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 10:04:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
39e58e468a40d055fa734ee31ebef73a64b87385
OpenSign/assets/js/fa40969b.7625b669.js
T

1 line
16 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:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),r=a(58219),i=(a(62316),a(51039)),t=a.n(i),c=(a(82723),a(9487)),d=a(41429),m=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:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},f={},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,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,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:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\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)(d.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:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\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)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.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)(r.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)(c.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:"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:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(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:"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:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(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:"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)(m.Z,{responseExample:'{\n "result": [\n {\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 }\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)(c.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)(m.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)(c.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)(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,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink