mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-02 23:48:46 +02:00
1 line
11 KiB
JavaScript
1 line
11 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:()=>x,default:()=>k,frontMatter:()=>h,metadata:()=>u,toc:()=>g});var l=s(85893),t=s(11151),n=s(58219),r=(s(62316),s(51039)),i=s.n(r),o=(s(82723),s(9487)),d=(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:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={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:"eJzNV9tuGzcQ/RVmXtoAq5tzKbooirppGrgJYqN2EaCyYMzujlaMuSRDciULgt76Jf20fkkxpNbWxTHqogj6ImjJuZ6ZObO7goC1h3wMPxtVkYNJBhX50kkbpNGQw8WMxCtHGEgkEXF8diJQKbPwYmlaEYwo0/003vchA2PJIRs4qSCHdJ1uIQNHn1ry4UdTLSFf7bk7c2YuKxIFKbMQFh02FMgdeIEMSqMD6cA20Foly+hx8NGzoRX4ckYN8j92KB1VnGbS1tgQpxqWliAHU3ykMkAG1nHkQZJnvST7nmXzVSfrg5O6hgymxjUYtk/oBhurWEjTootznYFFRzok9BiQx9mC9TqDIEN8SEavCsZuzRd3uQXXUjzw1mifMjgaDg8hTjY2cFbCt2VJ3k9bpZZPHgPrw+Cl48ena2ejYnZz9NEycv+PCvxypNG/uJZnxLY2uB2H+8zcKR0Nj571RsPe8JuL0cv8+bf5i5f94XD4O2Rw0yjWjU2YQ4Uh2u1K3D23tvoCftb7Ygm0igJK5eGg9bjr1hk8v6+xzk1DYSZ1LRakg1g4o+tMWEXoSQS3FFij1EJhIPcfdho5Z9zDID0usu2Bk1pJTVfdVF09Hw6vRrcgvDgE4UTPUckqsuSFuSb9ZTPddh+S+8MayyQU72En2e3zlKSnsnUyLCEfr+Cmh1b20n0+nqwnGTCwhlneGh8jxjCDHAZ7pO/Jzcn5aKV1CnKYhWB9PhigtX1jSXtZa4WF75emGaCVg/kI1tm+tA9YS133HtSa3IV9ztAm9HaCv8UQrXxLS8g6bLalMpBc0hlh6vwMuGK/3u2v1x3uu8tim30OyQcYcqmnJkaxgf7Ukj6XtY6Fm49gfw1/IFWahngPhhmJTvyvP/6MGpUp24Z0iH31RJy2TlizIDdtlUBdiamiG1koumd5e8JGkfdqKaQOVDtespWsZUAlGF4emxItFlJJ7kQWM6ztxFYz+774MKMwI8dXXzkSKCqak+IGFsqYa7YTjMA2mCb62MQsFsZdTzmkTKAoWi81eS88UadCeoa6JNEVNRPGCdSCdCBnnfQkUDYsPDVO0HQqS8mGeewclkE0qLEmdpYJjptRsOlNwwtnitYH4Y1qYyLssSEKKUVNVPm++EnOKSXOh4keqRJ1yyYyUZqKxGYKOQ1diYJ8EJbdy5KiUR/QBaFoTi42cawk711hDdODRCXMdKe2bCg41J73UwqoK80tfNYZXuDRR4XLvrjUl5oZT7SeuAGU1Nc+v9Q9Mb5tsw9UeBlo8nU3WIvF4mCgnu7qvJFh1hbCkTV3enU8jOO3rX778BQyCOQafzo9JzeXJW2m+TM+B1F4sCFNLCNpUoNSpWH9YV+Bp0nJkrSnLYo7fnP2TszFs/4Qsi0K+QcBD96dvHr9/vw122XKSvM36g/7w/gqYXxoUG+52nk73h/c1R33/7tX6Q1NBboJA6tQRsKOCa02XDvefcGeZDBjKs7HsFoV6Ok3p9ZrPv7UkmMen2QwRyexYOYZT9ZZx3BMzte05JxS0L0L9s7iqk1kube8mKCTxnFZkg0Pym5vi7PT8wvIoNh8BDSmYh2HC/5AwAXkcAmXED8l4lDG93g+X4FCXbdYs3yyy8SMLUOxzerXkdU3fziz7kovt6LcpfuUCv9yYvcqfMc1e0vL72/F081nFTbYdtJcwMl6vf4bonWqEQ==",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={},g=[{value:"Request",id:"request",level:2}];function f(e){const a={h2:"h2",p:"p",...(0,t.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)(i(),{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)(o.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)(n.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)(o.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)(d.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)(o.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)(d.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)(o.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function k(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); |