mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-23 18:14:55 +02:00
1 line
7.5 KiB
JavaScript
1 line
7.5 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3633],{16138:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>h,default:()=>j,frontMatter:()=>g,metadata:()=>i,toc:()=>v});const i=JSON.parse('{"id":"API-docs/v1/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/v1/folderlist.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/folderlist","permalink":"/docs/API-docs/v1/folderlist","draft":false,"unlisted":false,"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":true,"hide_table_of_contents":true,"api":"eJy9V11uGzcQvgrDlzbGWlo5cYrqqUbhum6NxKgdBKgjGNzd0S4jLsmQs/qBICAPvUFv0KPlJMWQWmlly2ncpnmxvOTM8JsfzjdcchSl58Mb/pNRBTg+SngBPnfSojSaD/l1BSzusQvpkZ1cnjOorZmB82xhGoaGOUAnYQpMMEUyZszGUWUmsWIm/poGmRUONEZ75wVPuLHgBB11XvAhj1pkgyfcCidqQHCEb8m1qIEP+T0LklC+b8At+F3sJnsHOZ4XW0A84Q7eN9JBwYdjoTwk3ONCQTjc1TzhMLfKFLDdziuoBR8uOS4syXl0Upc8CQoCuyswF7UNxvhqlWwwK1lLvAv1s3Gga3Zg1GIu66bmw+M0TVpQuqkzcHzVwTBIOxD8RNovhuDhM9PViOx6a7QHT7JHaUo/u4nxTZ6D9+NGsU0B8ITnRiNoJHlhrZJ52Oi/86S0vA8g5pdKxZEZlPFIB75R2JETzglyWCLU/p/127J5bM5tNciq+dE7SyGJ9fYyRP9xZjTM2mpdJXfr/ZG2fjnSwh9P5CXctfVvkfkm66DLHQiE4gT3mdoqHqVHzw4H6WH63fXgxfD598PjF700TX/nCZ/XinTXZVoIDEhRoup+N7b4Cud0FqKLtw48X3XXpVZSw21b4rdHaXo7eEYyq4Q/31frV6YGrKQu2Qw0spkzukyYVSA8MHQLJkohNVMCwT35cpcAnDPu09F6HLJPReE5RWEThOP7QTjXU6FkEdjj2kxAf11Pu8djPJ6g7taEjEJhn+84212PTnrIGydxEZhpfiisPIz7w5sRtUAKrCFGKyFSGVZ8yPs7/ObBTVtya5ziQ14hWj/s973QRWbmPWNBe1lqJTLfy03dF1b2pwNOfX1XQ1j7CGloDh+n4FGUUpef1hptw3JFqYvZ2QnOtiNb+StQS17Hviu1ZqkKRGgyK/oem6C8zsgrC/pKljrkczq4x/tvQOWmBhpNsALWin/846+gUZi8qUFjKLcnb/Vb/apxLIw0xEhCF2ysYC4zBXvHHQ+iVuC9WjCpEUonEFghS4lCMQoNXalcWJFJJalKScyQtmOdQvc99qYCrMDR1jeOxqcCpqCouJlo0NQCyVSLl82Mm4yVmfmECZY1XmrwnoGuhM5JsA1/QiOX0Aw0grNOemAeHaGWEZvR6ESOrBZalEC2k50oFaAk1SZzJms8Mm9UEyAzFFIZBwVrHdIAhe9REE9pXHDAaDU3tXVQUaVMgZWNLMAnLDcFMB8uJbmgC5aBR2YJi8zBk9FGK5NPQt7GjVLMGuoRUiga4roYSR2d0J4YK2Jpc7AJmHWG5gyIAA8OXnugDF9IPfHDg4O3+pDdbIrpDWReIoy+bat+Npvdq/anuzpnEn9uMvYbWOMlGrfYapcSqyYLN6RrZPMRLZ2BhlA/nRuwtVGY3N+/cLTar0DZ/hUgVYjvn1yeh7b6lH388Ce7AOE0q8wsVmveOFALVrZHUeRi5mPYNl2RjU0ovIoinsfioyERPFIEiUV3b/PutXMwBkfBD4ncHmfl2vxNC5MR+v/iZpg9jEaRB/qAWkgV28oPd+2EVg6u9q/GV+CmMod1Y3sgw/0g3OcJVzIH7aFDESdnlxdsyp71Up50WuRnZLt/cf7j6curU0JDNytGbNBLe2mYzIzHWujOUWeA7SNqzRc7wV5u2fP/fqKtWzbCHPtWCRnIMTi/XBPbTffhNkp4ZTzS6nKZCQ+vnVqtaDm+O4juCulFpjovjwd92/uE24toAot9z8OpUE18kCV7zo1K7fvsc2TXD6mt6Ig+nCTZwP5Jy1zkaNQ5yXOw3QPujTs7M8PZ6TVPON3DXcacBMZc/0PW2y296NjepdIIgP6ST3sVlsvIxqvVRj5uPaixdrCVpviPVqvV3+R9qgM=","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Folder","permalink":"/docs/API-docs/v1/deletefolder"}}');var r=o(74848),n=o(28453),s=o(33617),l=o.n(s),a=o(17543),p=o.n(a),d=o(86013),c=o.n(d),m=o(63723),u=o.n(m),f=(o(18766),o(79329),o(9303));const g={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:"eJy9V11uGzcQvgrDlzbGWlo5cYrqqUbhum6NxKgdBKgjGNzd0S4jLsmQs/qBICAPvUFv0KPlJMWQWmlly2ncpnmxvOTM8JsfzjdcchSl58Mb/pNRBTg+SngBPnfSojSaD/l1BSzusQvpkZ1cnjOorZmB82xhGoaGOUAnYQpMMEUyZszGUWUmsWIm/poGmRUONEZ75wVPuLHgBB11XvAhj1pkgyfcCidqQHCEb8m1qIEP+T0LklC+b8At+F3sJnsHOZ4XW0A84Q7eN9JBwYdjoTwk3ONCQTjc1TzhMLfKFLDdziuoBR8uOS4syXl0Upc8CQoCuyswF7UNxvhqlWwwK1lLvAv1s3Gga3Zg1GIu66bmw+M0TVpQuqkzcHzVwTBIOxD8RNovhuDhM9PViOx6a7QHT7JHaUo/u4nxTZ6D9+NGsU0B8ITnRiNoJHlhrZJ52Oi/86S0vA8g5pdKxZEZlPFIB75R2JETzglyWCLU/p/127J5bM5tNciq+dE7SyGJ9fYyRP9xZjTM2mpdJXfr/ZG2fjnSwh9P5CXctfVvkfkm66DLHQiE4gT3mdoqHqVHzw4H6WH63fXgxfD598PjF700TX/nCZ/XinTXZVoIDEhRoup+N7b4Cud0FqKLtw48X3XXpVZSw21b4rdHaXo7eEYyq4Q/31frV6YGrKQu2Qw0spkzukyYVSA8MHQLJkohNVMCwT35cpcAnDPu09F6HLJPReE5RWEThOP7QTjXU6FkEdjj2kxAf11Pu8djPJ6g7taEjEJhn+84212PTnrIGydxEZhpfiisPIz7w5sRtUAKrCFGKyFSGVZ8yPs7/ObBTVtya5ziQ14hWj/s973QRWbmPWNBe1lqJTLfy03dF1b2pwNOfX1XQ1j7CGloDh+n4FGUUpef1hptw3JFqYvZ2QnOtiNb+StQS17Hviu1ZqkKRGgyK/oem6C8zsgrC/pKljrkczq4x/tvQOWmBhpNsALWin/846+gUZi8qUFjKLcnb/Vb/apxLIw0xEhCF2ysYC4zBXvHHQ+iVuC9WjCpEUonEFghS4lCMQoNXalcWJFJJalKScyQtmOdQvc99qYCrMDR1jeOxqcCpqCouJlo0NQCyVSLl82Mm4yVmfmECZY1XmrwnoGuhM5JsA1/QiOX0Aw0grNOemAeHaGWEZvR6ESOrBZalEC2k50oFaAk1SZzJms8Mm9UEyAzFFIZBwVrHdIAhe9REE9pXHDAaDU3tXVQUaVMgZWNLMAnLDcFMB8uJbmgC5aBR2YJi8zBk9FGK5NPQt7GjVLMGuoRUiga4roYSR2d0J4YK2Jpc7AJmHWG5gyIAA8OXnugDF9IPfHDg4O3+pDdbIrpDWReIoy+bat+Npvdq/anuzpnEn9uMvYbWOMlGrfYapcSqyYLN6RrZPMRLZ2BhlA/nRuwtVGY3N+/cLTar0DZ/hUgVYjvn1yeh7b6lH388Ce7AOE0q8wsVmveOFALVrZHUeRi5mPYNl2RjU0ovIoinsfioyERPFIEiUV3b/PutXMwBkfBD4ncHmfl2vxNC5MR+v/iZpg9jEaRB/qAWkgV28oPd+2EVg6u9q/GV+CmMod1Y3sgw/0g3OcJVzIH7aFDESdnlxdsyp71Up50WuRnZLt/cf7j6curU0JDNytGbNBLe2mYzIzHWujOUWeA7SNqzRc7wV5u2fP/fqKtWzbCHPtWCRnIMTi/XBPbTffhNkp4ZTzS6nKZCQ+vnVqtaDm+O4juCulFpjovjwd92/uE24toAot9z8OpUE18kCV7zo1K7fvsc2TXD6mt6Ig+nCTZwP5Jy1zkaNQ5yXOw3QPujTs7M8PZ6TVPON3DXcacBMZc/0PW2y296NjepdIIgP6ST3sVlsvIxqvVRj5uPaixdrCVpviPVqvV3+R9qgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},h=void 0,y={},v=[];function P(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(f.default,{as:"h1",className:"openapi__heading",children:"Get folder list"}),"\n",(0,r.jsx)(l(),{method:"get",path:"/folderlist",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,r.jsx)(f.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(p(),{parameters:[{name:"parentFolderId",in:"query",description:"objectId of folder",required:!1,style:"form",explode:!1,schema:{type:"string",format:"string",example:""}},{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,r.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,r.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:"ph1bhx2jp"},folderName:{type:"string",format:"string",example:"new folder"},parentFolderId:{type:"string",format:"string",example:"J2nas5kiPe"},parentFolderName:{type:"string",format:"string",example:"new sub folder"},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"}},title:"folder_res"}}},title:"inline_response_200_13"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},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 j(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(P,{...e})}):P(e)}}}]); |