mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-11 12:17:41 +02:00
1 line
7.3 KiB
JavaScript
1 line
7.3 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>y,contentTitle:()=>I,default:()=>j,frontMatter:()=>f,metadata:()=>d,toc:()=>N});const d=JSON.parse('{"id":"API-docs/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","source":"@site/docs/API-docs/getfolder.api.mdx","sourceDirName":"API-docs","slug":"/API-docs/getfolder","permalink":"/docs/API-docs/getfolder","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar_label":"Get Folder","hide_title":true,"hide_table_of_contents":true,"api":"eJy9V9tu3DYQ/ZUJX5oY8l4cJ231VKNwHbdGYsQOAtRZGJQ0KzGmSIYc7QULAX3oH/QP+mn5kmKovdqOUbdBXuwVOTM8c+Gc4UKQLINIr8QvVhfoxSgRBYbcK0fKGpGKywrhBAm6fTg6PwWptZ0GmNsGyIJH8gonCAWSVDqAzGxDICE4zNVY5TCOqj2RCOvQSzZ8WohUlEjdlkiEk17WSOgZzEIYWaNIRbd9rQqRCMVonKRK3IZos4+Y02kBdgxrgx4/NcpjIVLyDSYi0FyzyaBqp1EkAmdO2wJFOpY6sEBeYS1FuhA0d1GSvDKlSMTY+lrS9grOZLSSCvdqmFX5QeUy0bYjPjY4awIGNnQwGPC/XbShyXMMYdxoWIdDJCK3htAQy0vntMrjRv9jYKXFXXSd0xw5z2ZIdUeuYvFoP6phVs0OPjrRJsuwv445eJwZg9NVCtqYVDTUVc7jIf16YGR4caPO8bat/4osNNkWutyjJCyO6D5TG8WDwcHz/eFgf/D95fBlevhj+uJlbzAY/C4SMas16y6LtZAUkZIivf3duOIbnLO1sLw1HoNoW944vK8OL2yNVClTwhQNwdRbUybgNMqAQH4OspTKgJaE/snXK1D03vqHI/E4ZNueK6OVwevVJbw+HAyuh+sgHN4NQhcqMJZgbBtT9L6Bow9V6V08D7t3eP3D2r0Xd907NROpVRG79qW9QfNtE7l9PHXHM9TdcladUNwXO85ur3dOBswbr2geOWK2L53a7/bTqxF3X64bu6SWSCpUiVT0u6j2F2s6aQXb8pMV3TRei1RURC6k/X6QpsjsrGcdmqBKo2UWermt+9Kp/mQo2uS2hnTuEdLY7D9OIZAslSkf1hptwnPBKeyytBOkda6kU7/hXCSrHGxLLZm2Qhn7ZMvfYxuVl5l549BcqNLEvE6Gd/j4Perc1sjDAVUIK/HPf/4dNQqbNzUaimX35IP5YN40HpydomdSlKaAscaZyjRGeazj3nrgCChrjSHoOShDWHpJCIUqFUkNHBruHLl0MlNacbWymGVtD1sFH3rwvkKq0PPWdx5BQoET1FzkIBuytSQ2tcILU+tvxjz6JCAha4IyGAKgqaTJWXAV/gSsB2kADaF3XgWEQJ5Rqw6bNeRlTlBLI0tk28lOlArUimsTvM2aQBCsbiJk4AnLeixg5ZBBLEKPg3jM84xH4NXc1s5jxZUyQSgbVWBIILcFQoiXk10wBWQYCBxjUTkGNtoYbfObmLdxozU4y71CSc3D1TZGVicvTeB21mFZ5WAdMOctjzrYAdzbexeQM3ymzE1I9/Y+mH24WhfTe8yCIhw9XVX9dDq9U+3PdnVOFL1qMniLzgZF1s832qWiqsniDdk2sv7oLJ2gwVg/WzdgY6Owebh74Xi1X6F2/QskrpDQPzo/je31GXz+4y84Q+kNVHbaVWveeNRzKFdHceS6zHdhW3dHGNtYeBVHPO+Kj8dYDMQR5EFg9zbvXjuPY/Qc/JjIzXFOLc1frWACo/8/bsbxyRqSeaQRrKXSXVv56bad2NLR1+HN+AL9ROW4bGxfyHA/CvdFIrTK0QTcooqjk/MzmMDz3kAkWy3yX2S7f3b68/Hri2NGwzeri9iwN+gN4nBpA9XSbB21efLcbm+LDYF+3cfRsjcTzqjvtFSRDaOXiyWTXYn18ybdPI1GiahsIN5eLDIZ8J3XbcvLnxr0zJWjREykVzLj9n21EIUK/LtYv32+6ODTt8tn1DO495V1L+YVyRhmmInUDX+JRNzgfOdN147aZMUzDKvbP8pzdLSleWdI2WH6k+NLkQi+Nbv8dhP5bfmDrd+Lapf4OgD8lzn4XoXFouPOtl3Ld1tf1Fg6uJLmEI3atv0HtWBjWg==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Folder","permalink":"/docs/API-docs/createfolder"},"next":{"title":"Update Folder","permalink":"/docs/API-docs/updatefolder"}}');var r=o(74848),s=o(28453),a=o(33617),i=o.n(a),n=o(17543),l=o.n(n),c=o(86013),p=o.n(c),b=o(63723),g=o.n(b),m=(o(18766),o(79329),o(9303));const f={id:"getfolder",title:"Get Folder",description:"The Get Folder API allows you to retrieve details about a specific folder.",sidebar_label:"Get Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V9tu3DYQ/ZUJX5oY8l4cJ231VKNwHbdGYsQOAtRZGJQ0KzGmSIYc7QULAX3oH/QP+mn5kmKovdqOUbdBXuwVOTM8c+Gc4UKQLINIr8QvVhfoxSgRBYbcK0fKGpGKywrhBAm6fTg6PwWptZ0GmNsGyIJH8gonCAWSVDqAzGxDICE4zNVY5TCOqj2RCOvQSzZ8WohUlEjdlkiEk17WSOgZzEIYWaNIRbd9rQqRCMVonKRK3IZos4+Y02kBdgxrgx4/NcpjIVLyDSYi0FyzyaBqp1EkAmdO2wJFOpY6sEBeYS1FuhA0d1GSvDKlSMTY+lrS9grOZLSSCvdqmFX5QeUy0bYjPjY4awIGNnQwGPC/XbShyXMMYdxoWIdDJCK3htAQy0vntMrjRv9jYKXFXXSd0xw5z2ZIdUeuYvFoP6phVs0OPjrRJsuwv445eJwZg9NVCtqYVDTUVc7jIf16YGR4caPO8bat/4osNNkWutyjJCyO6D5TG8WDwcHz/eFgf/D95fBlevhj+uJlbzAY/C4SMas16y6LtZAUkZIivf3duOIbnLO1sLw1HoNoW944vK8OL2yNVClTwhQNwdRbUybgNMqAQH4OspTKgJaE/snXK1D03vqHI/E4ZNueK6OVwevVJbw+HAyuh+sgHN4NQhcqMJZgbBtT9L6Bow9V6V08D7t3eP3D2r0Xd907NROpVRG79qW9QfNtE7l9PHXHM9TdcladUNwXO85ur3dOBswbr2geOWK2L53a7/bTqxF3X64bu6SWSCpUiVT0u6j2F2s6aQXb8pMV3TRei1RURC6k/X6QpsjsrGcdmqBKo2UWermt+9Kp/mQo2uS2hnTuEdLY7D9OIZAslSkf1hptwnPBKeyytBOkda6kU7/hXCSrHGxLLZm2Qhn7ZMvfYxuVl5l549BcqNLEvE6Gd/j4Perc1sjDAVUIK/HPf/4dNQqbNzUaimX35IP5YN40HpydomdSlKaAscaZyjRGeazj3nrgCChrjSHoOShDWHpJCIUqFUkNHBruHLl0MlNacbWymGVtD1sFH3rwvkKq0PPWdx5BQoET1FzkIBuytSQ2tcILU+tvxjz6JCAha4IyGAKgqaTJWXAV/gSsB2kADaF3XgWEQJ5Rqw6bNeRlTlBLI0tk28lOlArUimsTvM2aQBCsbiJk4AnLeixg5ZBBLEKPg3jM84xH4NXc1s5jxZUyQSgbVWBIILcFQoiXk10wBWQYCBxjUTkGNtoYbfObmLdxozU4y71CSc3D1TZGVicvTeB21mFZ5WAdMOctjzrYAdzbexeQM3ymzE1I9/Y+mH24WhfTe8yCIhw9XVX9dDq9U+3PdnVOFL1qMniLzgZF1s832qWiqsniDdk2sv7oLJ2gwVg/WzdgY6Owebh74Xi1X6F2/QskrpDQPzo/je31GXz+4y84Q+kNVHbaVWveeNRzKFdHceS6zHdhW3dHGNtYeBVHPO+Kj8dYDMQR5EFg9zbvXjuPY/Qc/JjIzXFOLc1frWACo/8/bsbxyRqSeaQRrKXSXVv56bad2NLR1+HN+AL9ROW4bGxfyHA/CvdFIrTK0QTcooqjk/MzmMDz3kAkWy3yX2S7f3b68/Hri2NGwzeri9iwN+gN4nBpA9XSbB21efLcbm+LDYF+3cfRsjcTzqjvtFSRDaOXiyWTXYn18ybdPI1GiahsIN5eLDIZ8J3XbcvLnxr0zJWjREykVzLj9n21EIUK/LtYv32+6ODTt8tn1DO495V1L+YVyRhmmInUDX+JRNzgfOdN147aZMUzDKvbP8pzdLSleWdI2WH6k+NLkQi+Nbv8dhP5bfmDrd+Lapf4OgD8lzn4XoXFouPOtl3Ld1tf1Fg6uJLmEI3atv0HtWBjWg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},I=void 0,y={},N=[];function h(e){const t={p:"p",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(m.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,r.jsx)(i(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,r.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,r.jsx)(m.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,r.jsx)(l(),{parameters:[{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}]}),"\n",(0,r.jsx)(p(),{title:"Body",body:void 0}),"\n",(0,r.jsx)(g(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{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"}}}},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"}}}},404:{description:"folder not found.",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",format:"string",example:"folder not found."}},title:"inline_response_404_8"}}}},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,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}}}]); |