WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 21:27:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
6ca96a4d76cc0e8185f9b865815e7d2d7df6cfdd
OpenSign/assets/js/8a855f99.f26e9936.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var l=s(85893),r=s(11151),n=s(58219),d=(s(62316),s(51039)),t=s.n(d),i=(s(82723),s(9487)),o=s(41429),m=s(5397),p=s(4667),c=s(9472),h=s(85162);const u={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:"eJy9Vm1v2zYQ/ivcfWoA2ZaTtNuEYVhWZJ2bogmaBAOWGAEtnWw2FMmSlB3D0H8fjpJsOXaMBVj3xS+8F949d/fwVuD51EFyB39omaGFcQQZutQK44VWkMDNDNmtybhHVquws6sR41LqhWNLXTKvWamDPK/lihfIuGMLlJK+DbeofG08yvoQgTZoOfkfZZBAGbzXxhCB4ZYX6NFSWCsgb5BALX4QGUQgKC7D/QyeB6snXzH1o4zpnK0dWvxWCosZJN6WGIHzS0kunSiMRIgAn4zUGUKSc+lIIZ1hwSFZgV+aoOmtUFOIINe24L57gk88eElgcjFM8+x4ZiZQVeP6WnT+d50tydV2oFdWz0WGbIJSL9g6ZQIztbgBEyJItfKoPPngxkiRBuQGXx05WnWC3eR518AVsBtHbRo1OgSxpQp4gY7sat3PAefXpaxw0cZZhcJ16vxaX1BVEXjhZafaE8Kuqkhi0RmtXB3xcRzvQurKNEXn8lKydX+9Br7DILWd9dq0/nx0xx8NLkaGIKpbPTvz+9xsjI7j45PeMO7FP94M3yWnPydv3/XjOP4bIngqJNk2U0HeoINb/b9zIJQUCh9a9B6O4/hhOGwwPd0H47Uu0M+EmrIFKs8WVqtpxIxE7pB5u2R8yoViknu0P/x3+KK12h5G5XWRHULhlFBYg3C6C0LLZNqzXJcqkNb3TvRQF+3Gczi904ef1um93U1vpOZciiwwudePqP7fQu65nkLdbm1RKwU5bCXbPa+TdJiWVvhleDCeetyIXi1P7sZExdQ3mp4aU4aA6elIYFCjOlit35YKyJedt29PaSUkMPPeuGQw4Mb0tUHlxFRJPnH9VBcDbsRgPoQqeq7tPJ8KNe0dtBpvYr8mfGsItzJYA8mNuMAlRC1AXa3mTZwhD1xcRUBl+7J5gc5b8LfpvsvguwQOhLtQuQ5RNPhfGlTXYqpC9ebDnSf4ZiYcEy6IM52WBSofOonl2rJn1mzCHWZMK+ZnGIR0ftIfMmcwFXnThH12r+4VzT8rHRLDS6EeXXKveuzuMs9FKrhkf+HECY/jN20JFovFDvRHweaD8LNywiwavVGfhsNQn67V+s8RRODRFu4yv0Y7Fyk25X7hqkFQHjSjxdMwWlhwQW3SHP323IgglyJF5bAzDGcfrj6xOTvpxxB1+uxfBD34NHp//vn6nPxSX9dFGvbjfhzebO18wVXnqq1d73l1VxuW+C6LYdPqHp/8wEguwuSHfFfN1LarDUSQbHbCcQQz7TyJVyvqqVsrq4qOv5VoiRfGEcy5FXxCTXy3gkw4+p2tl74X83zzpdmrjtje9XJvzO3MKhrYOZdlWHEieMTl1jJbjauoHVsKq5a/ry/v3ZCXjf0OLRPr1BZnaYrGH9Tt8uDV7Q1EMGlW0yIsv2D5grZlvoAE7uEewqJODgIphfMVSK6mJZ+Sfu2WyIaXVJouUz0Gpmp+UGJ7AdmmsDoT+qS89hr8Qi12gctf1+q15EWDBtpWm4ozrqrqH7urcWY=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={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:"eJy9Vm1v2zYQ/ivcfWoA2ZaTtNuEYVhWZJ2bogmaBAOWGAEtnWw2FMmSlB3D0H8fjpJsOXaMBVj3xS+8F949d/fwVuD51EFyB39omaGFcQQZutQK44VWkMDNDNmtybhHVquws6sR41LqhWNLXTKvWamDPK/lihfIuGMLlJK+DbeofG08yvoQgTZoOfkfZZBAGbzXxhCB4ZYX6NFSWCsgb5BALX4QGUQgKC7D/QyeB6snXzH1o4zpnK0dWvxWCosZJN6WGIHzS0kunSiMRIgAn4zUGUKSc+lIIZ1hwSFZgV+aoOmtUFOIINe24L57gk88eElgcjFM8+x4ZiZQVeP6WnT+d50tydV2oFdWz0WGbIJSL9g6ZQIztbgBEyJItfKoPPngxkiRBuQGXx05WnWC3eR518AVsBtHbRo1OgSxpQp4gY7sat3PAefXpaxw0cZZhcJ16vxaX1BVEXjhZafaE8Kuqkhi0RmtXB3xcRzvQurKNEXn8lKydX+9Br7DILWd9dq0/nx0xx8NLkaGIKpbPTvz+9xsjI7j45PeMO7FP94M3yWnPydv3/XjOP4bIngqJNk2U0HeoINb/b9zIJQUCh9a9B6O4/hhOGwwPd0H47Uu0M+EmrIFKs8WVqtpxIxE7pB5u2R8yoViknu0P/x3+KK12h5G5XWRHULhlFBYg3C6C0LLZNqzXJcqkNb3TvRQF+3Gczi904ef1um93U1vpOZciiwwudePqP7fQu65nkLdbm1RKwU5bCXbPa+TdJiWVvhleDCeetyIXi1P7sZExdQ3mp4aU4aA6elIYFCjOlit35YKyJedt29PaSUkMPPeuGQw4Mb0tUHlxFRJPnH9VBcDbsRgPoQqeq7tPJ8KNe0dtBpvYr8mfGsItzJYA8mNuMAlRC1AXa3mTZwhD1xcRUBl+7J5gc5b8LfpvsvguwQOhLtQuQ5RNPhfGlTXYqpC9ebDnSf4ZiYcEy6IM52WBSofOonl2rJn1mzCHWZMK+ZnGIR0ftIfMmcwFXnThH12r+4VzT8rHRLDS6EeXXKveuzuMs9FKrhkf+HECY/jN20JFovFDvRHweaD8LNywiwavVGfhsNQn67V+s8RRODRFu4yv0Y7Fyk25X7hqkFQHjSjxdMwWlhwQW3SHP323IgglyJF5bAzDGcfrj6xOTvpxxB1+uxfBD34NHp//vn6nPxSX9dFGvbjfhzebO18wVXnqq1d73l1VxuW+C6LYdPqHp/8wEguwuSHfFfN1LarDUSQbHbCcQQz7TyJVyvqqVsrq4qOv5VoiRfGEcy5FXxCTXy3gkw4+p2tl74X83zzpdmrjtje9XJvzO3MKhrYOZdlWHEieMTl1jJbjauoHVsKq5a/ry/v3ZCXjf0OLRPr1BZnaYrGH9Tt8uDV7Q1EMGlW0yIsv2D5grZlvoAE7uEewqJODgIphfMVSK6mJZ+Sfu2WyIaXVJouUz0Gpmp+UGJ7AdmmsDoT+qS89hr8Qi12gctf1+q15EWDBtpWm4ozrqrqH7urcWY=",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:"Get folder list",permalink:"/docs/API-docs/folderlist"}},j={},g=[{value:"Request",id:"request",level:2}];function v(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)(t(),{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)(i.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)(i.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)(i.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)(i.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)(i.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)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink