Files
OpenSign/assets/js/8a855f99.4657d57d.js
T

1 line
12 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>w,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),n=s(11151),i=s(58219),d=(s(62316),s(51039)),r=s.n(d),t=(s(82723),s(9487)),o=s(41429),p=s(5397),m=s(4667),c=s(9472),h=s(85162);const x={id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",source:"@site/docs/API-docs/updatefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/updatefolder",permalink:"/docs/API-docs/updatefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"updatefolder",title:"Update Folder",description:"The Update Folder API allows you to uodate folder name as well as parentFolderId.",sidebar_label:"Update Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,n.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:"Update Folder"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/folder/{folder_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Folder API allows you to uodate folder name as well as parentFolderId."}),"\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:"bK1cfd2hpb"}}})})})]}),"\n",(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.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.jsx)("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)("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)(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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.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)(p.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)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.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)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function w(e={}){const{wrapper:a}={...(0,n.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);