WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-12 20:57:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c65d3cecf43fccd545a5b2ccc8cb44c46318e4d5
OpenSign/assets/js/bfe4b778.505e4272.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>f,toc:()=>b});var l=a(85893),i=a(11151),n=a(58219),t=(a(62316),a(51039)),d=a.n(t),r=(a(82723),a(9487)),m=a(41429),o=a(5397),c=a(4667),p=a(9472),u=a(85162);const h={id:"update-document",title:"Update document by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV1Fv2zYQ/ivcPbWAbCtO2mF6WtpkbbCiNZoUA5YYBiWdLLYUyZKUHcPQfx+OkmwlTrNm6DY/Wafj3X3fHe9OW/B86SC5hjOd1RUq72AeQY4us8J4oRUkcFUi+2Ry7pH1Wux0dsG4lHrtWO3QOuY1q3Quig3jKmd1q+5LZDl6LqRjumCcOYOZKETG8s7QGCLQBi0nXxc5JNAe7R1BBIZbXqFHS3FuQfEKIYHewELkEIGgOA33JdwP/uKMPIdA+th9yT1TiHmIOsUuWrJj8WstLOaQeFtjBM5vJHlzojISIQK8NVLnCEnBpSOFrMSKQ7IFvzFB01uhlhBBoW3F/V7SNPPWPjr/SucbOnM31JnVK5EjS1HqNdvBpiB7PrEyknt07Bn3TCJ3nmmFA90ewHOIINPKE4XJFrgxUmSB5MlnR962h6Hr9DNmgXFLKfECHb19Hwj/e4BEDg80JeDCnx3l0ETwXvsnm5kRRGQWVwLXobCcWCrmS+Hu2D4b8vg0F7uqGOaiieA3LXO0VJFPs/fqs0v5NC31DJomAi/8HTeLQd0uUiqDpiE9i85o5VrGp3F8WB27q9dVK3N1lqFzRS3l5qcfl+5W/DDwPUzu8ulbNzt5a4isLqRT//ihaTw9Hh3Fo/jnq6OXyckvyYuX4ziO/4QIbitJZ/vLzT3CkL3wPBAIJYXCRc/aYhrHi2lH5clD7HWVZLortuJS5KwQKHNGPt0PJBCt1fYfVvoj8T0GnyD34E8eKR2lPSt0rfL/G+5DET0O8GRxsoP44hDihWopo7l0pb+g+i8Q7vEM3fvWPYV6t6pFqxTewx2wQ3kLskJfahqHpm5noC8hgUnfPSbbQR9pIAKHdtVPyNpKSKD03rhkMnGeL4VajrgxY21QUQeVPHXjTFcTbsRkdQQ0mhxmtRV+c0mstMBvR9yIURvXHj434nfcQNTDGmp1k7hEnqMNFBDZH/dT77ynrJ8rB6OinxTf1/zv9f6H2/mwm99p0BRuoQO2LhcfDKpLckOZXB0drBNX5F248Lr3FaqKFdqye6dZyh3mTKuwf9BLkh+Pj3Z7UDg6ZjfqRl3qCmmXKmrJpFBfXHKjRuz6Q1GITHDJ/sDUCY/zZ31i1+v1QUKfhzNvhC/rlFk0eq++DMKQ9eGp3QNtDB5t5T4Ul2hXIsOuiL7hahKUJ90141m4ZlhxQcXXiX69f4golyJD5XBwMU7fzN6x43EM0aB2vyPkybuL1+fvL8/JKlV/m6KjcTyOSWS08xVXA0fdFrsrknTDLs7u53i77xv/+urbXSmPt35iJBehLwQOtt2dv4ZBrSfDrXceQamdJ5Xtlirtk5VNQ+KvNdoNJNfzCFbcCp5SaV9vIReO/ue77fWbuJ997PdI9rQF+kFAfeNQ1DVWXNb0BBF8wc29Tb6ZN1HfPSjiVuN1G9foiuzsLRz09CbqT5xmGRr/qO580GRnn64ggrTbyquw4IPla/oi4GtI4AZuIHypkIHQG4N8C5KrZc2XpN+apd9fsoOb2Q==",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/update-document",title:"Update document by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",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 by ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV1Fv2zYQ/ivcPbWAbCtO2mF6WtpkbbCiNZoUA5YYBiWdLLYUyZKUHcPQfx+OkmwlTrNm6DY/Wafj3X3fHe9OW/B86SC5hjOd1RUq72AeQY4us8J4oRUkcFUi+2Ry7pH1Wux0dsG4lHrtWO3QOuY1q3Quig3jKmd1q+5LZDl6LqRjumCcOYOZKETG8s7QGCLQBi0nXxc5JNAe7R1BBIZbXqFHS3FuQfEKIYHewELkEIGgOA33JdwP/uKMPIdA+th9yT1TiHmIOsUuWrJj8WstLOaQeFtjBM5vJHlzojISIQK8NVLnCEnBpSOFrMSKQ7IFvzFB01uhlhBBoW3F/V7SNPPWPjr/SucbOnM31JnVK5EjS1HqNdvBpiB7PrEyknt07Bn3TCJ3nmmFA90ewHOIINPKE4XJFrgxUmSB5MlnR962h6Hr9DNmgXFLKfECHb19Hwj/e4BEDg80JeDCnx3l0ETwXvsnm5kRRGQWVwLXobCcWCrmS+Hu2D4b8vg0F7uqGOaiieA3LXO0VJFPs/fqs0v5NC31DJomAi/8HTeLQd0uUiqDpiE9i85o5VrGp3F8WB27q9dVK3N1lqFzRS3l5qcfl+5W/DDwPUzu8ulbNzt5a4isLqRT//ihaTw9Hh3Fo/jnq6OXyckvyYuX4ziO/4QIbitJZ/vLzT3CkL3wPBAIJYXCRc/aYhrHi2lH5clD7HWVZLortuJS5KwQKHNGPt0PJBCt1fYfVvoj8T0GnyD34E8eKR2lPSt0rfL/G+5DET0O8GRxsoP44hDihWopo7l0pb+g+i8Q7vEM3fvWPYV6t6pFqxTewx2wQ3kLskJfahqHpm5noC8hgUnfPSbbQR9pIAKHdtVPyNpKSKD03rhkMnGeL4VajrgxY21QUQeVPHXjTFcTbsRkdQQ0mhxmtRV+c0mstMBvR9yIURvXHj434nfcQNTDGmp1k7hEnqMNFBDZH/dT77ynrJ8rB6OinxTf1/zv9f6H2/mwm99p0BRuoQO2LhcfDKpLckOZXB0drBNX5F248Lr3FaqKFdqye6dZyh3mTKuwf9BLkh+Pj3Z7UDg6ZjfqRl3qCmmXKmrJpFBfXHKjRuz6Q1GITHDJ/sDUCY/zZ31i1+v1QUKfhzNvhC/rlFk0eq++DMKQ9eGp3QNtDB5t5T4Ul2hXIsOuiL7hahKUJ90141m4ZlhxQcXXiX69f4golyJD5XBwMU7fzN6x43EM0aB2vyPkybuL1+fvL8/JKlV/m6KjcTyOSWS08xVXA0fdFrsrknTDLs7u53i77xv/+urbXSmPt35iJBehLwQOtt2dv4ZBrSfDrXceQamdJ5Xtlirtk5VNQ+KvNdoNJNfzCFbcCp5SaV9vIReO/ue77fWbuJ997PdI9rQF+kFAfeNQ1DVWXNb0BBF8wc29Tb6ZN1HfPSjiVuN1G9foiuzsLRz09CbqT5xmGRr/qO580GRnn64ggrTbyquw4IPla/oi4GtI4AZuIHypkIHQG4N8C5KrZc2XpN+apd9fsoOb2Q==",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 by ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},j={},b=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"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)(s.p,{children:"Update document by ID"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"The Update Document API allows users to modify and update the details of a specific document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{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)(s.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.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,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{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)(s.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)(s.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(c.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,l.jsx)(c.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Bjsba2bhoP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(c.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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(u.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:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink