WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-03 03:28:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
177ffecb2b05dac4e7bb46affc0d8fa54bb05d85
OpenSign/assets/js/377084eb.96975bf8.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:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),m=(s(82723),s(9487)),d=s(41429),c=s(5397),p=s(4667),o=s(9472),h=s(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={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:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",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 y(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:"Get template by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\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)(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,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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\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 bee"\n }\n ]\n }\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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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)(c.Z,{responseExample:'{\n "code": 404,\n "message": "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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(o.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)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink