WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-10 19:57:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
a601ed53c19eec7ffd1992220d2f6a031cf07b53
OpenSign/assets/js/ada7accb.2592b532.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:()=>j,default:()=>v,frontMatter:()=>u,metadata:()=>x,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:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=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:"eJy9V9tu3DYQ/ZUJX5oA8l5cJ22FoqjRpqmbIAlqFwHqLAxKGkmMKZIhR7teLPTWL+mn9UuKobRrre0YdRHkxbbIuZwZzpwZbwTJKoj0XPxidYFeLBJRYMi9cqSsEak4qxFeIEF/D8dvT0BqbVcB1rYFsuCRvMIlQoEklQ4gM9sSSAgOc1WqHMqoOhGJsA69ZMMnhUhFhdRfiUQ46WWDhJ7BbISRDYpU9NcXqhCJUIzGSarFTYg2+4A5nRRgS9gZ9PixVR4LkZJvMRGB1ppNBtU4jSIReOW0LVCkpdSBBfIaGynSjaC1i5LklalEIkrrG0njE7yS0Uoq3K/zrM4Pa5eJrluw2+CsCRjY0OFsxr/20YY2zzGEstWwS4dIRG4NoSGWl85plceL6YfASpvb6PqgOXOezZDqXW5z8eA46nlWXx1+cKJLhrS/jm/wMDMGV9sn6OKjoqG+ch4O6bdDI8PTS/UWb9r6v8hCm43Q5R4lYXFMd5m6VjycHX59MJ8dzL45mz9Lj75Lnz6bzGazP0UirhrNukOxFpIiUlKkx9+tK76An9HB0DUeg+g6vji6qw5PbYNUK1PBCg3ByltTJeA0yoBAfg2yksqAloT+0ecrUPTe+vsz8TBk48iV0crgxbYJL45ms4v5LglHt5PQpwqMJShta4rJFwj0viq9jef+8I4uvt2F9/R2eCdmKbUqImuf2Us0X/Yhx+6pd89Q98tZ9ULxXuwFOz7vgwyYt17ROs6IqwPp1EF/n54vmH25buwwWuJQoVqkYtpndbrZjZNOsC2/3I6b1muRiprIhXQ6lc5NrEMTVGW0zMIkt81UOjVdzkWX3JQOJCtlqoN7tRbX2E85v30K9yLYJVI69RLXItkmaCw1jMEaZSSxjr9LG5WHtL1xaE5VZWLSl/Nbw/Id6tw2yJObaoSt+D9//R01Cpu3DRqKNfEI3rQenF2h53ElTQGlxiuVabxjEQgoG40h6DUoQ1h5SQiFqhRJDZwV7uhcOpkprbiKWMyytodRIYYJvKuRavR89ZVHkFDgEjUXH2hrL9kOWZAt2Sb6GDDDyvrLkiElICFrgzIYAgTErQqaWpocYfsWCVgP0gAaQu+8CghSNSxcWg9YlipXbJhbxsucoJFGVsjOEmDcnAXn7VIVGMDbrA0Eweo2BsIeG0TqQzSIRZjAz2qJfeB82O9MWEDVsokEclsgDB3EYZgCMgwEjt2rHKPRQNITaFyij7UXX7JstQZnubWV1LwLjd+WDZGXJjD79IC2T7NLn/OWN5Poo5DrCbw37w2TMbQBuQC0MpchfW8O4HxXZu8wC4pw8XjbD6vV6lYfPNnXeaGobjPw6Oy1XhUPY9eM1XcfT0QiCH0T3pSn6Jcqx6EJP+FzGoWnA+HJPBIeNlLpvsd+vKnA5KNVjibgiJ6OX7x9BUv4ejITyajz/wPg6auTn56/Pn3Odplp+v6bT2aTWVxobKBGmpGr6zX7Ztdurkn78y7kA+UQXtHUaakiA8coNwN7novdSp1er+OLRNQ2EF9vNpkM+IfXXcfHH1v0zM+LRCylVzJjVjrfiEIF/rvY7dufDPDx78Pq/gTu3OzvxLzlTsPEuZS65S+RiEtc7/0f0S26ZEufDKu/P85zdDTSvDUY96bLi+dnIhGy5fyMafsy0vbwB1u/E9U+n/cA+CePljsVvuc3fonrH3bi/c0nFYb4ttKcoUXXdf8CPY3PmQ==",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 b(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 v(e={}){const{wrapper:a}={...(0,r.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink