Files
OpenSign/assets/js/2304e9ae.4e6965bb.js
T

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),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),c=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/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",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:"eJzNV9tuGzcQ/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",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 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:"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)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.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)(c.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(m.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)(m.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)(c.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)(m.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)(c.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)(m.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)(b,{...e})}):b(e)}}}]);