mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-21 17:17:44 +02:00
1 line
9.7 KiB
JavaScript
1 line
9.7 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4106],{51302:(e,t,p)=>{p.r(t),p.d(t,{assets:()=>f,contentTitle:()=>j,default:()=>x,frontMatter:()=>g,metadata:()=>a,toc:()=>h});const a=JSON.parse('{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","source":"@site/docs/API-docs/v1/get-template.api.mdx","sourceDirName":"API-docs/v1","slug":"/API-docs/v1/get-template","permalink":"/docs/API-docs/v1/get-template","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar_label":"Get Template","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWN1uG7cSfpUpb9oEa0l2FKdHVzVOA9docBLULgLUEQQud7TLmEuyJFc/EBY4F32DvsF5tD7JwXC1q5Wl+Ac9CHBubC05H/nNcIYzww0LPPdscstusLSKB/RsmrAMvXDSBmk0m7CbAuESA7QicPHhCrhSZulhbSoIBhwGJ3GBkGHgUnngqakCcPAWhZxLAWELHnTLePDoFgjcQ6oqtE7q4GFuHAiHPEidQ2ZEVSINL2UowDrMcC41ZuCDq0SoHPoBS5ix6DixvcrYhOUY2j1Ywix3vMSAjtTcMM1LZBPW0pnJjCVMkpqWh4Ld1/3qRzDzjjyEggfQiJknrVOEOQZRIK3h8PdKOszYJLgKE+bDWtFOXpZWERFcWWUyZJM5V54ERIElZ5MNC2sbJYOTOmcJmxtX8tCM6JzV9ZSW99Zoj54AZ6MR/dun6ish0Pt5paCzB0uYMDqgDiTPrVVSxInhZ0+gzSELk35GEchwjpYJstmyGSb7Psy3GcEVj1pP2Or0p1SX/uxDzuqEBRlo9HCJHcDHH53JCaVNeATUHVAUrYmSytB9LbUap3qIYMMHomC9M8TOD7eEibp8zERFCNZPhsMWXHl0A2FKQpul3tP7IWPFODMtq4R5mesYJx2aO8fXFCABS/+4NZ15jLpA8zSDfTYIKUZaWHKpHpVOEX/YDrS2sIXRj2wzfn1+dvrq+zenJL+UWY7hb+jfzD7PkwKuQmpWkS/P+3BdlSm6Prwb6eCndcJWz8Scjcd1wtbPRL2hrZbPBL36vk5Y8UzQ+Jz8OF5rT7D5l1zpSTavj8bidRMHs9YfHpSK4exRZ1f6vdu/c1JjFHLd35pyQ52wGHmYXYSHvfNsdPbq5HR0Mnpzc3o+Gf9j8vp8MBqNfmMJW5Vqpz3LtjdlS7L9rmz2VfZBzVOFN6Z6mvoOM+lQhFnljgb2Q2dH28XiY1aajEoLft9RjuwbUy4Bq2BmDkupHz2pFtJIz4wWOJN6hgt0R0OnA47IIfbN1k9m9/1o64TjYyn92pQYCqqElqgDLJ3ReQJWIfcIwa2B51xqoGXcN/+7XI/OmUdyyPOY9eNHaiU1ztp6ZjYejWannRHGh0a46eV2mJtKZ19X1WP7P6zQeHbeKfT6UKErveBKZrGMvjF3qL+uPv3tQ7P9ocfKRijOsz1l++ONkh5F5WRYx/p6dcKtPGnmJ7dTKl3JU8y2MI8FeSjYhHXVy3DTK8ZrRuu5RVuuxwuiK3g811lqVgNjUVOxonjqKdkPuZXDBeXw+whu7TOksTp5HsAHnkudP4ya7kx0TcfYnNSeoXYFh5U/I1Uc23PoS237lAJ5rBRr+p6bCN6eznuLmtJSPNvF6UE38xGVMCVS7xIKhFb8rz/+ExFtuxVd75tP+pN+XzmwZomOugquM5grXMlUNT0glnGu6wI98lKh92oNUgfMHUVNJnMZuAIyDd0XglueSiXJY0nMENpBz+n9AD4WGAp0NPWtQ+CQ4QIVOTrQFV7ut4ewNO5uTv1oAhzSykuN3gPqgmtBgq35EzAOuAbUAZ110iM1ksRaNtyMDo6LACXXPEdaO9mzUoZKkm+CM2nlA3ijqkgZqO01DjNoFYpd4oCM+JYaP4dAo8KU1mFBnrJAyCuZoU9AmAyhaXxIBZ1Bij6AJS5SYGw2K62MuIvnNq+UAmvovpBcUYPa50jw4Lj2lEUbLu0ZdAazzlCviA3Bly9/9Ugn/E7qOz95+fKTPoHbzpk+YuplwOl3rdcvl8sDb3+xj7mU4acqhV/QGi+DcesdOpehqNIYIf1Fuo9mpUvUGP2nFwG7NTIj/GHA0eiwQGWH1xjIQ/zw4sNVvGJfwF///hPeIXcaCrNsvFVUDtUa8nYrslxz8o3ZuhsyvkrwKhRkcdE4H/X76ANZkMqk/WjeDzuHc3Rk/HiQu+2s3C5/29IEYv931KS7mryYi5hKtq0TXSs/3F8nXuvoSv9+fo1uIUXbWn7hhIdReMgSpqRA7bGXLi4uP7yDBbwajFjSuyKfcNrDd1f/fPuv67fEhiKrsdjpYDQYxZbI+FBy3duq/xJ1/4Lb7NLo/8Gr1fbKp2ZkaBWXMdFuK+ImSd7uqsSETfpvVtOEFcYHEtlsUu7xV6fqmoZ/r2KBejtN2II7SXV5zKSZ9PQ7696fvmi5737ZPmW9gKc/fx1Vpk1qmjLagqsqFvAJu8P1vTe4ekqNYpPZiG0jcSEE2tDDHpRGe/XF5dsbFmv8Yj+j3sWMuv1Bqx/ltZ9qGwL0l7L+UcBm02Truu7km6kvIrYKttJkpGld1/8F4r980w==","sidebar_class_name":"get api-method","info_path":"docs/API-docs/v1/opensign-api-v-1","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Create Template","permalink":"/docs/API-docs/v1/createtemplate"},"next":{"title":"Update Template","permalink":"/docs/API-docs/v1/update-template"}}');var n=p(74848),r=p(28453),s=p(33617),o=p.n(s),i=p(17543),l=p.n(i),m=p(86013),d=p.n(m),u=p(63723),c=p.n(u),b=(p(18766),p(79329),p(9303));const g={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWN1uG7cSfpUpb9oEa0l2FKdHVzVOA9docBLULgLUEQQud7TLmEuyJFc/EBY4F32DvsF5tD7JwXC1q5Wl+Ac9CHBubC05H/nNcIYzww0LPPdscstusLSKB/RsmrAMvXDSBmk0m7CbAuESA7QicPHhCrhSZulhbSoIBhwGJ3GBkGHgUnngqakCcPAWhZxLAWELHnTLePDoFgjcQ6oqtE7q4GFuHAiHPEidQ2ZEVSINL2UowDrMcC41ZuCDq0SoHPoBS5ix6DixvcrYhOUY2j1Ywix3vMSAjtTcMM1LZBPW0pnJjCVMkpqWh4Ld1/3qRzDzjjyEggfQiJknrVOEOQZRIK3h8PdKOszYJLgKE+bDWtFOXpZWERFcWWUyZJM5V54ERIElZ5MNC2sbJYOTOmcJmxtX8tCM6JzV9ZSW99Zoj54AZ6MR/dun6ish0Pt5paCzB0uYMDqgDiTPrVVSxInhZ0+gzSELk35GEchwjpYJstmyGSb7Psy3GcEVj1pP2Or0p1SX/uxDzuqEBRlo9HCJHcDHH53JCaVNeATUHVAUrYmSytB9LbUap3qIYMMHomC9M8TOD7eEibp8zERFCNZPhsMWXHl0A2FKQpul3tP7IWPFODMtq4R5mesYJx2aO8fXFCABS/+4NZ15jLpA8zSDfTYIKUZaWHKpHpVOEX/YDrS2sIXRj2wzfn1+dvrq+zenJL+UWY7hb+jfzD7PkwKuQmpWkS/P+3BdlSm6Prwb6eCndcJWz8Scjcd1wtbPRL2hrZbPBL36vk5Y8UzQ+Jz8OF5rT7D5l1zpSTavj8bidRMHs9YfHpSK4exRZ1f6vdu/c1JjFHLd35pyQ52wGHmYXYSHvfNsdPbq5HR0Mnpzc3o+Gf9j8vp8MBqNfmMJW5Vqpz3LtjdlS7L9rmz2VfZBzVOFN6Z6mvoOM+lQhFnljgb2Q2dH28XiY1aajEoLft9RjuwbUy4Bq2BmDkupHz2pFtJIz4wWOJN6hgt0R0OnA47IIfbN1k9m9/1o64TjYyn92pQYCqqElqgDLJ3ReQJWIfcIwa2B51xqoGXcN/+7XI/OmUdyyPOY9eNHaiU1ztp6ZjYejWannRHGh0a46eV2mJtKZ19X1WP7P6zQeHbeKfT6UKErveBKZrGMvjF3qL+uPv3tQ7P9ocfKRijOsz1l++ONkh5F5WRYx/p6dcKtPGnmJ7dTKl3JU8y2MI8FeSjYhHXVy3DTK8ZrRuu5RVuuxwuiK3g811lqVgNjUVOxonjqKdkPuZXDBeXw+whu7TOksTp5HsAHnkudP4ya7kx0TcfYnNSeoXYFh5U/I1Uc23PoS237lAJ5rBRr+p6bCN6eznuLmtJSPNvF6UE38xGVMCVS7xIKhFb8rz/+ExFtuxVd75tP+pN+XzmwZomOugquM5grXMlUNT0glnGu6wI98lKh92oNUgfMHUVNJnMZuAIyDd0XglueSiXJY0nMENpBz+n9AD4WGAp0NPWtQ+CQ4QIVOTrQFV7ut4ewNO5uTv1oAhzSykuN3gPqgmtBgq35EzAOuAbUAZ110iM1ksRaNtyMDo6LACXXPEdaO9mzUoZKkm+CM2nlA3ijqkgZqO01DjNoFYpd4oCM+JYaP4dAo8KU1mFBnrJAyCuZoU9AmAyhaXxIBZ1Bij6AJS5SYGw2K62MuIvnNq+UAmvovpBcUYPa50jw4Lj2lEUbLu0ZdAazzlCviA3Bly9/9Ugn/E7qOz95+fKTPoHbzpk+YuplwOl3rdcvl8sDb3+xj7mU4acqhV/QGi+DcesdOpehqNIYIf1Fuo9mpUvUGP2nFwG7NTIj/GHA0eiwQGWH1xjIQ/zw4sNVvGJfwF///hPeIXcaCrNsvFVUDtUa8nYrslxz8o3ZuhsyvkrwKhRkcdE4H/X76ANZkMqk/WjeDzuHc3Rk/HiQu+2s3C5/29IEYv931KS7mryYi5hKtq0TXSs/3F8nXuvoSv9+fo1uIUXbWn7hhIdReMgSpqRA7bGXLi4uP7yDBbwajFjSuyKfcNrDd1f/fPuv67fEhiKrsdjpYDQYxZbI+FBy3duq/xJ1/4Lb7NLo/8Gr1fbKp2ZkaBWXMdFuK+ImSd7uqsSETfpvVtOEFcYHEtlsUu7xV6fqmoZ/r2KBejtN2II7SXV5zKSZ9PQ7696fvmi5737ZPmW9gKc/fx1Vpk1qmjLagqsqFvAJu8P1vTe4ekqNYpPZiG0jcSEE2tDDHpRGe/XF5dsbFmv8Yj+j3sWMuv1Bqx/ltZ9qGwL0l7L+UcBm02Truu7km6kvIrYKttJkpGld1/8F4r980w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/v1/opensign-api-v-1",custom_edit_url:null},j=void 0,f={},h=[];function P(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Get Template"}),"\n",(0,n.jsx)(o(),{method:"get",path:"/template/{template_id}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(l(),{parameters:[{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}]}),"\n",(0,n.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(c(),{id:void 0,label:void 0,responses:{200:{description:"successful operation",content:{"application/json":{schema:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},title:{type:"string",example:"sample template"},note:{type:"string",example:"template note"},folder:{type:"object",properties:{objectId:{type:"string",format:"string",example:"x1Hbnms2Pg"},name:{type:"string",example:"folder name"}},title:"template_folder"},file:{type:"string",example:"https://templateuser.com"},owner:{type:"string",example:"template creator name"},signers:{type:"array",items:{type:"object",properties:{role:{type:"string",example:"ceo"},name:{type:"string",example:"joe bee"},email:{type:"string",example:"joebee@example.com"},phone:{type:"string",example:"456213871"},widgets:{type:"array",items:{type:"object",properties:{type:{type:"string",format:"string",example:"textbox"},page:{type:"number",format:"number",example:1},x:{type:"number",format:"number",example:244},y:{type:"number",format:"number",example:71},w:{type:"number",format:"number",example:38},h:{type:"number",format:"number",example:46},options:{type:"object",properties:{name:{type:"string",format:"string",example:"textbox"}}}},title:"template_Signers_widgets"}}},title:"template_Signers"}},sendInOrder:{type:"boolean",example:!0},createdAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},updatedAt:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"},enableTour:{type:"boolean",example:!0},redirect_url:{type:"string",format:"string",example:""},allow_modifications:{type:"boolean",example:!1},auto_reminder:{type:"boolean",example:!1},remind_once_in_every:{type:"number",example:0}},xml:{name:"template"},title:"template"}}}},400:{description:"Something went wrong, please try again later!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Something went wrong, please try again later!"}},title:"inline_response_400_1"}}}},404:{description:"Template not found!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Template not found!"}},title:"inline_response_404_6"}}}},405:{description:"Invalid API Token!",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string",example:"Invalid API token!"}},xml:{name:"invalidtoken"},title:"invalidtoken"}}}}}})]})}function x(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(P,{...e})}):P(e)}}}]); |