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

1 line
12 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:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});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",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:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",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:"eJzNVttu3DYQ/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",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"}},f={},g=[{value:"Request",id:"request",level:2}];function v(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"})}),"\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:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(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:"Something went wrong, please try again later!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\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 b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]);