WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-13 13:17:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
98bd31d975f27a0c0aa8db72ff6f7c19acab3459
OpenSign/assets/js/bfe4b778.9ac115fd.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:()=>j,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),d=s.n(i),r=(s(82723),s(9487)),o=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/ivcfUoB2VZe2mHCMCxrizZo0RhNggFLDIOWTjYbimRJyo5h6L8PR0m2bCduMxQbsC+GTN3b89zx7rQCz6cOklt4o9OyQOUdjCLI0KVWGC+0ggSuZ8huTMY9slaKnQ8vGJdSLxwrHVrHvGaFzkS+ZFxlrKzF/QxZhp4L6ZjOGWfOYCpykbKsMdRnn3QQ5J75mXDBsFZy2Vr3ujXGWY4LZrjlBXq0LmJLXbKUK6U9S2dcTWuHuZDItEqRCV9H0AYtHEstco9ZHyLQBi0niBcZJFA7afFBBBtHkNyuQPECIYHW1lhkEIEgegz3M9jl7OINAd7yHjAqxCyAmmCDi+xY/FoKixkk3pYYgfNLSd6cKIxEiAAfjNQZQpJz6UggnWHBIVmBX5og6a1QU4gg17bgfnNSVaPaPjr/h86WpLMd6tDquciQTVDqDr8d5j0WRnKPjh1xzyRy55lW2JFtAbyACFKtPFGYrIAbI0UaSB58ceRttR+6nnzBNDBuKSVeoKO3NeHfBkjk8EBTAi48rCmHKgKl/bPNDAkiMotzgYtQz05MVV2fXdtbPD7PxboqujYq0pEZWqrIfXsbbaiqCLzwW6bGndocTyjVVUVyFp3RytWsnsTxfgWsb3VTkcyVaYrO5aWUy59+XErr42+B4y47ee+GZ+8NEdKEdO4PK53EJ6e947gX/3x9/Co5+yV5+aofx/FfEMFDITf1BGQNuuyF/50DoaRQOG5ZG5/E8fi0ofLsMfaaajHNNZpzKTKWC5QZI5/uBxKI1mr7D6v5QHyH4BPkFvzZgdKhJpzrUmX/NdzHIjoM8Gx8tob4ch/ihaopo8l0re9R/RsIN3i67n3tnkLdrmpRC4X3sAW2e16DdJiWVvhlGGsPPW5Er36f3I5oWBToZ5pGoinrOehnkMCg7S6DVafPVED27LydkqWVkMDMe+OSwYAb09cGFXVPySeun+piwI0YzI+hinalnedToaa9g1qjTfxXxHFN4xaKNZnciA+4hKglqSvVzO4Z8gxtIJRS93kzJ9+2CVhzvDtc2tnyfeNid0F4dAB0+z9QHoXKdUDU5PPSoLoi41QN8+M9q9fks9miWg+hMlmuLdvRZhPuMGNahT2FXtL5af94vaYF1T67U3fqShdIq15eSiaFunfJneqx28s8F6ngkv2JEyc8jo7adC4Wi700vgg674SflRNm0eiN+DQchlx3tdZ/aLPwaAt3mV+hnYsUm9J5wtUgCA+aq8rTcFWx4IJKrjn6fVeJKJciReW6iT9/N/zI5uy0H0PUqdnvCHrw8eL1209Xb8ku3ZE6Scf9uB/TkdHOF1x1XO2s2bv5XW36zv91K2/urscHPzCSi9DOAumrphXdQudSJd2FfBTBTDtPIqsVFfeNlVVFx19LtNTwRhHMuRV8QrfpdgWZcPScrRfrJ+k++tyuuOx5u/2jgNoOpag9zbksw1YXwT0udz4yqlEVtW2KIq4lXtdx9a7JzsbC3iiiLltrnKcpGn9Qttv7hzfXEMGk+WAowrcHWL6gjxW+gATu4A7CRxQZCE04nK9AcjUt+ZTka7PUXHlJmet25vvQmZsHAvYoJdstu0ZCv4TrUYVfqVI/4PK3tXj95kmFhtpWmtIzqqrqb4+1NuQ=",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",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/ivcfUoB2VZe2mHCMCxrizZo0RhNggFLDIOWTjYbimRJyo5h6L8PR0m2bCduMxQbsC+GTN3b89zx7rQCz6cOklt4o9OyQOUdjCLI0KVWGC+0ggSuZ8huTMY9slaKnQ8vGJdSLxwrHVrHvGaFzkS+ZFxlrKzF/QxZhp4L6ZjOGWfOYCpykbKsMdRnn3QQ5J75mXDBsFZy2Vr3ujXGWY4LZrjlBXq0LmJLXbKUK6U9S2dcTWuHuZDItEqRCV9H0AYtHEstco9ZHyLQBi0niBcZJFA7afFBBBtHkNyuQPECIYHW1lhkEIEgegz3M9jl7OINAd7yHjAqxCyAmmCDi+xY/FoKixkk3pYYgfNLSd6cKIxEiAAfjNQZQpJz6UggnWHBIVmBX5og6a1QU4gg17bgfnNSVaPaPjr/h86WpLMd6tDquciQTVDqDr8d5j0WRnKPjh1xzyRy55lW2JFtAbyACFKtPFGYrIAbI0UaSB58ceRttR+6nnzBNDBuKSVeoKO3NeHfBkjk8EBTAi48rCmHKgKl/bPNDAkiMotzgYtQz05MVV2fXdtbPD7PxboqujYq0pEZWqrIfXsbbaiqCLzwW6bGndocTyjVVUVyFp3RytWsnsTxfgWsb3VTkcyVaYrO5aWUy59+XErr42+B4y47ee+GZ+8NEdKEdO4PK53EJ6e947gX/3x9/Co5+yV5+aofx/FfEMFDITf1BGQNuuyF/50DoaRQOG5ZG5/E8fi0ofLsMfaaajHNNZpzKTKWC5QZI5/uBxKI1mr7D6v5QHyH4BPkFvzZgdKhJpzrUmX/NdzHIjoM8Gx8tob4ch/ihaopo8l0re9R/RsIN3i67n3tnkLdrmpRC4X3sAW2e16DdJiWVvhlGGsPPW5Er36f3I5oWBToZ5pGoinrOehnkMCg7S6DVafPVED27LydkqWVkMDMe+OSwYAb09cGFXVPySeun+piwI0YzI+hinalnedToaa9g1qjTfxXxHFN4xaKNZnciA+4hKglqSvVzO4Z8gxtIJRS93kzJ9+2CVhzvDtc2tnyfeNid0F4dAB0+z9QHoXKdUDU5PPSoLoi41QN8+M9q9fks9miWg+hMlmuLdvRZhPuMGNahT2FXtL5af94vaYF1T67U3fqShdIq15eSiaFunfJneqx28s8F6ngkv2JEyc8jo7adC4Wi700vgg674SflRNm0eiN+DQchlx3tdZ/aLPwaAt3mV+hnYsUm9J5wtUgCA+aq8rTcFWx4IJKrjn6fVeJKJciReW6iT9/N/zI5uy0H0PUqdnvCHrw8eL1209Xb8ku3ZE6Scf9uB/TkdHOF1x1XO2s2bv5XW36zv91K2/urscHPzCSi9DOAumrphXdQudSJd2FfBTBTDtPIqsVFfeNlVVFx19LtNTwRhHMuRV8QrfpdgWZcPScrRfrJ+k++tyuuOx5u/2jgNoOpag9zbksw1YXwT0udz4yqlEVtW2KIq4lXtdx9a7JzsbC3iiiLltrnKcpGn9Qttv7hzfXEMGk+WAowrcHWL6gjxW+gATu4A7CRxQZCE04nK9AcjUt+ZTka7PUXHlJmet25vvQmZsHAvYoJdstu0ZCv4TrUYVfqVI/4PK3tXj95kmFhtpWmtIzqqrqb4+1NuQ=",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"}},j={},g=[{value:"Request",id:"request",level:2}];function y(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)(o.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)(r.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",example:""}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.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)(r.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)(r.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)(r.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)(r.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 v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink