WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 12:34:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c4fb901174b535b11a91c20fca670b375880ece9
OpenSign/assets/js/bfe4b778.8a6fea27.js
T

1 line
13 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),o=(s(82723),s(9487)),r=s(41429),c=s(5397),m=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",source:"@site/docs/API-docs/update-document.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-document",permalink:"/docs/API-docs/update-document",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-document",title:"Update Document",description:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzdV21v2zYQ/ivcfWoB2VZe2mHCMCx9QRu0aI0mxYAlhkFLJ4sNRbIkZccw9N+HoyRbdlyvGYoN2BdDJu/tee54R67B87mD5AZe6bQqUXkHkwgydKkVxgutIIHrAtlnk3GPrJNiF+NLxqXUS8cqh9Yxr1mpM5GvGFcZqxpxXyDL0HMhHdM548wZTEUuUpa1hobsgw6C3DNfCBcMayVXnXWvO2Oc5bhkhlteokfrIrbSFUu5UtqztOBq3jjMhUSmVYpM+CaCLmjhWGqRe8yGEIE2aDlBvMwggcZJhw8i2DqC5GYNipcICXS2piKDCATRY7gvYJ+zy1cEeMd7wKgQswBqhi0usmPxayUsZpB4W2EEzq8keXOiNBIhArw3UmcISc6lI4G0wJJDsga/MkHSW6HmEEGubcn9dqWuJ419dP6Fzlaksxvq2OqFyJDNUOoevz3mPZZGco+OPeGeSeTOM62wJ9sBeAoRpFp5ojBZAzdGijSQPPriyNv6Yeh69gXTwLillHiBjnYbwv8eIJHDA00JuPCxoRzqCJT2jzYzJojILC4ELkM9OzFXTX32be/w+DgXm6ro26hJR2ZoqSIfZ+/FFzfjp7NCj6GuI/DC77iZ9up2OqMyqGuSs+iMVq5h/DSOH1bH5sS31cpclaboXF5Jufrpx6W7WT4MfAuTu+z0rRufvzVEVhvShT+udBqfng1O4kH88/XJ8+T8l+TZ82Ecx39CBPel3NYakDXosxf+9xaEkkLhtGNtehrH07OWyvND7LWVZNojtuBSZCwXKDNGPt0PJBCt1fYfVvqR+I7BJ8gd+PMjpUMNOteVyv5ruIciOg7wfHq+gfjsIcRL1VBGU+ta36H6NxBu8fTd+8Y9hbpb1aIRCvuwA7a/3oB0mFZW+FUYefcDbsSg2U9uJjRISvSFpnFpqmZG+gISGHXdZbTu9ZkayJ5ddBO0shISKLw3LhmNuDFDbVBRZ5V85oapLkfciNHiBOpoX9p5PhdqPjiqNdnGf0UcNzTuoNiQyY14hyuIOpL6Uu1cL5BnaAOhlLpP2xn6ukvAhuP9wdPNne8bJfuXh4PDoT8bdto9hZvrgK3N7EeD6orcUF0sTh7Yvybv7V2r8xVqlOXasj1tNuMOM6ZVuM3QJq2fDU82l7mgOmS36lZd6RLpQphXkkmh7lxyqwbs5mOei1Rwyf7AmRMeJ0+6xC6XywcJfRp03ghfVDNm0eit+Dwshqz3tTZ/6P7h0ZbuY36FdiFSbIvoG65GQXjUHlqehkOLJRdUfO3S7/tKRLkUKSrXL4GLN+P3bMHOhjFEver9jqBH7y9fvv5w9Zrs0mlpknQyjIcxLRntfMlVz9XeZXw/v+ttB/q/3t3bU+zx3o+M5CI0tkD6um1KN9A7Xkn/2j6JoNDOk8h6TcX92cq6puWvFVpqfZMIFtwKPqPTdLOGTDj6zjbX72/S/eRTdxFmj3sBHATU9SpFjWrBZUX/III7XO09RepJHXUNiyJuJF42cQ2uyc7WwoOhRP220bhIUzT+qGx/Cow/X0MEs/ZZUYYXCli+pCcNX0ICt3AL4alFBkI7DutrkFzNKz4n+cYstVleUeb6Pfou9Oj2g4AdpGS3eTdI6JdwHVT4lSr1Ha5+24g3O99UaKntpCk9k7qu/wJ4KEQs",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Update Document"})}),"\n",(0,t.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(r.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"ID of the document that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document updated successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,t.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,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"400",value:"400",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink