mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-30 05:24:56 +02:00
1 line
7.1 KiB
JavaScript
1 line
7.1 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9983],{96522:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>h,contentTitle:()=>f,default:()=>k,frontMatter:()=>b,metadata:()=>i,toc:()=>v});const i=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":"eJy9V91u2zYUfpVT3qwBFNtJ027T1YKty7IVbbBkKLDUCCjpSGJDkSx55B8YutuT7NH2JMOhbEeO02AZit4kFs//33fIlSBZBZFei5+tLtCLaSIKDLlXjpQ1IhVXNcIZEvR0OL04B6m1nQdY2hbIgkfyCmcIBZJUOoDMbEsgITjMValyKKPoSCTCOvSSFZ8XIhUVUk8SiXDSywYJPTuzEkY2KFLRk29UIRKh2BsnqRb3XbTZR8zpvABbwlahx0+t8liIlHyLiQi01KwyqMZpFInAhdO2QJGWUgdmyGtspEhXgpYucpJXphKJKK1vJA1PcCGjllS4X46yOj+uXSa6bspmg7MmYGBFx5MJ/9v1NrR5jiGUrYZtOkQicmsIDTG/dE6rPBLGHwMLrfa964PmzHlWQ6o3ucnFk+Ooj7J6cfzRiS5Zp/1trMHT1Bicb0rQxaKiob5znu7Sr8dGhpe36gLv6/q/noU2G3iXe5SExSk9pOpO8Hhy/OLwaHI4+fbq6FV68n368tVoMpn8KRKxaDTLrpu1kBQ9JUV6+N264ivYGRysp8ZjEF3HhJOH+vDSNki1MhXM0RDMvTVVAk6jDAjklyArqQxoSeiffbkGRe+tfzwTT/NsGLkyWhm82QzhzclkcnO0TcLJfhL6VIGxBKVtTTH6CoE+1qX7/jwe3snNd9vwXu6Hd25mUqsiovaVvUXzdQs5NE+9eXZ1t51VzxTpYifY4XkfZMC89YqWcUcsDqVThz09vZ4y+nLf2PVqiUuFapGKcZ/V8Wq7TjrBuvxss25ar0UqaiIX0vE4SFNkdjGyDk1QldEyC6PcNmPp1Hh2JLrkvoR07gnc2B4+TSCQrJSpHpea3qXnkkvYV2knSdtaSad+w6VINjUYcq03bY0y4mTH36WNwuvKvHNoLlVlYl1nR3v7+D3q3DbIlwOqETbs//z1d5QobN42aCi23TN413pwdo6eN6I0BZQaFyrT+MBdI6BsNIagl6AMYeUlIRSqUiQ1cFYYNHLpZKa04kZlNsvSHga9Hkbwvkaq0TPpG48gocAZau5v0Nbesh6yIFuyTbSx9hnm1t+W7FICErI2KIMhQEDciKCppckRNrVIwHqQBtAQeudVQJCqYebSesCyVLlixTyVXuYEjTSyQjaWAPvNWXDezlSBAbzN2kAQrG5jIGyxQaQ+RINYhBH8pGbYB86H/bUMC6haVpFAbguE9ZByGKaADAOBY/Mqx6g0kPQEGmfoY+/FSpat1uAso4eSmq9bw9qyIvLSBAa43qFNabbpc97y5SfaKORyBB/MB8N4D21AbgCtzG1IP5hDuN622XvMgiKcPt/Mw3w+35uDg12ZM0V1m4FHZ+/kqngYp2Yovv044F27OzC7ne2xRM/RxBxVaDB2oHSqxze4Pr04j0ALNWp3Z5lF9keXT8fMOL5EImWqMN7IH8QbijUk84jU2Eil+8n94b6eiJrom/CuvEQ/UzmuseMzqRpH5rFIhFY5moADND49u3gDM3gxmohkgEL/IXnjN+c/vn57+Zq9YWDtM3Y0mowm8f5mAzXSDEzdvSruI8jqbkd92ffHGv4IFzR2Wqq4cGKUq/WyuBbbF0R69/qYJqK2gZi8WmUy4B9edx0ff2rR8zqaJmImvZIZI+T1ShQq8O9i+7z4bIDPf1+/VA7gwYfMgz5vcNwwiM+kbvlLJOIWlzvPpm7aJRsoZ7d6+mmeo6OB5N49YGeZnr2+EomQLednuEJu4wpZ/2DtD3q1u1t6B/gvr7kHBVarfj113Za/J31WYh3ghptTNO267l8LQSaR","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 a=o(74848),r=o(28453),n=o(33617),s=o.n(n),l=o(17543),p=o.n(l),d=o(86013),c=o.n(d),m=o(63723),I=o.n(m),u=(o(18766),o(79329),o(9303));const b={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:"eJy9V91u2zYUfpVT3qwBFNtJ027T1YKty7IVbbBkKLDUCCjpSGJDkSx55B8YutuT7NH2JMOhbEeO02AZit4kFs//33fIlSBZBZFei5+tLtCLaSIKDLlXjpQ1IhVXNcIZEvR0OL04B6m1nQdY2hbIgkfyCmcIBZJUOoDMbEsgITjMValyKKPoSCTCOvSSFZ8XIhUVUk8SiXDSywYJPTuzEkY2KFLRk29UIRKh2BsnqRb3XbTZR8zpvABbwlahx0+t8liIlHyLiQi01KwyqMZpFInAhdO2QJGWUgdmyGtspEhXgpYucpJXphKJKK1vJA1PcCGjllS4X46yOj+uXSa6bspmg7MmYGBFx5MJ/9v1NrR5jiGUrYZtOkQicmsIDTG/dE6rPBLGHwMLrfa964PmzHlWQ6o3ucnFk+Ooj7J6cfzRiS5Zp/1trMHT1Bicb0rQxaKiob5znu7Sr8dGhpe36gLv6/q/noU2G3iXe5SExSk9pOpO8Hhy/OLwaHI4+fbq6FV68n368tVoMpn8KRKxaDTLrpu1kBQ9JUV6+N264ivYGRysp8ZjEF3HhJOH+vDSNki1MhXM0RDMvTVVAk6jDAjklyArqQxoSeiffbkGRe+tfzwTT/NsGLkyWhm82QzhzclkcnO0TcLJfhL6VIGxBKVtTTH6CoE+1qX7/jwe3snNd9vwXu6Hd25mUqsiovaVvUXzdQs5NE+9eXZ1t51VzxTpYifY4XkfZMC89YqWcUcsDqVThz09vZ4y+nLf2PVqiUuFapGKcZ/V8Wq7TjrBuvxss25ar0UqaiIX0vE4SFNkdjGyDk1QldEyC6PcNmPp1Hh2JLrkvoR07gnc2B4+TSCQrJSpHpea3qXnkkvYV2knSdtaSad+w6VINjUYcq03bY0y4mTH36WNwuvKvHNoLlVlYl1nR3v7+D3q3DbIlwOqETbs//z1d5QobN42aCi23TN413pwdo6eN6I0BZQaFyrT+MBdI6BsNIagl6AMYeUlIRSqUiQ1cFYYNHLpZKa04kZlNsvSHga9Hkbwvkaq0TPpG48gocAZau5v0Nbesh6yIFuyTbSx9hnm1t+W7FICErI2KIMhQEDciKCppckRNrVIwHqQBtAQeudVQJCqYebSesCyVLlixTyVXuYEjTSyQjaWAPvNWXDezlSBAbzN2kAQrG5jIGyxQaQ+RINYhBH8pGbYB86H/bUMC6haVpFAbguE9ZByGKaADAOBY/Mqx6g0kPQEGmfoY+/FSpat1uAso4eSmq9bw9qyIvLSBAa43qFNabbpc97y5SfaKORyBB/MB8N4D21AbgCtzG1IP5hDuN622XvMgiKcPt/Mw3w+35uDg12ZM0V1m4FHZ+/kqngYp2Yovv044F27OzC7ne2xRM/RxBxVaDB2oHSqxze4Pr04j0ALNWp3Z5lF9keXT8fMOL5EImWqMN7IH8QbijUk84jU2Eil+8n94b6eiJrom/CuvEQ/UzmuseMzqRpH5rFIhFY5moADND49u3gDM3gxmohkgEL/IXnjN+c/vn57+Zq9YWDtM3Y0mowm8f5mAzXSDEzdvSruI8jqbkd92ffHGv4IFzR2Wqq4cGKUq/WyuBbbF0R69/qYJqK2gZi8WmUy4B9edx0ff2rR8zqaJmImvZIZI+T1ShQq8O9i+7z4bIDPf1+/VA7gwYfMgz5vcNwwiM+kbvlLJOIWlzvPpm7aJRsoZ7d6+mmeo6OB5N49YGeZnr2+EomQLednuEJu4wpZ/2DtD3q1u1t6B/gvr7kHBVarfj113Za/J31WYh3ghptTNO267l8LQSaR",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,h={},v=[];function g(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(u.default,{as:"h1",className:"openapi__heading",children:"Get Folder"}),"\n",(0,a.jsx)(s(),{method:"get",path:"/folder/{folder_id}",context:"endpoint"}),"\n",(0,a.jsx)(t.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,a.jsx)(u.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,a.jsx)(p(),{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,a.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,a.jsx)(I(),{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 k(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); |