WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-30 21:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
4d8056f50431fda8d8920c4bdc4dfc1af25cec7b
OpenSign/assets/js/fa40969b.4f577969.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[724],{17556:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>h,default:()=>y,frontMatter:()=>x,metadata:()=>s,toc:()=>v});const s=JSON.parse('{"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":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJztWN1u2zgWfpUz7MVOC9mWE6ed9dUE026Q3cG2aDIosI1hUNKxxYYiOSTlHxi62yeZR5snWRxKsuXYSePZQa/mpo2p83++80NumOdzx8af2VudlgUq79gkYhm61ArjhVZszF68eAHtZ7hdG3TjO/URvRW4QOAghfOgZ5C1IiDhDjPQCvza4J26U8M+vHr11vKZ30py41ev7hQAQG93Bj7nHrhFSEtrUXm5BqEgC5zOc1+6Psk7I3nXqvfB6rlF5/6QVNMwB4nnJPEnXRiJHrPnyMv5AiFBVODKNEXnZqWUa0i3MpbC58ClBIu/lsJiBk7MFfelxVrniHS+W5nw7bkasaHnKgsuKQ1Sqzla4MEKkUgM0i9CzDGVQp3qUNZyJWvwOULp0PbvFIuYNmg54eI6Y2M2R98mnUDAIma45QV6tASqDVO8QDZmmU4JCSxiggBluM/ZQ5Td5hjgso8kr8E2SGMRawPJxt6WGDHn15LkO0ExZxHDlZE6QzaecemIIM2x4Gy8YUH/mDlvhZoTpSoLwn2AVjCshQOL2DaHtcigkuyto8ImVRVtfZOiEL717NcS7XrP0NaQxtKZtkXXzsaPrZkFX4mCLLuI46g1WpVFgpZVxMeDp+Nh3DHB3Qvzp1nwuM64mpBcZ7Ry6Ij2LI7pv/1E7qoBtmgJMVUelSd6bowUafgw+OKIaXNogE6+YBogZUmMF7VKi66UvkPHreXksPBYuK/z18eE3kNMUGi430NJ6zv7x5W4PztP8l/+STGZCTo8TULuvXHjwaA5Ka3sp7ogaV7408W58AeVColQ2p8swUjkDkNT2lZccE7LDO23CmWN4dMk1BZCYK12AWStF9PGhSpieqn2fHmW/C86NELip+iEbvZHAWf18dzutKWonwrEUbOw4EJ+lTpB/LE5aLFmcq2+omZ08fpseP7DmyHRL0U2R/9/+F9/PdS33zQupdRLzGDBZYkOertRGdHcL0z/a+XQ0pPRq8NG1uHenmy5z0ajKmLrE7neDCk+JzKd/1BFLD+RafSaMsfneCLfsFscHgsjucfpTQ3paZva6imqUF8OVXat3tv9tpBoLZGrrkIaJlXEUovcY3bpnwbaWXx23hvGvfjN7fD1ePT38cXrfhzH/2ERWxUB3e3+wD2ybp03v0uTfRM9qHgi8VaXz3PfYiYspn5a2qM1+hSOSR2nYpgWOhOzZky6p/WGEU92t8kTR5vyTkuHEIQDreQa+IILSX7CMkcV9r62nxJNk1OYWV0Ah1ZCPwDkQRg7w+Rha95Hm1C0UU3bpWJ6FsfTEZFUERvFo8Pl4iMabT0o7Xf2fvfnbRdorT46LXahO27BU06N4tH0YuvUxaFT12rBpcjg8sM13Op7VN/Wo656X6s/zKmoicJ3tuds97x20mFaWuHX4Qqw6nEjevX38ecJ7ZAF+lw394dwZ/A5G7NB9yox2DR3hoqRPLtobxShpLa7lOMqS/Sqrw0qmgCSJ44m3YAbMVjQAHvIwY05gRrL3mkMzvO5UPOnuSa7EN1QGutM7QVqN22N+BfSuG3y0KVqVv4ceVh2Kvo904G5yc57g4oaecjtYngwdj+hTHWBdM2iem/Jf//vb4GjzUiA3nfwvrRg9BIt7fZ0/5xJXNF9MxCHruVgrUsS55AXEp0LV22Pc8s9QibmwnMZhrtQc0i54YmQgsBKZJq4LXTw7vrwKUefo6VPf7P03pDhAiVhHKTW9yTHa+Cl10XQ0faspbb3MzIpAg5J6YSihwKH2LKgyrlKEdpcRKAtcAWoPFpjhUPgoiDimbaAs5lIBQmmyrQ89VBwxedIyiIguykKxuqFyNCB1UnpPDgty+AIaSwQfe2iQsxcH96KBdaO02GGnguJGcxLEhFBqjO68IdCJTdUBgk6D4bUixSDUOe59SBxgTZgL2SS3iLAaOoggku6U3dzS4K85crRJKoNalOzDZ+xmq5xQUfG132gN4UbAkvpkAAghbqnl6AefN7C7BMmTnicfN/Ww3K5PKiDl/s8V8LnZQIWjd7xzcNhqJou+/bHS0bTzhbu/ewG7UKk7Q3rEZ2DQDxo+ipPQ19tlmiqsR8fMlCPkyJF5bDTBS+vPvwMCzjvxyzqVP4zDB78fP3Tu3/fvCO51Mzq+hv2434c1nLtfMFVR9UV7t7K6ie2MHnrR7CHhbzZjYu/nuv+eq7bPtc1Q8Tjyg+M5CKM7mYrrcfuZ/bgBW/cPtZNIpZr54lksyGI/GJlVdFx/cZE0zgTjvaf3SvTPa47b2LhNlcvtY/SNo9XO9IJ/bCCaI/reBT5339sMvcSnvOaeDQ47dhV665RrbFtbKoJ3eLquUs21l8v0xRN1++DxW1v+7l6d8sixkuf78/7+zDvmz9I+lGb9heB2gD6l0J9lGGzqXeJqtrS158e5WgcbKkpQJOqqv4HeDVUow==","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"}}');var i=n(74848),r=n(28453),a=n(33617),l=n.n(a),o=n(17543),p=n.n(o),m=n(86013),c=n.n(m),d=n(63723),u=n.n(d),g=(n(18766),n(79329),n(9303));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:"eJztWN1u2zgWfpUz7MVOC9mWE6ed9dUE026Q3cG2aDIosI1hUNKxxYYiOSTlHxi62yeZR5snWRxKsuXYSePZQa/mpo2p83++80NumOdzx8af2VudlgUq79gkYhm61ArjhVZszF68eAHtZ7hdG3TjO/URvRW4QOAghfOgZ5C1IiDhDjPQCvza4J26U8M+vHr11vKZ30py41ev7hQAQG93Bj7nHrhFSEtrUXm5BqEgC5zOc1+6Psk7I3nXqvfB6rlF5/6QVNMwB4nnJPEnXRiJHrPnyMv5AiFBVODKNEXnZqWUa0i3MpbC58ClBIu/lsJiBk7MFfelxVrniHS+W5nw7bkasaHnKgsuKQ1Sqzla4MEKkUgM0i9CzDGVQp3qUNZyJWvwOULp0PbvFIuYNmg54eI6Y2M2R98mnUDAIma45QV6tASqDVO8QDZmmU4JCSxiggBluM/ZQ5Td5hjgso8kr8E2SGMRawPJxt6WGDHn15LkO0ExZxHDlZE6QzaecemIIM2x4Gy8YUH/mDlvhZoTpSoLwn2AVjCshQOL2DaHtcigkuyto8ImVRVtfZOiEL717NcS7XrP0NaQxtKZtkXXzsaPrZkFX4mCLLuI46g1WpVFgpZVxMeDp+Nh3DHB3Qvzp1nwuM64mpBcZ7Ry6Ij2LI7pv/1E7qoBtmgJMVUelSd6bowUafgw+OKIaXNogE6+YBogZUmMF7VKi66UvkPHreXksPBYuK/z18eE3kNMUGi430NJ6zv7x5W4PztP8l/+STGZCTo8TULuvXHjwaA5Ka3sp7ogaV7408W58AeVColQ2p8swUjkDkNT2lZccE7LDO23CmWN4dMk1BZCYK12AWStF9PGhSpieqn2fHmW/C86NELip+iEbvZHAWf18dzutKWonwrEUbOw4EJ+lTpB/LE5aLFmcq2+omZ08fpseP7DmyHRL0U2R/9/+F9/PdS33zQupdRLzGDBZYkOertRGdHcL0z/a+XQ0pPRq8NG1uHenmy5z0ajKmLrE7neDCk+JzKd/1BFLD+RafSaMsfneCLfsFscHgsjucfpTQ3paZva6imqUF8OVXat3tv9tpBoLZGrrkIaJlXEUovcY3bpnwbaWXx23hvGvfjN7fD1ePT38cXrfhzH/2ERWxUB3e3+wD2ybp03v0uTfRM9qHgi8VaXz3PfYiYspn5a2qM1+hSOSR2nYpgWOhOzZky6p/WGEU92t8kTR5vyTkuHEIQDreQa+IILSX7CMkcV9r62nxJNk1OYWV0Ah1ZCPwDkQRg7w+Rha95Hm1C0UU3bpWJ6FsfTEZFUERvFo8Pl4iMabT0o7Xf2fvfnbRdorT46LXahO27BU06N4tH0YuvUxaFT12rBpcjg8sM13Op7VN/Wo656X6s/zKmoicJ3tuds97x20mFaWuHX4Qqw6nEjevX38ecJ7ZAF+lw394dwZ/A5G7NB9yox2DR3hoqRPLtobxShpLa7lOMqS/Sqrw0qmgCSJ44m3YAbMVjQAHvIwY05gRrL3mkMzvO5UPOnuSa7EN1QGutM7QVqN22N+BfSuG3y0KVqVv4ceVh2Kvo904G5yc57g4oaecjtYngwdj+hTHWBdM2iem/Jf//vb4GjzUiA3nfwvrRg9BIt7fZ0/5xJXNF9MxCHruVgrUsS55AXEp0LV22Pc8s9QibmwnMZhrtQc0i54YmQgsBKZJq4LXTw7vrwKUefo6VPf7P03pDhAiVhHKTW9yTHa+Cl10XQ0faspbb3MzIpAg5J6YSihwKH2LKgyrlKEdpcRKAtcAWoPFpjhUPgoiDimbaAs5lIBQmmyrQ89VBwxedIyiIguykKxuqFyNCB1UnpPDgty+AIaSwQfe2iQsxcH96KBdaO02GGnguJGcxLEhFBqjO68IdCJTdUBgk6D4bUixSDUOe59SBxgTZgL2SS3iLAaOoggku6U3dzS4K85crRJKoNalOzDZ+xmq5xQUfG132gN4UbAkvpkAAghbqnl6AefN7C7BMmTnicfN/Ww3K5PKiDl/s8V8LnZQIWjd7xzcNhqJou+/bHS0bTzhbu/ewG7UKk7Q3rEZ2DQDxo+ipPQ19tlmiqsR8fMlCPkyJF5bDTBS+vPvwMCzjvxyzqVP4zDB78fP3Tu3/fvCO51Mzq+hv2434c1nLtfMFVR9UV7t7K6ie2MHnrR7CHhbzZjYu/nuv+eq7bPtc1Q8Tjyg+M5CKM7mYrrcfuZ/bgBW/cPtZNIpZr54lksyGI/GJlVdFx/cZE0zgTjvaf3SvTPa47b2LhNlcvtY/SNo9XO9IJ/bCCaI/reBT5339sMvcSnvOaeDQ47dhV665RrbFtbKoJ3eLquUs21l8v0xRN1++DxW1v+7l6d8sixkuf78/7+zDvmz9I+lGb9heB2gD6l0J9lGGzqXeJqtrS158e5WgcbKkpQJOqqv4HeDVUow==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,f={},v=[{value:"Document Types:",id:"document-types",level:3}];function b(e){const t={h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(g.default,{as:"h1",className:"openapi__heading",children:"Get Document list from status"}),"\n",(0,i.jsx)(l(),{method:"get",path:"/documentlist/{doctype}",context:"endpoint"}),"\n",(0,i.jsx)(t.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(t.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(g.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(p(),{parameters:[{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"]}},{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10},{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}]}),"\n",(0,i.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,i.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{result:{type:"array",items:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},file:{type:"string",format:"string",example:"https://exampleurl.com"},title:{type:"string",format:"string",example:"sample doc"},note:{type:"string",format:"string",example:"please sign document"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"FGik23bhUJ"},name:{type:"string",format:"string",example:"folder name"}},title:"document_folder"},owner:{type:"string",format:"string",example:"joe bee"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},page:{type:"number",format:"number",example:1}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},template_id:{type:"string",example:"template_id is only available when the document is created from a template."}},xml:{name:"document"},title:"document"}}},title:"inline_response_200_4"}}}},404:{description:"Report not available!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Report not available!"}},title:"inline_response_404_5"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink