mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-23 01:54:55 +02:00
1 line
8.2 KiB
JavaScript
1 line
8.2 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=a(85893),i=a(11151),l=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),o=a(5397),p=a(4667),c=a(9472),h=a(85162);const u={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVt9v2zgM/lc0vmwF1Di97V78tOJaFMEVbbF2uIc0OCg2Hau1JU2i0wSB//cDFTt1k3a3Hu7JNsUfHynyozdAahEgncId1q5ShAFmEnIMmdeOtDWQAkiwDr3iz0kOKSyQenWQ4JRXNRJ69rMBo2qEFFbHyuljso9oQIJmPyWqHD1I8Pij0R5zSMk3KCHQumKboGtXsUtcucrmCGmhqsAKWYm1gnQDtHZRk7w2C2hZVUWjlDGaoBdmtFqtVtDKHRTqsP6t8x6KU1TCfp6TM2EL0WsLKhUJg5gHQVbMURRIWYn5/5mAhML6WtFWwhm1M3YfnDUBAxv8Nh7z4yXU0GQZhlA0ldhdDUjIrCE0xPrKuUpn8SB5CGy0OURh5w+YEd+hZzektyGvYt1+jnUrea5+iC+76vHVXFl6t5ubClVA4XGp8Ukokwu+UkGlDiK3WVNzeq2Es2E53hdid8HDkrYSvn+7fK+rksiFNEnWtvG6VgscZbZmXww6DsTOn/JerYfGU3iw+HVRK11FKwkPtjQDwUzCqq7YRdfHvVMJT14517dfK0ET1uE18M9QOVj31YV73XkrgTRVL0QtV6HK0fP0v69Cq4cwVycXanUT3byMmXlUhMOW6UPvn7Rs/GX85XASeiISxpIobGPyDxB1fz/UnZilqnQuTm8m4o6Z6cPHiKpGKm1HbJHQqIQUkj58shkwSAsSAvplT3eNrwaNoJwb9TxUqXngUifK6WR5AjzZAbPGa1rf8iRuh21IlIN2cfpP5H75VzrlBLQpbDTuynft0Nzy3HCmy5MDprvjcdIhHvdTFalCFNaLPWsxVwFzYXkKMR6y/PPoRASHmS46lhmJe3Nvbm2NognIzFRp8xjSe3MsptdFoTOtKvEXzoMmnH3qK/b09HRQsaNoc6GpbObCo7PP6osojGUdWu0+jkACoa/DdXGLfqmzfkzfCJVE5aTjTpVF7kSeQe7CrejrvhE3WKUzNAEH3Xx6cXMpPo/GIAdN8QuQk8vJH+dXt+fsldtqe0Uno/FozCJnA9XKDAJdID1vqflaTM72L3jzvAl4e3c9RbiixFVKR7qLGDdds093rAgS0uHCnEkobSBW2Wy4E777qm1Z/KNBv4Z0OpOwVF6reWS1DeQ68Hu+W35vQvv0rdujR+LXd++ryfRTY3hklqpqcJv5I673fgDaWSv70fnPaN+CsQ33clZ3aPiPZKtwmmXoaHB2sKyZK3asdHF+B237D1VpT+0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get template by ID",description:"",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJytVt9v2zgM/lc0vmwF1Di97V78tOJaFMEVbbF2uIc0OCg2Hau1JU2i0wSB//cDFTt1k3a3Hu7JNsUfHynyozdAahEgncId1q5ShAFmEnIMmdeOtDWQAkiwDr3iz0kOKSyQenWQ4JRXNRJ69rMBo2qEFFbHyuljso9oQIJmPyWqHD1I8Pij0R5zSMk3KCHQumKboGtXsUtcucrmCGmhqsAKWYm1gnQDtHZRk7w2C2hZVUWjlDGaoBdmtFqtVtDKHRTqsP6t8x6KU1TCfp6TM2EL0WsLKhUJg5gHQVbMURRIWYn5/5mAhML6WtFWwhm1M3YfnDUBAxv8Nh7z4yXU0GQZhlA0ldhdDUjIrCE0xPrKuUpn8SB5CGy0OURh5w+YEd+hZzektyGvYt1+jnUrea5+iC+76vHVXFl6t5ubClVA4XGp8Ukokwu+UkGlDiK3WVNzeq2Es2E53hdid8HDkrYSvn+7fK+rksiFNEnWtvG6VgscZbZmXww6DsTOn/JerYfGU3iw+HVRK11FKwkPtjQDwUzCqq7YRdfHvVMJT14517dfK0ET1uE18M9QOVj31YV73XkrgTRVL0QtV6HK0fP0v69Cq4cwVycXanUT3byMmXlUhMOW6UPvn7Rs/GX85XASeiISxpIobGPyDxB1fz/UnZilqnQuTm8m4o6Z6cPHiKpGKm1HbJHQqIQUkj58shkwSAsSAvplT3eNrwaNoJwb9TxUqXngUifK6WR5AjzZAbPGa1rf8iRuh21IlIN2cfpP5H75VzrlBLQpbDTuynft0Nzy3HCmy5MDprvjcdIhHvdTFalCFNaLPWsxVwFzYXkKMR6y/PPoRASHmS46lhmJe3Nvbm2NognIzFRp8xjSe3MsptdFoTOtKvEXzoMmnH3qK/b09HRQsaNoc6GpbObCo7PP6osojGUdWu0+jkACoa/DdXGLfqmzfkzfCJVE5aTjTpVF7kSeQe7CrejrvhE3WKUzNAEH3Xx6cXMpPo/GIAdN8QuQk8vJH+dXt+fsldtqe0Uno/FozCJnA9XKDAJdID1vqflaTM72L3jzvAl4e3c9RbiixFVKR7qLGDdds093rAgS0uHCnEkobSBW2Wy4E777qm1Z/KNBv4Z0OpOwVF6reWS1DeQ68Hu+W35vQvv0rdujR+LXd++ryfRTY3hklqpqcJv5I673fgDaWSv70fnPaN+CsQ33clZ3aPiPZKtwmmXoaHB2sKyZK3asdHF+B237D1VpT+0=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get template by ID"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{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,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(l.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template not found!"})}),(0,t.jsx)("div",{})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!'"})}),(0,t.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); |