WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-26 19:44:53 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1beb63cac7a5e7a2d2d3409164b7eb2a6faade0e
OpenSign/assets/js/5a2de241.652d37f8.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),m=s(41429),p=s(5397),c=s(4667),o=s(9472),h=s(85162);const u={id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21P20gQ/it784lKTuIE2ur86bjC0egqQAV00kEUbexxsrDe3e6u86LI/70avyQOAVoqdJdP8Xpm53nm3WvwfOoguoVrzIzkHh2MAtAGLfdCq2ECEeQm4R4bAQjAcMsz9GhJcw2KZwgRLDvciI7XD6ggAKEgghnyBC0EYPFbLiwmEHmbYwDOryTpOJEZSVfi0kidIEQpl44E4hlmHKI1+JUpJb0VagoFifJSKSKYyomp6i6XyyUUwQaKr7GORdJAMdzPIIAEXWyFIW4QwfCE6ZT5GbJGg/kZ90whJo55zSbIKvbJW5IIINU2475FqxhV96Pzf+pkRTq7UI3Vc5Egm6DUC7aJAIGsEG4oOHbAPZPInWdaYUu2IfAOAoi18qg8GeLGSBGX8e7dO7K23oeuJ/cYewq+pezwAh29PS8d/mOC7bC58s8GL8X0XPtXX3NJFJFZnAtcMK4SRrnA/Ew4lug4z4heEcBJ24+vM7HJinYsigD+0jJBS8XxuvuW927C+2d8eQlFEYAXfsfMuJW34wmlQVGQnEVntHKVxwdhuJ8dTXE22cpcHsfoXJpLufrt7cJdHT9NfEuTu2Tw2V0efTbkrBrSsX9ZaRAODjv9sBN+vO5/iI5+j95/6IZh+C8EsMwk6dbFndQ503ivem4dCCWFwnHjtfEgDMeD2pVHT3mvzqSmxOZcioSlAmXCyKZ7Qweitdr+Yqa/gO8l+kS5IX/0Quoo7Vmqc5X833SfQvQywaPxxw3F9/sUh6py2fHlkF3TfPovGG75tM37yjxB3c1qUQlV43OHbPu8IrnL7ma3/bPJig1PIIAM/UzT/DZ5CZsGYAS9Rq63bnWbAgJwaOfNSM+tpPHtvXFRr+c8nwo17XBjus3MlXziurHOetyI3rwPNMAcxrkVfnVFvqvc014Ktk7iRvyNKwh+vDoQXQrJ1+1sPG0c20yfvYHSzJOfGxGPJsTTTb/d83faOMFNdcmtjtiFQXVFZije8/7e0nFN1oUrXzcgytxjqbbskTabcIcJ06rcUuglnR92+8wZjEVap22X3ak7daUzZLnDNJdMCvXgojvVYbcXaSpiwSX7BydOeBwdNIFdLBZ7AX1X6pwJP8snzKLRW/FpeVhGva21eaC9wqPN3EV6hXYuYqyT6BlTvVK4Vxcjj8tixIwLSr766I/HSuRyKWJUDlvlc3x2+YUddkMIWrn7E5B7X4afTs+vTulWyv4qRP1u2A3pyGjnM65ahp6rtuTJLcPj0veM5KKs6RLZuq7EW2jla9TeWEcBzLTzJLJeU/xvrCwKOv6Wo11BdDsKYM6t4BNKuNs1JMLR/2SzeT5Cs+l1cPC12QHZ65bfJwk15ayoludc5vQEATzg6tEWXoyKoKnpX0b8HIzK3G4T2aChz4JK4FN1Z+ea7thK7HX/rcZxHKPxL8qOWo328uYaApjU+3tWfgqA5Qv6duALiOAO7sg9uqRZ9sfyfA2Sq2nOpyRfXUu/72e5sKg=",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-template",title:"Update template by ID",description:"Update template by ID",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update template by ID",description:"Update template by ID",sidebar_label:"Update template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzFV21P20gQ/it784lKTuIE2ur86bjC0egqQAV00kEUbexxsrDe3e6u86LI/70avyQOAVoqdJdP8Xpm53nm3WvwfOoguoVrzIzkHh2MAtAGLfdCq2ECEeQm4R4bAQjAcMsz9GhJcw2KZwgRLDvciI7XD6ggAKEgghnyBC0EYPFbLiwmEHmbYwDOryTpOJEZSVfi0kidIEQpl44E4hlmHKI1+JUpJb0VagoFifJSKSKYyomp6i6XyyUUwQaKr7GORdJAMdzPIIAEXWyFIW4QwfCE6ZT5GbJGg/kZ90whJo55zSbIKvbJW5IIINU2475FqxhV96Pzf+pkRTq7UI3Vc5Egm6DUC7aJAIGsEG4oOHbAPZPInWdaYUu2IfAOAoi18qg8GeLGSBGX8e7dO7K23oeuJ/cYewq+pezwAh29PS8d/mOC7bC58s8GL8X0XPtXX3NJFJFZnAtcMK4SRrnA/Ew4lug4z4heEcBJ24+vM7HJinYsigD+0jJBS8XxuvuW927C+2d8eQlFEYAXfsfMuJW34wmlQVGQnEVntHKVxwdhuJ8dTXE22cpcHsfoXJpLufrt7cJdHT9NfEuTu2Tw2V0efTbkrBrSsX9ZaRAODjv9sBN+vO5/iI5+j95/6IZh+C8EsMwk6dbFndQ503ivem4dCCWFwnHjtfEgDMeD2pVHT3mvzqSmxOZcioSlAmXCyKZ7Qweitdr+Yqa/gO8l+kS5IX/0Quoo7Vmqc5X833SfQvQywaPxxw3F9/sUh6py2fHlkF3TfPovGG75tM37yjxB3c1qUQlV43OHbPu8IrnL7ma3/bPJig1PIIAM/UzT/DZ5CZsGYAS9Rq63bnWbAgJwaOfNSM+tpPHtvXFRr+c8nwo17XBjus3MlXziurHOetyI3rwPNMAcxrkVfnVFvqvc014Ktk7iRvyNKwh+vDoQXQrJ1+1sPG0c20yfvYHSzJOfGxGPJsTTTb/d83faOMFNdcmtjtiFQXVFZije8/7e0nFN1oUrXzcgytxjqbbskTabcIcJ06rcUuglnR92+8wZjEVap22X3ak7daUzZLnDNJdMCvXgojvVYbcXaSpiwSX7BydOeBwdNIFdLBZ7AX1X6pwJP8snzKLRW/FpeVhGva21eaC9wqPN3EV6hXYuYqyT6BlTvVK4Vxcjj8tixIwLSr766I/HSuRyKWJUDlvlc3x2+YUddkMIWrn7E5B7X4afTs+vTulWyv4qRP1u2A3pyGjnM65ahp6rtuTJLcPj0veM5KKs6RLZuq7EW2jla9TeWEcBzLTzJLJeU/xvrCwKOv6Wo11BdDsKYM6t4BNKuNs1JMLR/2SzeT5Cs+l1cPC12QHZ65bfJwk15ayoludc5vQEATzg6tEWXoyKoKnpX0b8HIzK3G4T2aChz4JK4FN1Z+ea7thK7HX/rcZxHKPxL8qOWo328uYaApjU+3tWfgqA5Qv6duALiOAO7sg9uqRZ9sfyfA2Sq2nOpyRfXUu/72e5sKg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"},next:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},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 template by ID"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Update template by ID"}),"\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)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.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 template"}}),(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:"template description"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"FolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(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