WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-07 18:27:41 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef74da02c706f6aefbfc8b41c4e95a6d7d7ca9ab
OpenSign/assets/js/451a5132.95befe47.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7286],{12072:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),d=(a(82723),a(9487)),o=a(41429),m=a(5397),p=a(4667),c=a(9472),h=a(85162);const x={id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",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/folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",source:"@site/docs/API-docs/folderlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/folderlist",permalink:"/docs/API-docs/folderlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"folderlist",title:"Get folder list",description:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId",sidebar_label:"Get folder list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/LJM8l+8cnhvXkqAMcnwtf7W6QC8niSww5F45UtbIsbyqULRn4kIFEqdvzwXWzi7QB7GyjSArPJJXOEcBQjONnYppy7JQVAnbfm1DwoFHQ62880Im0jr0wKrOCzmWLRfLkIl04KFGQs/41tJAjXIs70hQjPJjg34lb2O32QfM6bzYA5KJ9PixUR4LOZ6CDpjIQCuNUbmvZSJx6bQtcH+cV1iDHK8lrRzTBfLKlDKJDED9HVxC7aIwudkkO8xa1YpuQ/1sHOSbAxg1LFXd1HJ8kqZJB8o0dYZebnoYRmkPQpgp98UQPKwz3UxYbnDWBAxMe5ym/Dm8mNDkOYYwbbTYBYBMZG4NoSGmB+e0yuPB8ENgpvVdAO39cqh4FkOqVekxNJp6dOA9sMGKsA7/zt+FzWPv3FWjrFoef3DskjbeXkfvP06MwUUXrZvkdrw/UtZvxwbCyUy9xduy/iuy0GQ9dLlHICxO6T5Re8bj9PjZ0Sg9Sr+7Gr0YP/9+fPJikKbpHzKRy1oz7zZMC6CIlBTp/rpxxVfQ09toTbzxGOSmv6+MVgZvuhC/OU7Tm9Ezptkk8vl9sX5pa6RKmVIs0JBYeGvKRDiNEFCQXwkoQRmhgdA/+XJJgN5b/2lvPQ7Zp7zwnL2wc8LJXSecmzloVcTucWVnaL6upX311KpnqIcxoVqieC4PjO3vt0YGzBuvaBU70/IInDpqz8fXEy6B7FjLHa3EtpVRJcdyeNDfAvp519war+VYVkQujIdDcG5gHZqgSqMhC4Pc1kNwajgfSa7ph9SBoFSmPPok12SP+ZL92rruAPm+XDr1Crlebh3Tp9q2kAohVoANr6c2Mm/d9cahuVSlic6ej+405Xeoc1sjzw1UoejI//7zr8hR2Lyp0VCMhSfiTeNFHDa4V4ApxFTjUmUaIzFobRe7MSQg1BpD0CuhDGHpgVAUqlQEWrBXONRzcJAprTh6mMwytxe9AAwD8a5CqtDz0Teex5oC56g56IS2dsZyyApoyNZRxxazWFg/mzKkRIDImqAMhiACYseCpgKTo+juIuHhCIxAQ+idVwEFqJqJp9YLnE5Vrlgwp4qHnEQNBkpkZYlg3OwF5+1cFRiEt1kTSASrm2gIa6wRqTXRIBZhIH5Rc2wN580CCZTGQpQNi0hEbgsU28xhM0whMgwkHKtXOUahgcCT0DhHH2Mv3uS00Vo4yymtQPPM1b9bFkQeTOAG0wLqrmbnPuctjwVRRwGrgXhv3huuUqIJyAGglZmF8XtzJK53YfYOs6AIJ992+bBYLO7kwdNDnjNFVZMJj87u+cq4GbOmz75bPJWJJPR1eDO9RD9XOW6T8AGdw0g83BY6yGOhwxqUbnPsp9sMXHS0ytEE7JWl07O3F2Iung1SmfQy/zMADy/Of375+vIly+VK0+bfaJAO0jgN2EA1mJ6qM6RucN/WqIPUXe8r9v/9LNhWIsIlDZ0GFQtyNH69LabX/cfCJJGVDcS763UGAX/3erPh7XbW5RJbqACZ7k27D9p277PhXkQzXN33JJmDbtpHQHKP3papexN8Du12eN+TTnjhFdPGjpN0BZkNbXlO8xxdX8GdFnvQp85eXslEQsOu7TeCWWwE2z8svTsyq57sww7RAuBftulehh84Xl7h6scdeXvyIMPWvo6a3T/ZbDb/AMShFlE=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,r.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 folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\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:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(p.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:"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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.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)(p.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)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "parentFolderName": "new sub folder",\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:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(p.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink