WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-08 18:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
be795859cd3b929f89811236c3ecb06151c63af2
OpenSign/assets/js/bfe4b778.ff1818b8.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:()=>f,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var l=a(85893),t=a(11151),i=a(58219),d=(a(62316),a(51039)),n=a.n(d),r=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),u=a(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.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQN2mDFYjQOBiwxDFo6WUwpkiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7bcDzhYPkFt7rtCpReQfTCDJ0qRXGC60ggUmB7MZk3CPrrNj5+JJxKfXKscqhdcxrVupM5GvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4zSKDZ2gWCCAy3vESPlvLcgOIlQgKdg5nIIAJBeRruCzhM/vI9RQ6JdLn7gnumELOQ9RzbbMmPxa+VsJhB4m2FETi/lhTNidJIhAjwwUidISQ5l44M0gJLDskG/NoES2+FWkAEubYl97uVup42/tH5tzpb0579VMdWL0WGbI5Sr9gWNiXZ8YmlkdyjY0fcM4nceaYV9mw7AK8gglQrTxQmG+DGSJEGkkf3jqJtHqeu5/eYBsYtHYkX6OhtQ/jfAyRyeKApARf+bCmHOgKl/YvdjAkiMotLgasgLCcWivlCuD3fezy+LMRWFX0fNe2RGVpS5Mv8vb13c34yL/QY6joCL/xemFlPt7M5yaCuyc6iM1q5hvGTOH6sju3Va9XKXJWm6FxeSbn+6ccdd7P8NPAdTO6yk49ufPbREFltSuf++U0n8cnp4DgexD9Pjt8kZ78kr98M4zj+EyJ4KOVOa0DeoM9eeO4tCCWFwlnH2uwkjmenLZVnT7HXKsm0V2zJpchYLlBmjGK6H0ggWqvtP1T6M/k9B58gd+DPnpGO0p7lulLZ/w33qYyeB3g2O9tCfP0Y4qVqKKO+NNFfUP0XCHd4+uF9E55S3Ve1aIzCe9gD219vQJboC03t0FRND/QFJDDqqsdo06sjNUTg0C67DllZCQkU3huXjEbO84VQiwE3ZqgNKqqgks/dMNXliBsxWh4DtSaHaWWFX18TKw3whwE3YtDktYPPjfgN1xB1sPpWbScukGdoAwVE9udd17voKNuyctgquk7xfcX/sN0/Wc771XyvQFO6uQ7Y2rO4MqiuKQyd5PL4kf8JRRcuvO5iBVWxXFt2sJvNucOMaRXmD3pJ66fD4+0cFLYO2Z26U9e6RJql8koyKdQXl9ypAbu9ynORCi7ZHzh3wuP0qDvY1Wr16EBfhT0fhC+qObNo9M58ERbDqfd3bR9oYvBoS3eVX6NdihRbEX0j1CgYj9prxtNwzbDkgsTXLv16uIkolyJF5foSOP8w/sROhzFEPe1+R8qjT5fvLn6/viCvpP7miI6H8TCmJaOdL7nqBTqYYg9Pd7OrGP/60NteJo8PfmQkF6EiBPSb9rbfQk/lSX/enUZQaOfJZLMhjd1YWde0/LVCu4bkdhrBklvB5yTq2w1kwtH/bDu3fhP30edugmQvG52fBNSVDEX1YsllRU8QwRdcH8zw9bSOurpBGTcW75q8BhPys/PwqJrXUbfjPE3R+Gdtp73yOr6ZQATzdh4vw2gPlq/oW4CvIIE7uIPwjUIOQlUM6xuQXC0qviD7xi39/gJfGpsS",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={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.",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.",sidebar_label:"Update Document",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQN2mDFYjQOBiwxDFo6WUwpkiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7bcDzhYPkFt7rtCpReQfTCDJ0qRXGC60ggUmB7MZk3CPrrNj5+JJxKfXKscqhdcxrVupM5GvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4zSKDZ2gWCCAy3vESPlvLcgOIlQgKdg5nIIAJBeRruCzhM/vI9RQ6JdLn7gnumELOQ9RzbbMmPxa+VsJhB4m2FETi/lhTNidJIhAjwwUidISQ5l44M0gJLDskG/NoES2+FWkAEubYl97uVup42/tH5tzpb0579VMdWL0WGbI5Sr9gWNiXZ8YmlkdyjY0fcM4nceaYV9mw7AK8gglQrTxQmG+DGSJEGkkf3jqJtHqeu5/eYBsYtHYkX6OhtQ/jfAyRyeKApARf+bCmHOgKl/YvdjAkiMotLgasgLCcWivlCuD3fezy+LMRWFX0fNe2RGVpS5Mv8vb13c34yL/QY6joCL/xemFlPt7M5yaCuyc6iM1q5hvGTOH6sju3Va9XKXJWm6FxeSbn+6ccdd7P8NPAdTO6yk49ufPbREFltSuf++U0n8cnp4DgexD9Pjt8kZ78kr98M4zj+EyJ4KOVOa0DeoM9eeO4tCCWFwlnH2uwkjmenLZVnT7HXKsm0V2zJpchYLlBmjGK6H0ggWqvtP1T6M/k9B58gd+DPnpGO0p7lulLZ/w33qYyeB3g2O9tCfP0Y4qVqKKO+NNFfUP0XCHd4+uF9E55S3Ve1aIzCe9gD219vQJboC03t0FRND/QFJDDqqsdo06sjNUTg0C67DllZCQkU3huXjEbO84VQiwE3ZqgNKqqgks/dMNXliBsxWh4DtSaHaWWFX18TKw3whwE3YtDktYPPjfgN1xB1sPpWbScukGdoAwVE9udd17voKNuyctgquk7xfcX/sN0/Wc771XyvQFO6uQ7Y2rO4MqiuKQyd5PL4kf8JRRcuvO5iBVWxXFt2sJvNucOMaRXmD3pJ66fD4+0cFLYO2Z26U9e6RJql8koyKdQXl9ypAbu9ynORCi7ZHzh3wuP0qDvY1Wr16EBfhT0fhC+qObNo9M58ERbDqfd3bR9oYvBoS3eVX6NdihRbEX0j1CgYj9prxtNwzbDkgsTXLv16uIkolyJF5foSOP8w/sROhzFEPe1+R8qjT5fvLn6/viCvpP7miI6H8TCmJaOdL7nqBTqYYg9Pd7OrGP/60NteJo8PfmQkF6EiBPSb9rbfQk/lSX/enUZQaOfJZLMhjd1YWde0/LVCu4bkdhrBklvB5yTq2w1kwtH/bDu3fhP30edugmQvG52fBNSVDEX1YsllRU8QwRdcH8zw9bSOurpBGTcW75q8BhPys/PwqJrXUbfjPE3R+Gdtp73yOr6ZQATzdh4vw2gPlq/oW4CvIIE7uIPwjUIOQlUM6xuQXC0qviD7xi39/gJfGpsS",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 s={h2:"h2",p:"p",...(0,t.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"})}),"\n",(0,l.jsx)(n(),{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)(c.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)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document description"}}),(0,l.jsx)(o.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)(i.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.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)(m.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)(o.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)(m.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)(o.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)(m.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)(o.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.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