mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-23 10:04:55 +02:00
1 line
12 KiB
JavaScript
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:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>v});var l=s(85893),r=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),t=(s(82723),s(9487)),o=s(41429),m=s(5397),p=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+9uGzcMfxWWX9YCF9tJ0247DMO6ruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2MnWIB1X/xHIinyR/JHaYlBlB7TC/zVqIIcjhMsyOdO2iCNxhTPpwQfbSECQSsCL05PQChl5h4WpoZgoDZxf9Lua1ERCA9zUoq/rXCkQ6t8UgwwQWPJCbZ/UmCKdbTeKmOCVjhRUSDHbi2RrWGK7faVLDBByX5ZEaZ421mTfaY8nBRgJrA26OhLLR0VmAZXU4I+LBSb9LKyijBBurHKFITpRCjPAvmUKoHpEsPCRsngpC4xwYlxlQj9FboR0UqK2ZvDfFIcTW2GTTNujyUffjbFgk1tO3rqzEwWBBkpM4d1yAxm7mgDJiaYGx1IB7YhrFUyj8gNP3s2tOw5u4nzYgVXxG6cdGG06DDEjjMQJHnWa2XfRZwfFrKmeednExPXy/NDbWHTJBhkUL1sZ4xd0/COI2+N9q3HR6PRLqS+znPyflIrWNfXQ+C7H6Sush4a1m/X/uh3S/MTyxC1pV68CPvMbJSORkdPDw5HB6Nvzw+fp8ffp8+eD0aj0R+Y4E2lWHfVFWwNe7i1/3sLUiup6apD7+poNLo6PFxherwPxjNTUZhKXcKcdIC5M7pMwCoSniC4BYhSSA1KBHKP/jt8yTnj7kflYZ7dh8Ixo7AG4XgXhI7JTICJqXUkra8d6H1VtOvP/eEdX323Du/ZbngneiaULCKTB3NN+v9N5J7j2dXt0patUNzHrWD7622QnvLaybCIA+PmQFh50O6nF2OmYq4bw6PG1tFhHh0pDltUh8v1bGmQbblZN3tqpzDFaQjWp8OhsHZgLGkvS61E5ge5qYbCyuHsEJvktrQPopS6PHigltBFZm7u1hhvoj3jjLSgb8W8hl5Y+YYWmHSQ9qVWU3RKIrJ3kyAn+sNmZr3q0rU9IPqcv0v5yJmSemKiF6uMvbekz2SpY75nhztD+xOp3FTEsy9MCTrxv//8K2oUJq8r0iGW4yN4XzuwZk6OiV7oAiaKbmSmaM+9xJOoFHmvFiB1oNLxYC1kKYNQwPAymeTCikwqyQXMYoa1HfR6wA/g05TClBxvfeMIBBQ0I8V1D8qYa7YTDIg6mCqesfIZ5sZdT9ilBARktZeavAdP1KmQngqdE3RJTcA4EBpIB3LWSU8gZMXCE+OAJhOZSzbM3epEHqASWpTEhyXAfjMKtr1deHAmq30Ab1QdA+ETK6LQhqiJCj+AX+SM2sB5saAgpKICyppNJJCbgmDVvByGLiAjH8Dy8TKnaNQH4QIompGLZR8zOamVAmuYVaRQfCfr55YNBSe0Z+JrHepSs4bPOsMzPZ5RiMUALvWl5jkAtScuACX1tU8v9QFcrMvsE2VeBho/7ppqPp/vNNSTbZ3XMkzrDBxZs9Er42Jsv776+s8TTDCQq/z7yRm5mcxp1cl3nDmMwsMV14o8ci1VQqq2WX+6rcDdpGRO2lOPGV+8Pn0LM3g6GGHSo49/4fDw7cnLV+/OXrFdJrm2/w4Ho8EoXuCMD5XQvaO2Lv63G3e5GRlf5ZWwYrFAN2FolZBxDMR4lysK7+65mGC6eSCME5waH3h7ucyEp49ONQ0vf6nJ8ZAYJzgTToqM+eliiYX0/LtYvwDujPPxh9Ul+wnsfWvs9bmjY81cPBOqjvfdBK9psfWyacZN0jEyu9Xuv2wPPzhnKxv9nRnNw6TVeJHnZMO9sv2hePrxHBPMVu+UKr6E0Ik5P53EHFO8xEuMr7bIIfGpwetLVEKXtShZvjXLc0TUnJr+ELqOQ2j1gwPbC8j2dGoj4U+Oa6/CD1xib2jx41q83blTYQVtJ83JGTdN8w+NvTfZ",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+9uGzcMfxWWX9YCF9tJ0247DMO6ruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2MnWIB1X/xHIinyR/JHaYlBlB7TC/zVqIIcjhMsyOdO2iCNxhTPpwQfbSECQSsCL05PQChl5h4WpoZgoDZxf9Lua1ERCA9zUoq/rXCkQ6t8UgwwQWPJCbZ/UmCKdbTeKmOCVjhRUSDHbi2RrWGK7faVLDBByX5ZEaZ421mTfaY8nBRgJrA26OhLLR0VmAZXU4I+LBSb9LKyijBBurHKFITpRCjPAvmUKoHpEsPCRsngpC4xwYlxlQj9FboR0UqK2ZvDfFIcTW2GTTNujyUffjbFgk1tO3rqzEwWBBkpM4d1yAxm7mgDJiaYGx1IB7YhrFUyj8gNP3s2tOw5u4nzYgVXxG6cdGG06DDEjjMQJHnWa2XfRZwfFrKmeednExPXy/NDbWHTJBhkUL1sZ4xd0/COI2+N9q3HR6PRLqS+znPyflIrWNfXQ+C7H6Sush4a1m/X/uh3S/MTyxC1pV68CPvMbJSORkdPDw5HB6Nvzw+fp8ffp8+eD0aj0R+Y4E2lWHfVFWwNe7i1/3sLUiup6apD7+poNLo6PFxherwPxjNTUZhKXcKcdIC5M7pMwCoSniC4BYhSSA1KBHKP/jt8yTnj7kflYZ7dh8Ixo7AG4XgXhI7JTICJqXUkra8d6H1VtOvP/eEdX323Du/ZbngneiaULCKTB3NN+v9N5J7j2dXt0patUNzHrWD7622QnvLaybCIA+PmQFh50O6nF2OmYq4bw6PG1tFhHh0pDltUh8v1bGmQbblZN3tqpzDFaQjWp8OhsHZgLGkvS61E5ge5qYbCyuHsEJvktrQPopS6PHigltBFZm7u1hhvoj3jjLSgb8W8hl5Y+YYWmHSQ9qVWU3RKIrJ3kyAn+sNmZr3q0rU9IPqcv0v5yJmSemKiF6uMvbekz2SpY75nhztD+xOp3FTEsy9MCTrxv//8K2oUJq8r0iGW4yN4XzuwZk6OiV7oAiaKbmSmaM+9xJOoFHmvFiB1oNLxYC1kKYNQwPAymeTCikwqyQXMYoa1HfR6wA/g05TClBxvfeMIBBQ0I8V1D8qYa7YTDIg6mCqesfIZ5sZdT9ilBARktZeavAdP1KmQngqdE3RJTcA4EBpIB3LWSU8gZMXCE+OAJhOZSzbM3epEHqASWpTEhyXAfjMKtr1deHAmq30Ab1QdA+ETK6LQhqiJCj+AX+SM2sB5saAgpKICyppNJJCbgmDVvByGLiAjH8Dy8TKnaNQH4QIompGLZR8zOamVAmuYVaRQfCfr55YNBSe0Z+JrHepSs4bPOsMzPZ5RiMUALvWl5jkAtScuACX1tU8v9QFcrMvsE2VeBho/7ppqPp/vNNSTbZ3XMkzrDBxZs9Er42Jsv776+s8TTDCQq/z7yRm5mcxp1cl3nDmMwsMV14o8ci1VQqq2WX+6rcDdpGRO2lOPGV+8Pn0LM3g6GGHSo49/4fDw7cnLV+/OXrFdJrm2/w4Ho8EoXuCMD5XQvaO2Lv63G3e5GRlf5ZWwYrFAN2FolZBxDMR4lysK7+65mGC6eSCME5waH3h7ucyEp49ONQ0vf6nJ8ZAYJzgTToqM+eliiYX0/LtYvwDujPPxh9Ul+wnsfWvs9bmjY81cPBOqjvfdBK9psfWyacZN0jEyu9Xuv2wPPzhnKxv9nRnNw6TVeJHnZMO9sv2hePrxHBPMVu+UKr6E0Ik5P53EHFO8xEuMr7bIIfGpwetLVEKXtShZvjXLc0TUnJr+ELqOQ2j1gwPbC8j2dGoj4U+Oa6/CD1xib2jx41q83blTYQVtJ83JGTdN8w+NvTfZ",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={},v=[{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:"Update Folder"})}),"\n",(0,l.jsx)(d(),{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)(p.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(p.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)(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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,l.jsx)(p.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)(m.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)(p.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)(m.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)(p.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)(m.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)(p.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)(m.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)}}}]); |