mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-13 13:17:39 +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:()=>u,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>f});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),s(5397)),c=s(4667),p=s(9472),m=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:"eJzNV9tu3DYQ/RVmXtoA2oudOEWFoqibpoGbIDZqFwFqL4yRNKtlTJEMSe16sdBbv6Sf1i8phlzZe3GCuiiCvixW5FzPzJyRVhCw9pBfws9GVeRgkkFFvnTSBmk05HAxI/HSEQYSSUQcn50IVMosvFiaVgQjynQ/jfdDyMBYcsgGTirIIV2nW8jA0ceWfPjRVEvIVzvuzpyZy4pEQcoshEWHDQVye14gg9LoQDqwDbRWyTJ6HH3wbGgFvpxRg/yPHUpHFaeZtDU2xKmGpSXIwRQfqAyQgXUceZDkWS/JvmPZfNXL+uCkriGDqXENhs0TusXGKhbStOjj7DKw6EiHhB4D8jhb0HUZBBniQzJ6XTB2HV/c5xZcS/HAW6N9yuBwPN6HONlYw1kJ35YleT9tlVo+eQysnwcvHT8+XTs7KGa3hx8sI/f/qMAvhxr90Y08I7a1xu04PGTmXulwfPhscDAejL+5OHiRP/82P3oxHI/Hv0MGt41i3diEOVQYot2+xP1za6sv4KfbFUugVRRQKg97rcdd12Xw/KHGOjcNhZnUtViQDmLhjK4zYRWhJxHcUmCNUguFgdx/2GnknHGfB+lxkW0OnNRKarrup+r6+Xh8fXAHwtE+CCd6jkpWkSUvzA3pL5vppvuQ3O/XWCaheA9byW6epyQ9la2TYQn55QpuB2jlIN3nl5NukgEDa5jlrfExYgwzyGG0Q/qe3Jycj1ZapyCHWQjW56MRWjs0lrSXtVZY+GFpmhFaOZofQJftSvuAtdT14JFaqKvC3H5aY3Kf6DkXI+G9le4d6mjlG1pC1qO5KZWB5CaYEaZZyYBr/Ov9xnvVV2p7vWzy1T5dARdJ6qmJUayLdWpJn8tax1LPD2B3cb8nVZqGeHOGGYle/K8//owalSnbhnSInfhEnLZOWLMgN22VQF2JqaJbWSh6YN17wkaR92oppA5UO17LlaxlQCUYXh60Ei0WUknuXRYzrO3ERvv7oXg/ozAjx1dfORIoKpqT4pYXypgbthOMwDaYJvpYxywWxt1MOaRMoChaLzV5LzxRr0J6hrok0Rc1E8YJ1IJ0IGed9CRQNiw8NU7QdCpLyYZ5UB2WQTSosSZ2lgmOm1Gw6d3EC2eK1gfhjWpjIuyxIQopRU1U+aH4Sc4pJc6HiVCpEnXLJjJRmorEem45DV2JgnwQlt3LkqJRH9AFoWhOLrZ9rCRvamENE4pEJcx0q7ZsKDjUnjdaCqgvzR181hle+dFHhcuhuNJXmjlStJ64AZTUNz6/0gNxeddm76nwMtDk636oFovF3kA93dZ5LcOsLYQja+716ngYx29T/e7hKWQQyDX+dHpObi5LWk/yJ3yOovBoTbNYRpqlBqVKw/rDrgJPk5IlaU8bpHj8+uytmItnwzFkG/TxDwIevT15+erd+Su2yySX5u9gOB6O48uH8aFBveFq6316d3BX99vi3718r2kq0G0YWYUyUnxMaLVm58vtV/JJBjMm7/wSVqsCPf3mVNfx8ceWHDP/JIM5OokFM8/lpMt6hmM6v6El55SCHlywdxZXbSLLnXXH5Jw0jsuSbPis7OZ+OTs9v4AMivVnQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhSbrH4TWX39hzPrr/RyI8ptuk+p8C8n9qDCd1yzN7T8/k483XxSYY1tL80FnHRd9zejcLvj",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={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:"eJzNV9tu3DYQ/RVmXtoA2oudOEWFoqibpoGbIDZqFwFqL4yRNKtlTJEMSe16sdBbv6Sf1i8phlzZe3GCuiiCvixW5FzPzJyRVhCw9pBfws9GVeRgkkFFvnTSBmk05HAxI/HSEQYSSUQcn50IVMosvFiaVgQjynQ/jfdDyMBYcsgGTirIIV2nW8jA0ceWfPjRVEvIVzvuzpyZy4pEQcoshEWHDQVye14gg9LoQDqwDbRWyTJ6HH3wbGgFvpxRg/yPHUpHFaeZtDU2xKmGpSXIwRQfqAyQgXUceZDkWS/JvmPZfNXL+uCkriGDqXENhs0TusXGKhbStOjj7DKw6EiHhB4D8jhb0HUZBBniQzJ6XTB2HV/c5xZcS/HAW6N9yuBwPN6HONlYw1kJ35YleT9tlVo+eQysnwcvHT8+XTs7KGa3hx8sI/f/qMAvhxr90Y08I7a1xu04PGTmXulwfPhscDAejL+5OHiRP/82P3oxHI/Hv0MGt41i3diEOVQYot2+xP1za6sv4KfbFUugVRRQKg97rcdd12Xw/KHGOjcNhZnUtViQDmLhjK4zYRWhJxHcUmCNUguFgdx/2GnknHGfB+lxkW0OnNRKarrup+r6+Xh8fXAHwtE+CCd6jkpWkSUvzA3pL5vppvuQ3O/XWCaheA9byW6epyQ9la2TYQn55QpuB2jlIN3nl5NukgEDa5jlrfExYgwzyGG0Q/qe3Jycj1ZapyCHWQjW56MRWjs0lrSXtVZY+GFpmhFaOZofQJftSvuAtdT14JFaqKvC3H5aY3Kf6DkXI+G9le4d6mjlG1pC1qO5KZWB5CaYEaZZyYBr/Ov9xnvVV2p7vWzy1T5dARdJ6qmJUayLdWpJn8tax1LPD2B3cb8nVZqGeHOGGYle/K8//owalSnbhnSInfhEnLZOWLMgN22VQF2JqaJbWSh6YN17wkaR92oppA5UO17LlaxlQCUYXh60Ei0WUknuXRYzrO3ERvv7oXg/ozAjx1dfORIoKpqT4pYXypgbthOMwDaYJvpYxywWxt1MOaRMoChaLzV5LzxRr0J6hrok0Rc1E8YJ1IJ0IGed9CRQNiw8NU7QdCpLyYZ5UB2WQTSosSZ2lgmOm1Gw6d3EC2eK1gfhjWpjIuyxIQopRU1U+aH4Sc4pJc6HiVCpEnXLJjJRmorEem45DV2JgnwQlt3LkqJRH9AFoWhOLrZ9rCRvamENE4pEJcx0q7ZsKDjUnjdaCqgvzR181hle+dFHhcuhuNJXmjlStJ64AZTUNz6/0gNxeddm76nwMtDk636oFovF3kA93dZ5LcOsLYQja+716ngYx29T/e7hKWQQyDX+dHpObi5LWk/yJ3yOovBoTbNYRpqlBqVKw/rDrgJPk5IlaU8bpHj8+uytmItnwzFkG/TxDwIevT15+erd+Su2yySX5u9gOB6O48uH8aFBveFq6316d3BX99vi3718r2kq0G0YWYUyUnxMaLVm58vtV/JJBjMm7/wSVqsCPf3mVNfx8ceWHDP/JIM5OokFM8/lpMt6hmM6v6El55SCHlywdxZXbSLLnXXH5Jw0jsuSbPis7OZ+OTs9v4AMivVnQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhSbrH4TWX39hzPrr/RyI8ptuk+p8C8n9qDCd1yzN7T8/k483XxSYY1tL80FnHRd9zejcLvj",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"}},u={},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)(t(),{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)(m.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)(m.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.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)(m.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.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)(m.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.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)}}}]); |