mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-22 01:24:54 +02:00
1 line
11 KiB
JavaScript
1 line
11 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),p=s(41429),m=s(5397),o=s(4667),c=s(9472),h=s(85162);const u={id:"delete-template",title:"Delete Template",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",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3HaXocZw7BuLW7FFethzTBgbVAoNh3rKks6Sc4LAv/3gbKdOElb7IDhsC+JTZEin0fkY23A87mD5AEmWBrJPTqYRpChS60wXmgFCUwKZFco0SPrvNjlpxtmrF6IDB1b64othS+YL5DxmZDCr5nXzGKpF8g4cwZTkYuU+S4+t7oM7p3FDdlNzvjOQzimNJNazdEyhZhhBhFog5ZTXTcZJJCFqrqiIALDLS/RoyVMG1C8REig2/NJ0BaCMBnuCzgEenPFdL5XFfMF9yG7I0AzZE1K2sfil0pYzCDxtsIInF9LyuZEaSQVgysjdYaQ5Fw6ckgLLDkkG/BrEzy9FWoOEeTaltzvLHU9pf2d0cqho4jTOKa/g4PpqmyLYq5KU3Qur6RcfwcRpFp5VJ4iuTFSpIG60WdH4ZvjgvTsM6aeeLREtBdN8sZMjB+Xjise4Cbwy6o45c78Zs6gjtqjyS7920Gn8enZYBwP4u8n44vk/Ifk/cUwjuO/IYJVKSm2PcOMDriOwAsvd+/1kVtIu+fYWmpyPn+Jxntdoi+EmrMlKs+WVqt5xIxE7pB5u2Z8zoVixLT9D1lFa7V9m52vq6zuoRZKCoVPXQ89ncfx03hLwvkbvaS0Z7muVPZtob6U/21A508XW0DvjwHdqAWXIgtKNdHPqL4tnn5636Q/7lbROIV12APbtzcgHaaVFX4dhG014EYMmvXkYUpyQZ2id6IYxNAXkMCoE7PRpieENdCWdtFJZWUlJFB4b1wyGnFjhtqgcmKuJJ+5YarLETditBhDHR16O8/nQs0Hb0ZNdxDuieaGyT0gWz65ER9xDVHHU9+rFfACeYY2cCpUrkNwy96dQXUv5ipwvxgfyfykEI4+L7Sc6bQqUfnQByzXlh1Esxl3mDGtwneBFsl+NhxvP2ohdMge1aOieWWVw7ySTAr17JJHNWAPd3kuUsEl+wtnTnicvuuYWy6XR4ydhJgPwhfVjFk0euc+D8ZAaz9q+3ICEXi0pbvL79EuRIrtKb2SahScR+1g8DQMBpZc0Om2pp8Pg6hRpUhROey18uWHT7dswc6GMUS99vgXRY9ub369/v3+mvaldmwOaTyMhzGZjHa+5KqX6uAucni+m92U/6+uLm1ve1z5kZFchIkPTG3aUX3Y3lQggqR/a5lGUGjnyWWzoY7808q6JvOXCi1pwjSCBbeCz2gEHjaQCUfP2fb28SpH7/5oLzIn7OsuQC8C6iZY0fguuKzoDSJ4xvXBTaye1lE3xlRx43GZpmh8L/ZIp/fE7ur69npyDRHwihjsK8hzUJD2gRK8WNq+tDQ10C+p3IsBP1L/fMT1T1v3ZuXVgBZi5000Teu6/gf6A/D2",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/delete-template",title:"Delete Template",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",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",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1v4zYM/isaP10BJ3HaXocZw7BuLW7FFethzTBgbVAoNh3rKks6Sc4LAv/3gbKdOElb7IDhsC+JTZEin0fkY23A87mD5AEmWBrJPTqYRpChS60wXmgFCUwKZFco0SPrvNjlpxtmrF6IDB1b64othS+YL5DxmZDCr5nXzGKpF8g4cwZTkYuU+S4+t7oM7p3FDdlNzvjOQzimNJNazdEyhZhhBhFog5ZTXTcZJJCFqrqiIALDLS/RoyVMG1C8REig2/NJ0BaCMBnuCzgEenPFdL5XFfMF9yG7I0AzZE1K2sfil0pYzCDxtsIInF9LyuZEaSQVgysjdYaQ5Fw6ckgLLDkkG/BrEzy9FWoOEeTaltzvLHU9pf2d0cqho4jTOKa/g4PpqmyLYq5KU3Qur6RcfwcRpFp5VJ4iuTFSpIG60WdH4ZvjgvTsM6aeeLREtBdN8sZMjB+Xjise4Cbwy6o45c78Zs6gjtqjyS7920Gn8enZYBwP4u8n44vk/Ifk/cUwjuO/IYJVKSm2PcOMDriOwAsvd+/1kVtIu+fYWmpyPn+Jxntdoi+EmrMlKs+WVqt5xIxE7pB5u2Z8zoVixLT9D1lFa7V9m52vq6zuoRZKCoVPXQ89ncfx03hLwvkbvaS0Z7muVPZtob6U/21A508XW0DvjwHdqAWXIgtKNdHPqL4tnn5636Q/7lbROIV12APbtzcgHaaVFX4dhG014EYMmvXkYUpyQZ2id6IYxNAXkMCoE7PRpieENdCWdtFJZWUlJFB4b1wyGnFjhtqgcmKuJJ+5YarLETditBhDHR16O8/nQs0Hb0ZNdxDuieaGyT0gWz65ER9xDVHHU9+rFfACeYY2cCpUrkNwy96dQXUv5ipwvxgfyfykEI4+L7Sc6bQqUfnQByzXlh1Esxl3mDGtwneBFsl+NhxvP2ohdMge1aOieWWVw7ySTAr17JJHNWAPd3kuUsEl+wtnTnicvuuYWy6XR4ydhJgPwhfVjFk0euc+D8ZAaz9q+3ICEXi0pbvL79EuRIrtKb2SahScR+1g8DQMBpZc0Om2pp8Pg6hRpUhROey18uWHT7dswc6GMUS99vgXRY9ub369/v3+mvaldmwOaTyMhzGZjHa+5KqX6uAucni+m92U/6+uLm1ve1z5kZFchIkPTG3aUX3Y3lQggqR/a5lGUGjnyWWzoY7808q6JvOXCi1pwjSCBbeCz2gEHjaQCUfP2fb28SpH7/5oLzIn7OsuQC8C6iZY0fguuKzoDSJ4xvXBTaye1lE3xlRx43GZpmh8L/ZIp/fE7ur69npyDRHwihjsK8hzUJD2gRK8WNq+tDQ10C+p3IsBP1L/fMT1T1v3ZuXVgBZi5000Teu6/gf6A/D2",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",permalink:"/docs/API-docs/update-template"},next:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"}},g={},f=[{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:"Delete Template"})}),"\n",(0,l.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,l.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,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)(p.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.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "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:"Something went wrong, please try again later!"})}),(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)(c.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\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)(c.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)(o.Z,{collapsible:!1,name:"error",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)(m.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)(c.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)(o.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)(m.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)}}}]); |