WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-30 21:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
efbb51cf15f2ce2d7f51c72cd5cb94aac3aa89af
OpenSign/assets/js/bfe4b778.01268790.js
T

1 line
12 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:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),o=s(41429),m=s(5397),c=s(4667),p=s(9472),u=s(85162);const h={id:"update-document",title:"Update Document from ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQJ2mDFYjQJBiwxDFo6WUwokiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7rcHzuYPkFs50WpWovINJBBm61ArjhVaQwHWB7MZk3CPrrNjp+IJxKfXSscqhdcxrVupM5CvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4ySKDZ2gWCCAy3vESPlvJcg+IlQgKdg6nIIAJBeRruC9hP/uKMIodEutx9wT1TiFnIeoZttuTH4tdKWMwg8bbCCJxfSYrmRGkkQgT4aKTOEJKcS0cGaYElh2QNfmWCpbdCzSGCXNuS++1KXU8a/+j8e52taM9uqmOrFyJDNkOpl2wDm5Ls+MTSSO7RsQPumUTuPNMKe7YdgDcQQaqVJwqTNXBjpEgDyaN7R9HWT1PXs3tMA+OWjsQLdPS2IfzvARI5PNCUgAt/NpRDHYHS/tVuxgQRmcWFwGUQlhNzxXwh3I7vHR5fF2Kjir6PmvbIDC0p8nX+3t+7GT+aFXoMdR2BF34nzLSn2+mMZFDXZGfRGa1cw/hRHD9Vx+bqtWplrkpTdC6vpFz99OOOu1l+HvgWJnfZ0Sc3PvlkiKw2pVP/8qaj+Oh4cBgP4p+vD98lJ78kb98N4zj+EyJ4LOVWa0DeoM9eeO4tCCWFwmnH2vQojqfHLZUnz7HXKsm0V2zBpchYLlBmjGK6H0ggWqvtP1T6C/m9BJ8gd+BPXpCO0p7lulLZ/w33uYxeBngyPdlAfPsU4oVqKKO+dK0fUP0XCLd4+uF9E55S3VW1aIzCe9gB219vQJboC03t0FRND/QFJDDqqsdo3asjNUTg0C66DllZCQkU3huXjEbO87lQ8wE3ZqgNKqqgks/cMNXliBsxWhwCtSaHaWWFX10RKw3wxwE3YtDktYXPjfgNVxB1sPpWbScukGdoAwVE9pdt1zvvKNuwst8quk7xfcV/v90/W8771XynQFO6uQ7Y2rO4NKiuKAyd5OLwif9rii5ceN3FCqpiubZsbzebcYcZ0yrMH/SS1o+Hh5s5KGwdsjt1p650iTRL5ZVkUqgHl9ypAbu9zHORCi7ZHzhzwuPkoDvY5XL55EDfhD0fhS+qGbNo9NZ8HhbDqfd3bR5oYvBoS3eZX6FdiBRbEX0j1CgYj9prxtNwzbDkgsTXLv26v4kolyJF5foSOP04/syOhzFEPe1+R8qjzxcfzn+/OievpP7miA6H8TCmJaOdL7nqBdqfYnOrS3Zxtn/K623l+NeH3/ZSeXz0IyO5CJUhsLBub/0t9NSe9OfeSQSFdp5M1mvS2o2VdU3LXyu0K0huJxEsuBV8RuK+XUMmHP3PNvPrN3EffOkmSfa6EfpZQF3pUFQ3FlxW9AQRPOBqb5avJ3XU1Q/KuLH40OQ1uCY/Ww9PqnoddTtO0xSNf9F20iuz45triGDWzuVlGPHB8iV9E/AlJHAHdxC+VchBqI5hfQ2Sq3nF52TfuKXfX75rnZM=",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 from 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 from ID",description:"The Update Document API allows users to modify and update the details of a specific document.",sidebar_label:"Update Document from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21v2zYQ/ivcfUoB2VZe2mH6tLQJ2mDFYjQJBiwxDFo6WUwokiUpO4ah/z4cJdmyk2bN0G3+ZFHHu3sePrw7rcHzuYPkFs50WpWovINJBBm61ArjhVaQwHWB7MZk3CPrrNjp+IJxKfXSscqhdcxrVupM5CvGVcaqxtwXyDL0XEjHdM44cwZTkYuUZa2jIUSgDVpOsS4ySKDZ2gWCCAy3vESPlvJcg+IlQgKdg6nIIAJBeRruC9hP/uKMIodEutx9wT1TiFnIeoZttuTH4tdKWMwg8bbCCJxfSYrmRGkkQgT4aKTOEJKcS0cGaYElh2QNfmWCpbdCzSGCXNuS++1KXU8a/+j8e52taM9uqmOrFyJDNkOpl2wDm5Ls+MTSSO7RsQPumUTuPNMKe7YdgDcQQaqVJwqTNXBjpEgDyaN7R9HWT1PXs3tMA+OWjsQLdPS2IfzvARI5PNCUgAt/NpRDHYHS/tVuxgQRmcWFwGUQlhNzxXwh3I7vHR5fF2Kjir6PmvbIDC0p8nX+3t+7GT+aFXoMdR2BF34nzLSn2+mMZFDXZGfRGa1cw/hRHD9Vx+bqtWplrkpTdC6vpFz99OOOu1l+HvgWJnfZ0Sc3PvlkiKw2pVP/8qaj+Oh4cBgP4p+vD98lJ78kb98N4zj+EyJ4LOVWa0DeoM9eeO4tCCWFwmnH2vQojqfHLZUnz7HXKsm0V2zBpchYLlBmjGK6H0ggWqvtP1T6C/m9BJ8gd+BPXpCO0p7lulLZ/w33uYxeBngyPdlAfPsU4oVqKKO+dK0fUP0XCLd4+uF9E55S3VW1aIzCe9gB219vQJboC03t0FRND/QFJDDqqsdo3asjNUTg0C66DllZCQkU3huXjEbO87lQ8wE3ZqgNKqqgks/cMNXliBsxWhwCtSaHaWWFX10RKw3wxwE3YtDktYXPjfgNVxB1sPpWbScukGdoAwVE9pdt1zvvKNuwst8quk7xfcV/v90/W8771XynQFO6uQ7Y2rO4NKiuKAyd5OLwif9rii5ceN3FCqpiubZsbzebcYcZ0yrMH/SS1o+Hh5s5KGwdsjt1p650iTRL5ZVkUqgHl9ypAbu9zHORCi7ZHzhzwuPkoDvY5XL55EDfhD0fhS+qGbNo9NZ8HhbDqfd3bR5oYvBoS3eZX6FdiBRbEX0j1CgYj9prxtNwzbDkgsTXLv26v4kolyJF5foSOP04/syOhzFEPe1+R8qjzxcfzn+/OievpP7miA6H8TCmJaOdL7nqBdqfYnOrS3Zxtn/K623l+NeH3/ZSeXz0IyO5CJUhsLBub/0t9NSe9OfeSQSFdp5M1mvS2o2VdU3LXyu0K0huJxEsuBV8RuK+XUMmHP3PNvPrN3EffOkmSfa6EfpZQF3pUFQ3FlxW9AQRPOBqb5avJ3XU1Q/KuLH40OQ1uCY/Ww9PqnoddTtO0xSNf9F20iuz45triGDWzuVlGPHB8iV9E/AlJHAHdxC+VchBqI5hfQ2Sq3nF52TfuKXfX75rnZM=",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 from ID",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document from ID",permalink:"/docs/API-docs/deletedocument"}},j={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.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 Document from ID"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Document API allows users to modify and update the details of a specific document."}),"\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:"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)(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 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)(i.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(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)(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)(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)(a.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)(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)(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)(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)(a.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)(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)(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)(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)(a.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)(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)(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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.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