WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 22:14:58 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
d8482872609d28cd99bb4287eebd62b0bf358ef8
OpenSign/assets/js/451a5132.08d2a181.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:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),i=a(11151),r=a(58219),n=(a(62316),a(51039)),t=a.n(n),o=(a(82723),a(9487)),d=a(41429),m=a(5397),c=a(4667),p=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/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh0NwbmAdmqBKoyELg9zWQ3BqOB9J7umH1IGgVKY8eiQXmCKzy4c5JnsrLzkSrbMPbN03WKdeIXfYrSv7VNuhUyHEnrHh76mNzFsHv3FoLlVpYnjmoztj/B3q3NbImwZVKDryv//8K3IUNm9qNBSz54l403gR1xOeLmAKMdW4VJnGSAxa28VucQkItcYQ9EooQ1h6IBSFKhWBFuwVLo4cHGRKK843JrPM7UUvZcNAvKuQKvR89Y3nRajAOWpOU6GtnbEcsgIasnXUscUsFtbPpgwpESCyJiiDIYiA2LGgqcDkKLpYJLxOgRFoCL3zKqAAVTPx1HqB06nKFQvm4vKQk6jBQImsLBGMm73gvJ2rAoPwNmsCiWB1Ew1hjTUitSYaxCIMxC9qjq3hfFgggdJYiLJhEYnIbYFiW2tshilEhoGEY/Uqxyg0EHgSGufoY7bGSE4brYWz3AQUaN7S+rFlQeTBBB5JLaAuNDv3OW95kYg6ClgNxHvz3nBfE01ATgCtzCyM35sjcb1Ls3eYBUU4+barhcVicacOnh7ynCmqmkx4dHbPV8bDWDV99t3HU5lIQl+HN9NL9HOV47YAH9A5jMTDbWuEPLZGrEHptsZ+us3AbUqrHE3AXiM7PXt7Iebi2SCVSa/qPwPw8OL855evL1+yXO5Nbf2NBukgjfuDDVSD6ak6Q+pW/W1XOyjd9b7H/98PiW0nIlzS0GlQsYVH49fb9nvdf15MElnZQHy6XmcQ8HevNxs+brdjbsqFCpDp3n78oG33PjTuRTTD1X2PmDnopn02JPfobZm6V8Tn0G7X/T3phD+8Yto4o5KuIbOhLc9pnqPrK7gzlA8m29nLK5lIaNi1/UEwi4Ng+w9L767Mqif7cEK0APgv23Qvww+cL69w9eOOvL15kGFrX0fN7p9sNpt/AOPFKCM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={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/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh0NwbmAdmqBKoyELg9zWQ3BqOB9J7umH1IGgVKY8eiQXmCKzy4c5JnsrLzkSrbMPbN03WKdeIXfYrSv7VNuhUyHEnrHh76mNzFsHv3FoLlVpYnjmoztj/B3q3NbImwZVKDryv//8K3IUNm9qNBSz54l403gR1xOeLmAKMdW4VJnGSAxa28VucQkItcYQ9EooQ1h6IBSFKhWBFuwVLo4cHGRKK843JrPM7UUvZcNAvKuQKvR89Y3nRajAOWpOU6GtnbEcsgIasnXUscUsFtbPpgwpESCyJiiDIYiA2LGgqcDkKLpYJLxOgRFoCL3zKqAAVTPx1HqB06nKFQvm4vKQk6jBQImsLBGMm73gvJ2rAoPwNmsCiWB1Ew1hjTUitSYaxCIMxC9qjq3hfFgggdJYiLJhEYnIbYFiW2tshilEhoGEY/Uqxyg0EHgSGufoY7bGSE4brYWz3AQUaN7S+rFlQeTBBB5JLaAuNDv3OW95kYg6ClgNxHvz3nBfE01ATgCtzCyM35sjcb1Ls3eYBUU4+barhcVicacOnh7ynCmqmkx4dHbPV8bDWDV99t3HU5lIQl+HN9NL9HOV47YAH9A5jMTDbWuEPLZGrEHptsZ+us3AbUqrHE3AXiM7PXt7Iebi2SCVSa/qPwPw8OL855evL1+yXO5Nbf2NBukgjfuDDVSD6ak6Q+pW/W1XOyjd9b7H/98PiW0nIlzS0GlQsYVH49fb9nvdf15MElnZQHy6XmcQ8HevNxs+brdjbsqFCpDp3n78oG33PjTuRTTD1X2PmDnopn02JPfobZm6V8Tn0G7X/T3phD+8Yto4o5KuIbOhLc9pnqPrK7gzlA8m29nLK5lIaNi1/UEwi4Ng+w9L767Mqif7cEK0APgv23Qvww+cL69w9eOOvL15kGFrX0fN7p9sNpt/AOPFKCM=",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"}},j={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,i.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)(t(),{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)(d.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)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(d.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)(r.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)(o.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)(c.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(c.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)(c.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)(o.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)(c.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)(o.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)(c.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 v(e={}){const{wrapper:s}={...(0,i.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