mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-07 18:27:41 +02:00
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=s(85893),r=s(11151),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),c=s(4667),m=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfVoB2Zbz0mLCMCwrsiJr0QRzhgFzjICWzjITimRJyi8w9N+HI+VYttNgGYZiXwzr3u+5e0huwPPSQTaGX7Us0MIkgQJdboXxQivI4HaO7L1F7pFFE3Zxc8W4lHrp2FrXzGuWR/0s6PuQgDZoOQW4KiCDqI5aSMDilxqd/0UXa8g2B+lurF6IAtkUpV4ywy2v0KM9ygIJ5Fp5VJ5icGOkyEPGwYOjQBtw+RwrTv8oobBYUJvRW/EKqVW/NggZ6OkD5h4SMJYq9wId+UXbz2Sbbba2zluhSkhgpm3FfVeCK14ZSUYKl9s6mwQMt6h8RI8AeV0saJoEvPDhIwa9nxJ2DSl2vXlbYxA4o5WLHZyk6THEMUYLZ8Fcnefo3KyWcv3da2B9Gbwofn27Zj6czlcnD4aQ+39M4LcTxd35o7hBitXiduGfC7NzOklPTnvDtJe+ux2+zc5+yM7f9tM0/QsSWFWSfMMSZlBwH+JuR7z9rk3xDfI0h2YRtAI9F9LB0erR1jUJnD23WCNdoZ8LVbIlKs+WVqsyYUYid8i8XTNecqGY5B7tf7hpaK22L4P0usq6hBNKCoX3W1bdn6Xp/fAJhPNjEK7UgktRhFPyVj+i+raddtP7mP54xiIaBT3sNduVxyYd5rUVfg3ZeAOrHjeiF/XZeNJMEiBgNZ3yRrtQMfdzyGBwcOg7tAu0LkSprYQM5t4blw0G3Ji+NqicKJXkU9fPdTXgRgwWQ2iSQ2vneSlU2XvRa7Ire0TQRvT2in/CkBvxEdeQbLHpWiUgaKRz5HHzE6CJ/b67vy63uO9fFt3T5/jwAYJcqJkOVbTQXxtUI1GqMLjFEI6vYeGYcEFd6LyuUPmwRGymLTvwZlPusGBaMT/HoCT5aX/InMFczNr967M7daeIG6x2OKslk0I9uuxO9dj4ejYTueCS/YlTJzxOvt+OYLlcHkH/Jvh8EH5eT5lFo3fmZRCG+XS9nj7eQAIebeWuZyO0C5FjO+6vpBoE40HLKp4HVmHFBa1JK/r50IkglyJH5bDDg4sPN5/Ygp32U0g6e/YPih58unp/+Xl0SXFpr+OQhv20n4b7RjtfcdVJtfeEOpzuZndA/Lv3VrvLHld+YCQXgdWhoU1LyPH+K2ySwJz4mo1hs6Ft+cPKpiHxlxotkX2SwIJbwae0nuNJk2xpQAx+xDX1FIvu3VJ2Mpd1ZNTBCUcsjh4XeY7Gv2jbPVJurke3kMC0fSlWuiAfy5f0iuRLyOAO7iC8NylCYHmQb0ByVda8JPsYl9jLa4KiS/3HQP32D3W2Val1p8r9MyG2Qr/U2LMOP9LMPuL6pyfzqPmqQ4vt1poGOGma5m88h/Vw",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",source:"@site/docs/API-docs/createfolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createfolder",permalink:"/docs/API-docs/createfolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfVoB2Zbz0mLCMCwrsiJr0QRzhgFzjICWzjITimRJyi8w9N+HI+VYttNgGYZiXwzr3u+5e0huwPPSQTaGX7Us0MIkgQJdboXxQivI4HaO7L1F7pFFE3Zxc8W4lHrp2FrXzGuWR/0s6PuQgDZoOQW4KiCDqI5aSMDilxqd/0UXa8g2B+lurF6IAtkUpV4ywy2v0KM9ygIJ5Fp5VJ5icGOkyEPGwYOjQBtw+RwrTv8oobBYUJvRW/EKqVW/NggZ6OkD5h4SMJYq9wId+UXbz2Sbbba2zluhSkhgpm3FfVeCK14ZSUYKl9s6mwQMt6h8RI8AeV0saJoEvPDhIwa9nxJ2DSl2vXlbYxA4o5WLHZyk6THEMUYLZ8Fcnefo3KyWcv3da2B9Gbwofn27Zj6czlcnD4aQ+39M4LcTxd35o7hBitXiduGfC7NzOklPTnvDtJe+ux2+zc5+yM7f9tM0/QsSWFWSfMMSZlBwH+JuR7z9rk3xDfI0h2YRtAI9F9LB0erR1jUJnD23WCNdoZ8LVbIlKs+WVqsyYUYid8i8XTNecqGY5B7tf7hpaK22L4P0usq6hBNKCoX3W1bdn6Xp/fAJhPNjEK7UgktRhFPyVj+i+raddtP7mP54xiIaBT3sNduVxyYd5rUVfg3ZeAOrHjeiF/XZeNJMEiBgNZ3yRrtQMfdzyGBwcOg7tAu0LkSprYQM5t4blw0G3Ji+NqicKJXkU9fPdTXgRgwWQ2iSQ2vneSlU2XvRa7Ire0TQRvT2in/CkBvxEdeQbLHpWiUgaKRz5HHzE6CJ/b67vy63uO9fFt3T5/jwAYJcqJkOVbTQXxtUI1GqMLjFEI6vYeGYcEFd6LyuUPmwRGymLTvwZlPusGBaMT/HoCT5aX/InMFczNr967M7daeIG6x2OKslk0I9uuxO9dj4ejYTueCS/YlTJzxOvt+OYLlcHkH/Jvh8EH5eT5lFo3fmZRCG+XS9nj7eQAIebeWuZyO0C5FjO+6vpBoE40HLKp4HVmHFBa1JK/r50IkglyJH5bDDg4sPN5/Ygp32U0g6e/YPih58unp/+Xl0SXFpr+OQhv20n4b7RjtfcdVJtfeEOpzuZndA/Lv3VrvLHld+YCQXgdWhoU1LyPH+K2ySwJz4mo1hs6Ft+cPKpiHxlxotkX2SwIJbwae0nuNJk2xpQAx+xDX1FIvu3VJ2Mpd1ZNTBCUcsjh4XeY7Gv2jbPVJurke3kMC0fSlWuiAfy5f0iuRLyOAO7iC8NylCYHmQb0ByVda8JPsYl9jLa4KiS/3HQP32D3W2Val1p8r9MyG2Qr/U2LMOP9LMPuL6pyfzqPmqQ4vt1poGOGma5m88h/Vw",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Webhook",permalink:"/docs/API-docs/delete-webhook"},next:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"}},j={},f=[{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:"Create Folder"})}),"\n",(0,l.jsx)(n(),{method:"post",path:"/createfolder"}),"\n",(0,l.jsx)(a.p,{children:"The Create Folder API allows you to create folder."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(a.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to create folder"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(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:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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:"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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "folderName": "new folder",\n "parentFolderId": "J2nas5kiPe",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.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)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.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)(g,{...e})}):g(e)}}}]); |