mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 09:34:54 +02:00
1 line
9.3 KiB
JavaScript
1 line
9.3 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>u,metadata:()=>x,toc:()=>v});var s=l(85893),t=l(11151),i=l(58219),n=(l(62316),l(51039)),r=l.n(n),d=(l(82723),l(9487)),m=l(41429),p=l(5397),o=l(4667),c=l(9472),h=l(85162);const u={id:"delete-template",title:"Delete template by ID",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfWoA2ZKTNMP0adlidMaCpag9DJhjBLR0sthQJEueHBuG/vtAWrIVuw02YBj2yebxjnfPc2/aAfGVg3QOM6yM5IQOFhHk6DIrDAmtIIVZiewOJRKyTovdfpwwY/Va5OjYVtfsRVDJqETGl0IK2jLSzGKl18g4cwYzUYiMUWdfWF0F9U7ihmxSMH7UEI4pzaRWK7RMIeaYQwTaoOU+rkkOKeQhqi4oiMBwyysktB7TDhSvEFLo3nwS/gnhMRlOJZwCndwxXbyKilHJKXh3HtAS2d6lf8fil1pYzCElW2MEjrbSe3OiMtIHgxsjdY6QFlw6r5CVWHFId0BbEzTJCrWCCAptK05HSdMs/PvOaOXQeYvLJPE/J4npomyDYq7OMnSuqKXcfgcRZFoRKvKW3BgpskBd/Nl58915QHr5GTPyPFpPNIm9873YM34eOm54gJvCT5vykjvzi7mCJmpTk9/S20aXyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1tm8PcJ7iJgATJ47k5UwtuXym2ksYrXyfXb9CoNLFC1yr/F7lDa7V9m4Ov+W96CISSQuFTVw9P18n1080B0PtzQBO15lLkoUln+hnVf4un75727s8TJfZK4R5ege3L9yArpFIf+z30OZWQQtz1abzr9XgDETi0624K1FZCCiWRcWkcO+IroVYDbsxQG1ROrJTkSzfMdBVzI+L1CHz7OcxqK2g79cTssW8G3IjBPrQjA9yIX3ELUYesr9VOmxJ5jjawIFShg3GL98GgmoqVCmytR2czaVYK52ehv851VleoKGSOFdqyE2u25A5zplUYYv7Sy6+Go8MEDqZD9qge1VRXyGqHRS2ZFOrZpY9qwOYPRSEywSX7A5dOEC7edcy9vLycMXYRbD4IKusls2j0UX0VhIHWvtXhcAERENrKPRRTtGuRYZulb7iKg3LcljLPQiljxYXPbiv68dTIl5YUGSqHveK7/fDxnl0NE4h6xfE3Qo7vJz+Pf5uO/au+vPYpGg2TYeJFRjuquOo5atfmYZ0st2xyd5rj3bE3/1e7tq1vwg3FRnIR+jTwtWsbcH5YrRBB2l+ziwhK7cir7Ha+Kn+3smm8+EuNdgvpfBHBmlvBl74N5jvIhfP/88O6/CZH7z61m/eC/bON/VVAXRcr38JrLmt/ggiecXvy6dAsmqhrZR/xXuM2y9BQz/Zsuvppchhhd+P78WwMTfMXjBVDFQ==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,x={id:"API-docs/delete-template",title:"Delete template by ID",description:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",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:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed",sidebar_label:"Delete template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v2zYQ/ivcfWoA2ZKTNMP0adlidMaCpag9DJhjBLR0sthQJEueHBuG/vtAWrIVuw02YBj2yebxjnfPc2/aAfGVg3QOM6yM5IQOFhHk6DIrDAmtIIVZiewOJRKyTovdfpwwY/Va5OjYVtfsRVDJqETGl0IK2jLSzGKl18g4cwYzUYiMUWdfWF0F9U7ihmxSMH7UEI4pzaRWK7RMIeaYQwTaoOU+rkkOKeQhqi4oiMBwyysktB7TDhSvEFLo3nwS/gnhMRlOJZwCndwxXbyKilHJKXh3HtAS2d6lf8fil1pYzCElW2MEjrbSe3OiMtIHgxsjdY6QFlw6r5CVWHFId0BbEzTJCrWCCAptK05HSdMs/PvOaOXQeYvLJPE/J4npomyDYq7OMnSuqKXcfgcRZFoRKvKW3BgpskBd/Nl58915QHr5GTPyPFpPNIm9873YM34eOm54gJvCT5vykjvzi7mCJmpTk9/S20aXyeXVYJQMku9no5v0+of0/c0wSZI/IYJNJb1tm8PcJ7iJgATJ47k5UwtuXym2ksYrXyfXb9CoNLFC1yr/F7lDa7V9m4Ov+W96CISSQuFTVw9P18n1080B0PtzQBO15lLkoUln+hnVf4un75727s8TJfZK4R5ege3L9yArpFIf+z30OZWQQtz1abzr9XgDETi0624K1FZCCiWRcWkcO+IroVYDbsxQG1ROrJTkSzfMdBVzI+L1CHz7OcxqK2g79cTssW8G3IjBPrQjA9yIX3ELUYesr9VOmxJ5jjawIFShg3GL98GgmoqVCmytR2czaVYK52ehv851VleoKGSOFdqyE2u25A5zplUYYv7Sy6+Go8MEDqZD9qge1VRXyGqHRS2ZFOrZpY9qwOYPRSEywSX7A5dOEC7edcy9vLycMXYRbD4IKusls2j0UX0VhIHWvtXhcAERENrKPRRTtGuRYZulb7iKg3LcljLPQiljxYXPbiv68dTIl5YUGSqHveK7/fDxnl0NE4h6xfE3Qo7vJz+Pf5uO/au+vPYpGg2TYeJFRjuquOo5atfmYZ0st2xyd5rj3bE3/1e7tq1vwg3FRnIR+jTwtWsbcH5YrRBB2l+ziwhK7cir7Ha+Kn+3smm8+EuNdgvpfBHBmlvBl74N5jvIhfP/88O6/CZH7z61m/eC/bON/VVAXRcr38JrLmt/ggiecXvy6dAsmqhrZR/xXuM2y9BQz/Zsuvppchhhd+P78WwMTfMXjBVDFQ==",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={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:l}=a;return l||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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete template by ID"})}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.jsx)(o.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(y,{...e})}):y(e)}}}]); |