WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 18:14:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3be80c6255e1ccf676b5372bb83703fdea40bb5f
OpenSign/assets/js/ada7accb.40681dfc.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>y});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),t=s.n(i),d=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const j={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:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={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:!1,unlisted:!1,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:!0,hide_table_of_contents:!0,api:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",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"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"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)(a.p,{children:"Get Folder"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Folder API allows you to retrieve details about a specific folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\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}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{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)(a.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:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{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)(a.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",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{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)(a.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:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink