WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-24 18:44:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
2966a9d82da3539b45307db342de137ee95df175
OpenSign/assets/js/fa40969b.4a2b9b90.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:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>y,metadata:()=>s,toc:()=>j});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":"eJztWN1y2zYWfpVT5GKbDCVRtpx0dVVPk3q829lkYncyU1vjAckjETEIoACon9Hwbp+kj9Yn6RyQlChLdqy2k6veJBZ4/s93foA183zm2PiGvdVpWaDyjk0ilqFLrTBeaMXG7MWLF9B+huuVQTe+VR/RW4FzBA5SOA96ClkrAhLuMAOtwK8M3qpbNezDq1dvLZ/6jSQ3fvXqVgEA9LZn4HPugVuEtLQWlZcrEAqywOk896Xrk7wTknepeh+snll07k9JNQ1zkHhKEn/QhZHoMXuOvJzPERJEBa5MU3RuWkq5gnQjYyF8DlxKsPhrKSxm4MRMcV9arHWOSOe7pQnfnqsRG3qusuCS0iC1mqEFHqwQicQg/SzEHFMp1LEOZS1XsgKfI5QObf9WsYhpg5YTLi4zNmYz9G3SCQQsYoZbXqBHS6BaM8ULZGOW6ZSQwCImCFCG+5w9RNl1jgEuu0jyGmyDNBaxNpBs7G2JEXN+JUm+ExRzFjFcGqkzZOMpl44I0hwLzsZrFvSPmfNWqBlRqrIg3AdoBcNaOLCIbXJYiwwqyd46KmxSVdHGNykK4VvPfi3RrnYMbQ1pLJ1qW3TtbPzYmFnwpSjIsrM4jlqjVVkkaFlFfDx4Oh7GHRPcvTB/mwWP64yrCcl1RiuHjmhP4pj+203kthpgg5YQU+VReaLnxkiRhg+Dz46Y1vsG6OQzpgFSlsR4Uau06ErpO3TcWk4OC4+F+zJ/fUzo3ccEhYb7HZS0vrMfL8T9yWmS//wfislU0OFxEnLvjRsPBs1JaWU/1QVJ88IfL86FP6hUSITS/mgJRiJ3GJrSpuKCc1pmaL9WKGsMHyehthACa7UNIGu9uGtcqCKmF2rHl2fJ/6xDIyR+ik7oZn8WcFYfzu1WW4r6qUAcNAsLLuQXqRPE75uDFmsm1+oLakZnr0+Gp9+9GRL9QmQz9H/B//rrvr7dpnEupV5gBnMuS3TQ247KiOZ+YfpfKoeWnoxe7jeyDvfmZMN9MhpVEVsdyfVmSPE5kun0uypi+ZFMo9eUOT7DI/mG3eLwWBjJPd5d1ZC+a1NbPUUV6suhyi7Ve7vbFhKtJXLVVUjDpIpYapF7zM7900A7iU9Oe8O4F7+5Hr4ej/49Pnvdj+P4FxaxZRHQ3e4P3CPr1nnzuzTZV9GDiicSr3X5PPctZsJi6u9Ke7BGn8IxqeNUDHeFzsS0GZPuab1hxJPdbfLEwaa81dIhBOFAK7kCPudCkp+wyFGFva/tp0TT5BSmVhfAoZXQDwB5EMbOMHnYmnfRJhRtVHftUnF3Esd3IyKpIjaKR/vLxUc02npQ2m/t/ebv2y7QWn1wWmxDd9iCp5waxaO7s41TZ/tOXao5lyKD8w+XcK3vUX1dj7rqfa1+P6eiJgrf2Y6z3fPaSYdpaYVfhSvAsseN6NXfxzcT2iEL9Llu7g/hzuBzNmaD7lVisG7uDBUjeXbe3ihCSW12KcdVluhlXxtUNAEkTxxNugE3YjCnAfaQgxtzBDWWveMYnOczoWZPc022IbqiNNaZ2gnUdtoa8V+kcdvkoUvVrPw58rDsVPR7qgNzk533BhU18pDb+XBv7H5CmeoC6ZpF9d6S//7/3wJHm5EAvW/gfWnB6AVa2u3p/jmVuKT7ZiAOXcvBSpckziEvJDoXrtoeZ5Z7hEzMhOcyDHehZpBywxMhBYGVyDRxW+jg3fXhU44+R0uf/mXpvSHDOUrCOEit70mO18BLr4ugo+1ZC23vp2RSBByS0glFDwUOsWVBlXOVIrS5iEBb4ApQebTGCofARUHEU20Bp1ORChJMlWl56qHgis+QlEVAdlMUjNVzkaEDq5PSeXBalsER0lgg+tpFhZi5PrwVc6wdp8MMPRcSM5iVJCKCVGd04Q+FSm6oDBJ0HgypFykGoc5z60HiHG3AXsgkvUWA0dRBBJd0p+7mlgR5y5WjSVQb1KZmEz5jNV3jgo6Mr/pAbwpXBJbSIQFACnVPL0E9uNnA7BMmTnicfNvWw2Kx2KuDl7s8F8LnZQIWjd7yzcJhqJou++bHS5rduwWzi2yLU7TkTYjRDBUGBHIj6h4HN+cfLkOzhRyl2Womlv3SpdMBEQ6u0HuhZm7Q8r+kdkiY4Gno1s1qTpX7/UM5oXOiLdz76RXauUjbi+EjoRoE4gGLmBQpKoedjnx+8eEnmMNpP2ZRpws9I3iDny5/ePe/q3dkDTXWOmLDftyPwxVBO19w1VF1gdt3u/q5L2wB9YPcw6ay3o6uf54O/3k63DwdNgPN49IPjOQirBHNhlyvADfswWviuH04nEQs184TyXpNEPnZyqqi4/q9izaDTDjaxbYvXve46rzPhZtlvWA/Sts8pG1JJ/TDCqI9rONR5H/7scncS3jOy+bB4LQrgFp1jWqNbWNTTehGWe8AZGP99TxN0XT93lsidzaxi3fXLGK89Pnu7nEfdo/mD5J+0KbdpaQ2gP6lUB9kWK/rvaaqNvT1p0c5GgdbagrQpKqqPwC+ZYbZ","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),p=n(33617),l=n.n(p),a=n(17543),o=n.n(a),m=n(86013),d=n.n(m),c=n(63723),u=n.n(c),h=(n(18766),n(79329),n(9303));const y={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:"eJztWN1y2zYWfpVT5GKbDCVRtpx0dVVPk3q829lkYncyU1vjAckjETEIoACon9Hwbp+kj9Yn6RyQlChLdqy2k6veJBZ4/s93foA183zm2PiGvdVpWaDyjk0ilqFLrTBeaMXG7MWLF9B+huuVQTe+VR/RW4FzBA5SOA96ClkrAhLuMAOtwK8M3qpbNezDq1dvLZ/6jSQ3fvXqVgEA9LZn4HPugVuEtLQWlZcrEAqywOk896Xrk7wTknepeh+snll07k9JNQ1zkHhKEn/QhZHoMXuOvJzPERJEBa5MU3RuWkq5gnQjYyF8DlxKsPhrKSxm4MRMcV9arHWOSOe7pQnfnqsRG3qusuCS0iC1mqEFHqwQicQg/SzEHFMp1LEOZS1XsgKfI5QObf9WsYhpg5YTLi4zNmYz9G3SCQQsYoZbXqBHS6BaM8ULZGOW6ZSQwCImCFCG+5w9RNl1jgEuu0jyGmyDNBaxNpBs7G2JEXN+JUm+ExRzFjFcGqkzZOMpl44I0hwLzsZrFvSPmfNWqBlRqrIg3AdoBcNaOLCIbXJYiwwqyd46KmxSVdHGNykK4VvPfi3RrnYMbQ1pLJ1qW3TtbPzYmFnwpSjIsrM4jlqjVVkkaFlFfDx4Oh7GHRPcvTB/mwWP64yrCcl1RiuHjmhP4pj+203kthpgg5YQU+VReaLnxkiRhg+Dz46Y1vsG6OQzpgFSlsR4Uau06ErpO3TcWk4OC4+F+zJ/fUzo3ccEhYb7HZS0vrMfL8T9yWmS//wfislU0OFxEnLvjRsPBs1JaWU/1QVJ88IfL86FP6hUSITS/mgJRiJ3GJrSpuKCc1pmaL9WKGsMHyehthACa7UNIGu9uGtcqCKmF2rHl2fJ/6xDIyR+ik7oZn8WcFYfzu1WW4r6qUAcNAsLLuQXqRPE75uDFmsm1+oLakZnr0+Gp9+9GRL9QmQz9H/B//rrvr7dpnEupV5gBnMuS3TQ247KiOZ+YfpfKoeWnoxe7jeyDvfmZMN9MhpVEVsdyfVmSPE5kun0uypi+ZFMo9eUOT7DI/mG3eLwWBjJPd5d1ZC+a1NbPUUV6suhyi7Ve7vbFhKtJXLVVUjDpIpYapF7zM7900A7iU9Oe8O4F7+5Hr4ej/49Pnvdj+P4FxaxZRHQ3e4P3CPr1nnzuzTZV9GDiicSr3X5PPctZsJi6u9Ke7BGn8IxqeNUDHeFzsS0GZPuab1hxJPdbfLEwaa81dIhBOFAK7kCPudCkp+wyFGFva/tp0TT5BSmVhfAoZXQDwB5EMbOMHnYmnfRJhRtVHftUnF3Esd3IyKpIjaKR/vLxUc02npQ2m/t/ebv2y7QWn1wWmxDd9iCp5waxaO7s41TZ/tOXao5lyKD8w+XcK3vUX1dj7rqfa1+P6eiJgrf2Y6z3fPaSYdpaYVfhSvAsseN6NXfxzcT2iEL9Llu7g/hzuBzNmaD7lVisG7uDBUjeXbe3ihCSW12KcdVluhlXxtUNAEkTxxNugE3YjCnAfaQgxtzBDWWveMYnOczoWZPc022IbqiNNaZ2gnUdtoa8V+kcdvkoUvVrPw58rDsVPR7qgNzk533BhU18pDb+XBv7H5CmeoC6ZpF9d6S//7/3wJHm5EAvW/gfWnB6AVa2u3p/jmVuKT7ZiAOXcvBSpckziEvJDoXrtoeZ5Z7hEzMhOcyDHehZpBywxMhBYGVyDRxW+jg3fXhU44+R0uf/mXpvSHDOUrCOEit70mO18BLr4ugo+1ZC23vp2RSBByS0glFDwUOsWVBlXOVIrS5iEBb4ApQebTGCofARUHEU20Bp1ORChJMlWl56qHgis+QlEVAdlMUjNVzkaEDq5PSeXBalsER0lgg+tpFhZi5PrwVc6wdp8MMPRcSM5iVJCKCVGd04Q+FSm6oDBJ0HgypFykGoc5z60HiHG3AXsgkvUWA0dRBBJd0p+7mlgR5y5WjSVQb1KZmEz5jNV3jgo6Mr/pAbwpXBJbSIQFACnVPL0E9uNnA7BMmTnicfNvWw2Kx2KuDl7s8F8LnZQIWjd7yzcJhqJou++bHS5rduwWzi2yLU7TkTYjRDBUGBHIj6h4HN+cfLkOzhRyl2Womlv3SpdMBEQ6u0HuhZm7Q8r+kdkiY4Gno1s1qTpX7/UM5oXOiLdz76RXauUjbi+EjoRoE4gGLmBQpKoedjnx+8eEnmMNpP2ZRpws9I3iDny5/ePe/q3dkDTXWOmLDftyPwxVBO19w1VF1gdt3u/q5L2wB9YPcw6ay3o6uf54O/3k63DwdNgPN49IPjOQirBHNhlyvADfswWviuH04nEQs184TyXpNEPnZyqqi4/q9izaDTDjaxbYvXve46rzPhZtlvWA/Sts8pG1JJ/TDCqI9rONR5H/7scncS3jOy+bB4LQrgFp1jWqNbWNTTehGWe8AZGP99TxN0XT93lsidzaxi3fXLGK89Pnu7nEfdo/mD5J+0KbdpaQ2gP6lUB9kWK/rvaaqNvT1p0c5GgdbagrQpKqqPwC+ZYbZ",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,g={},j=[{value:"Document Types:",id:"document-types",level:3}];function f(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)(h.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)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,i.jsx)(o(),{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)(d(),{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 b(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink