WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 20:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
56ab0161ab152a6d14e8b1e84a54bf64e9cd761e
OpenSign/assets/js/377084eb.795bb693.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),m=(s(82723),s(9487)),o=s(41429),p=s(5397),d=s(4667),c=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0d6EhVqYDQxh7HC/bu3u44EEX+79WsXzDJHdyH6qR+Sjw7z87bMzO7AZJLD8k1zLGypST0cBtBhj51ypIyGhKYFyjOkESvIk4uz4UsS/PoxdrUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2Txo6JCWIcZ5kpjJjy5OqXaoZ9ABMaik+zteQYJLJF6GxCBlU5WSOg4zA1oWSEk0LtzpzKIQHGYVlIB27GffxAmH5wXVEgSGjHzHPUCRY6UFsh3OPxSK4cZJORqjMDTumRLXlW2ZEfwyZYmQ0hyWXpWSAusJCQboLUNmuSUXkIEuXGVpFail9A0t3y9t0Z79Aw4iGP+eemqr9MUvc/rUgz5gAhSowk1sb60tlRpOJjeewZtdr0wi3tMiRPn+BpSrclWzPl93d9Wgk8yRJ3A0+yPha78weUSmgjmili6e8UzwIc/Q8oZ9cnQG6ChQNq0kN9NmaF7HZQHHREYwRD1lmsFkfXJdNpbqz26SWoqRl886rfsDU4Gfptny1dqqQM/B7R0Tq6ZmISVf7s4nwKpX7N9bxCaJgJqC/DM/942Hwa/MDuh1+86iA8O92fxfvzzfHacHP2SvD+exHH8D0TwVJWM7Zos6+rXG+2/a5v9ADvNttqYUtt5gKZhwFF8tNtY8xG5RG5qnf303/UVOmfe4M3X7I9rqXSpNN71E+LuKD66Ox4Cer8b0LleyVJlYY7PzQPqHxvP2Dy15neLpVqlcA4vgh3L2yArpMJ0kz9MfCoggaFNp5vRtG8ggrB3un1Qu3LU2Z7kUunlvrR2Yixqr5a6lAvPXT6VVk1XM+Bp7DGtnaL1FWelDfxpX1q13/o1amSr/kTu5C6ssVa3dwqUPKo4EKVzE8BdsBcWNTdoSNVqtrOd5oXyQvlw3O/KULawRrfQYiE9ZsJoQQWGQ5YfTmbDkg7QibjRN/rKVChqj7xNSqUffHKj98X1RZ6rVMlS/I0Lrwhv3/WZe3x83MnYXsCcKSrqhXBozbP6MghDWseo4WMPIiB0lb/Ir9CtVNrP32+YmgblacdjmQYeYyUVV7cT/boNYl6VKkXtccS8k7PLj+JwEkM0Isd3uDz9eP7b6aerU76V6dWWaDaJJzGLrPFUST0y9OJNlTtTifMP2yXePPfl/+Ad1pGe8ImmtpQqdG5I4qbryuvniRtBMn6F3UZQGE+sstkwVf9yZdOw+EuNbg3J9W0EK+mUXHBvXG8gU57/Z8OL6puZe/e5e5ztie9/0H01mL6tNff0SpY1f0EED7jeelU2t03U9zZ722qcpClaGmF3Zi2Pl2GgnZ3OoWn+BS/BAOQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,f={id:"API-docs/get-template",title:"Get Template from ID",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/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 from ID",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 from ID",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1P40YQ/ivb+XRIJnGAo6o/FfUoRT0d6EhVqYDQxh7HC/bu3u44EEX+79WsXzDJHdyH6qR+Sjw7z87bMzO7AZJLD8k1zLGypST0cBtBhj51ypIyGhKYFyjOkESvIk4uz4UsS/PoxdrUgoxwSE7hCkWGJFXphVyYmoQU3mKqcpUK6sCT4RovPLoVCunFoqzROqXJi9w4kTqUpPRSZCatK2Txo6JCWIcZ5kpjJjy5OqXaoZ9ABMaik+zteQYJLJF6GxCBlU5WSOg4zA1oWSEk0LtzpzKIQHGYVlIB27GffxAmH5wXVEgSGjHzHPUCRY6UFsh3OPxSK4cZJORqjMDTumRLXlW2ZEfwyZYmQ0hyWXpWSAusJCQboLUNmuSUXkIEuXGVpFail9A0t3y9t0Z79Aw4iGP+eemqr9MUvc/rUgz5gAhSowk1sb60tlRpOJjeewZtdr0wi3tMiRPn+BpSrclWzPl93d9Wgk8yRJ3A0+yPha78weUSmgjmili6e8UzwIc/Q8oZ9cnQG6ChQNq0kN9NmaF7HZQHHREYwRD1lmsFkfXJdNpbqz26SWoqRl886rfsDU4Gfptny1dqqQM/B7R0Tq6ZmISVf7s4nwKpX7N9bxCaJgJqC/DM/942Hwa/MDuh1+86iA8O92fxfvzzfHacHP2SvD+exHH8D0TwVJWM7Zos6+rXG+2/a5v9ADvNttqYUtt5gKZhwFF8tNtY8xG5RG5qnf303/UVOmfe4M3X7I9rqXSpNN71E+LuKD66Ox4Cer8b0LleyVJlYY7PzQPqHxvP2Dy15neLpVqlcA4vgh3L2yArpMJ0kz9MfCoggaFNp5vRtG8ggrB3un1Qu3LU2Z7kUunlvrR2Yixqr5a6lAvPXT6VVk1XM+Bp7DGtnaL1FWelDfxpX1q13/o1amSr/kTu5C6ssVa3dwqUPKo4EKVzE8BdsBcWNTdoSNVqtrOd5oXyQvlw3O/KULawRrfQYiE9ZsJoQQWGQ5YfTmbDkg7QibjRN/rKVChqj7xNSqUffHKj98X1RZ6rVMlS/I0Lrwhv3/WZe3x83MnYXsCcKSrqhXBozbP6MghDWseo4WMPIiB0lb/Ir9CtVNrP32+YmgblacdjmQYeYyUVV7cT/boNYl6VKkXtccS8k7PLj+JwEkM0Isd3uDz9eP7b6aerU76V6dWWaDaJJzGLrPFUST0y9OJNlTtTifMP2yXePPfl/+Ad1pGe8ImmtpQqdG5I4qbryuvniRtBMn6F3UZQGE+sstkwVf9yZdOw+EuNbg3J9W0EK+mUXHBvXG8gU57/Z8OL6puZe/e5e5ztie9/0H01mL6tNff0SpY1f0EED7jeelU2t03U9zZ722qcpClaGmF3Zi2Pl2GgnZ3OoWn+BS/BAOQ=",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 from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template from ID",permalink:"/docs/API-docs/update-template"}},j={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Template from ID"})}),"\n",(0,t.jsx)(n(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.jsx)(a.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,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.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.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(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)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(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)(s,{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)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink