WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-23 10:04:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
aafd020dc5b4a76df7f26bc156fe78d325567178
OpenSign/assets/js/ada7accb.774fa7a2.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:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),r=s(11151),i=s(58219),n=(s(62316),s(51039)),t=s.n(n),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={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:"eJy9V+lu20YQfpXJ/mkC0DocJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0MdEPivT9JH65MUs5RkykdQF0H+SCLnvr4ZrQXJKoj0QvxqdYFezBJRYMi9cqSsEak4rxFOkKCnw/G7U5Ba20WAlW2BLHgkr3COUCBJpQPIzLYEEoLDXJUqhzKKjkQirEMvWfFpIVJRIfUkkQgnvWyQ0LMza2FkgyIVPflSFSIRir1xkmpx00WbfcScTguwJewUevzUKo+FSMm3mIhAK80qg2qcRpEIXDptCxRpKXVghrzGRop0LWjlIid5ZSqRiNL6RtLwDS5l1JIK99s0q/PD2mWi62ZsNjhrAgZWdDiZ8Ne+t6HNcwyhbDXs0iESkVtDaIj5pXNa5ZEw/hhYaH3buz5ozpxnNaR6k9tcPDiOeprVy8OPTnTJJu1vYg0epsbgYluCLhYVDfWd83CXXh4aGZ5dqXd4U9f/9Sy02cC73KMkLI7pLlXXgoeTw6cH08nB5Nvz6fP06Pv02fPRZDL5UyRi2WiW3TRrISl6Sor08Ll1xVewM3ixmRqPQXQdE47u6sMz2yDVylSwQEOw8NZUCTiNMiCQX4GspDKgJaF/9OUaFL23/vOZeJhnw8iV0crg5XYIL48mk8vpLglHt5PQpwqMJShta4rRVwj0c11625/Ph3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxWDo3sg5NUJXRMguj3DZj6dR4PhVdcpM7kKyUqQ4eKCVNkdnl/RKz62jPuCJ90vdi3qVeOvUKVyLZpnTItVmcNcoIex0/lzYKbxL91qE5U5WJZZpPb63X96hz2yDveqoRtuz//PV3lChs3jZoKHbRI3jbenB2gZ4XnDQFlBqXKtN4x+kQUDYaQ9ArUIaw8pIQClUpkho4K4wBuXQyU1px3zGbZWkPg9YNI3hfI9XomfSNR5BQ4Bw1tytoa69YD1mQLdkm2tj4DAvrr0p2KQEJWRuUwRAgIG5F0NTS5AjbWiRgPUgDaAi98yogSNUwc2k9YFmqXLFiHjIvc4JGGlkhG0uA/eYsOG/nqsAA3mZtIAhWtzEQttggUh+iQSzCCH5Rc+wD55f9lYUFVC2rSCC3BcJm5jgMU0CGgcCxeZVjVBpIegKNc/SxW2Mly1ZrcJbBQEnN19OwtqyIvDSB8ap3aFuaXfqct3zLRBuFXI3gg/lgGL6hDcgNoJW5CukHcwAXuzZ7j1lQhLPH21lYLBa35uDJvsyJorrNwKOz13JVfBmnZii+e3giEkHom/C2PEM/VzluBvAem+PIPN5ApMwjRGIjle5n7KebAgxXWuVoAg4A7fjk3WuYw9PRRCSDqf8PDo9fn/784s3ZC9bL2NTP33Q0GU3iCWQDNdIMTF0f5jendn0N81/2hN9ADuGSxk5LFTE7Rrne4O2F2B3h6fUBP0tEbQMxeb3OZMA/vO46fv2pRc+IPkvEXHolM0ali7UoVODfxe5CvzfAx79vjv0ncOd/gTt93mKnYeCcS93yk0jEFa72/nl0sy7Zwie71dOP8xwdDSRvrdK9fXTy4lwkQracnyFsX0XY3vxg7Xd6tY/nvQP8yWvlToEfuMavcPXjjr2n3CuwiW/LzRmadV33L3634Ws=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={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:"eJy9V+lu20YQfpXJ/mkC0DocJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0MdEPivT9JH65MUs5RkykdQF0H+SCLnvr4ZrQXJKoj0QvxqdYFezBJRYMi9cqSsEak4rxFOkKCnw/G7U5Ba20WAlW2BLHgkr3COUCBJpQPIzLYEEoLDXJUqhzKKjkQirEMvWfFpIVJRIfUkkQgnvWyQ0LMza2FkgyIVPflSFSIRir1xkmpx00WbfcScTguwJewUevzUKo+FSMm3mIhAK80qg2qcRpEIXDptCxRpKXVghrzGRop0LWjlIid5ZSqRiNL6RtLwDS5l1JIK99s0q/PD2mWi62ZsNjhrAgZWdDiZ8Ne+t6HNcwyhbDXs0iESkVtDaIj5pXNa5ZEw/hhYaH3buz5ozpxnNaR6k9tcPDiOeprVy8OPTnTJJu1vYg0epsbgYluCLhYVDfWd83CXXh4aGZ5dqXd4U9f/9Sy02cC73KMkLI7pLlXXgoeTw6cH08nB5Nvz6fP06Pv02fPRZDL5UyRi2WiW3TRrISl6Sor08Ll1xVewM3ixmRqPQXQdE47u6sMz2yDVylSwQEOw8NZUCTiNMiCQX4GspDKgJaF/9OUaFL23/vOZeJhnw8iV0crg5XYIL48mk8vpLglHt5PQpwqMJShta4rRVwj0c11625/Ph3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxWDo3sg5NUJXRMguj3DZj6dR4PhVdcpM7kKyUqQ4eKCVNkdnl/RKz62jPuCJ90vdi3qVeOvUKVyLZpnTItVmcNcoIex0/lzYKbxL91qE5U5WJZZpPb63X96hz2yDveqoRtuz//PV3lChs3jZoKHbRI3jbenB2gZ4XnDQFlBqXKtN4x+kQUDYaQ9ArUIaw8pIQClUpkho4K4wBuXQyU1px3zGbZWkPg9YNI3hfI9XomfSNR5BQ4Bw1tytoa69YD1mQLdkm2tj4DAvrr0p2KQEJWRuUwRAgIG5F0NTS5AjbWiRgPUgDaAi98yogSNUwc2k9YFmqXLFiHjIvc4JGGlkhG0uA/eYsOG/nqsAA3mZtIAhWtzEQttggUh+iQSzCCH5Rc+wD55f9lYUFVC2rSCC3BcJm5jgMU0CGgcCxeZVjVBpIegKNc/SxW2Mly1ZrcJbBQEnN19OwtqyIvDSB8ap3aFuaXfqct3zLRBuFXI3gg/lgGL6hDcgNoJW5CukHcwAXuzZ7j1lQhLPH21lYLBa35uDJvsyJorrNwKOz13JVfBmnZii+e3giEkHom/C2PEM/VzluBvAem+PIPN5ApMwjRGIjle5n7KebAgxXWuVoAg4A7fjk3WuYw9PRRCSDqf8PDo9fn/784s3ZC9bL2NTP33Q0GU3iCWQDNdIMTF0f5jendn0N81/2hN9ADuGSxk5LFTE7Rrne4O2F2B3h6fUBP0tEbQMxeb3OZMA/vO46fv2pRc+IPkvEXHolM0ali7UoVODfxe5CvzfAx79vjv0ncOd/gTt93mKnYeCcS93yk0jEFa72/nl0sy7Zwie71dOP8xwdDSRvrdK9fXTy4lwkQracnyFsX0XY3vxg7Xd6tY/nvQP8yWvlToEfuMavcPXjjr2n3CuwiW/LzRmadV33L3634Ws=",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={},g=[{value:"Request",id:"request",level:2}];function v(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)(i.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)(m.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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"parentFolderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new sub folder"}}),(0,l.jsx)(p.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)(p.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)(c.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)(m.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)(p.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)(c.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)(m.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)(p.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)(c.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)(m.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)(p.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink