Files
OpenSign/assets/js/a88a3db3.b9986137.js
T

1 line
9.5 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),c=s(5397),o=s(4667),p=s(9472),h=s(85162);const x={id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/delete-template",title:"Delete template by ID",description:"Delete template by ID",source:"@site/docs/API-docs/delete-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/delete-template",permalink:"/docs/API-docs/delete-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"delete-template",title:"Delete template by ID",description:"Delete template by ID",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvcOTWAYsmpc9Fpg41RGBtsinUWe3AMg5ZGFhuKZEnKsWHovxdDWbISN/1YLHqyRc2Q772ZedQBPN84SBfwgJWR3KODZQTaoOVeaDXLIYUcJXrsAiACwy2v0KOlzAMoXiGksLvkRlx6/YQKIhAKUiiR52ghAoufa2Exh9TbGiNwfi8px4nKSNoSd0bqHCEtuHQUkJVYcUgP4PcmRHor1AYaCuUhKSWYyomNGu12ux00UQ/FH7GuRN5BMdyXEEGOLrPCEDdIYXbLdMF8iazLYL7kninE3DGv2RpZyz7/P0lEUGhbcT+g1Sxpf2e0cugo4ypJ6Ocl3q4GHSjm6ixD54payv1vEEGmlUflKZMbI0UWqhh/cpR+OAek158w81RSSzX3oj08Cyz6KFVX61DGXvqrJGkiqNA5vsGvETwV6TuYmyYCL3wIFUoKhatOh9VVkqzGV9A0FDRJJt8QRGnPCl2r/FeqMEkmP63CAOi3qE+Syeq6Z359znymtlyKnN18nLEHmrlfS/z6R4kPcfoWJ3HaVZLyjvMq2qDWO16oMlxv1Xgpw21oqtP4rvdsdguEzZf6ZF7BtHwJKcRdaHwYuEQDETi0287SaivJvrw3Lo1jbsyo8xrJ126U6SrmRsTbMdDgOsxqK/x+Tvq2Eg7N8KQPN+JP3EP0fcskpkIVOiQf1bg3qOZio4KW2/GZmz2UwjHhwutcZ3WFyocGYIW27FU2W3OHOdMq2B+9pPX3ozFzBjNRHHtnxB7Vo5rrClntsKglk0I9ufRRXbLFfVGITHDJ/sW1Ex6X7zrFnp+fzxS7CDkfhC/rNbNo9Cl8ExaDrMOs/uECIvBoK3dfzNFuRYbH6rxxVByC4+NE8CxMBFZcUFWPS7+/TqLGkyJD5XDQmjcfPt6x96MEokFT/ADk+G72x/Sv+ZR2pbZqSzQeJaOElox2vuJqcNBbnfyixn0nedz52EguwrwEZIdjiy/66w8iSIdX4TKCUjtPIYcD1f8fK5uGlj/XaPeQLpYRbLkVfE0NtzhALhz9z/sr7RWa3nDg3d/H2/GC/dyt+lVC3bwoGpYtlzU9QQRPuH91vTfLJuqG5j8jfgtGe9zLKe3R0PdGG3CTZWj84N2Z+ZJL9JZ0O72bPkyhab4AjT5COw==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"},next:{title:"Get template list",permalink:"/docs/API-docs/gettemplatelist"}},f={},y=[{value:"Request",id:"request",level:2}];function b(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:"Delete template by ID"})}),"\n",(0,l.jsx)(d(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"Delete 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 deleted",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)("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 deleted successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template deleted successfully!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "message": "Template deleted successfully!"\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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);