WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-30 05:24:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1beb63cac7a5e7a2d2d3409164b7eb2a6faade0e
OpenSign/assets/js/770b40a9.5dce35a3.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),p=a(41429),d=a(5397),c=a(4667),o=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkj5/lcqHmPG9NvbwbJp45mKuZGxMsB0NnpMCut8OsRVasuSPfq6oyNEX8gzc3JC44SFGqmA7gpwp1BRaMQSrgcwGEJxgvhmHBhOddZWaDyoZ1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaJfTZo3pUI10gKx3S2S+FenHpo+qxh7vZTGSCS/YVp054nHxoK/f6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Wn3nVBxcI4bffMs6BsLLqi7jemXQxDpTYoMlcOOIi+v77+w834CUUcc/4Jy/OXm16vb0RXtSvKqWzToJ/2ETEY7X3DVCfSWgPf6u1WRx5WPjeQijEhgtWnE/QB74p5EsNDOk32zoYb/ZWVVkbl+TpDkc+H4VHYeFC+47jx4llyWFDQ8hr7j27xTdq4T+rCCfCF9mFRRK+s3Ax5kuT2S4MOfzWPnjJEA3sq+JrA/R3uUa4fLLEPTTefosCPO2/Pi+moMVfUPQUupzA==",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/gettemplatelist",title:"Get template list",description:"Get template list",source:"@site/docs/API-docs/gettemplatelist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/gettemplatelist",permalink:"/docs/API-docs/gettemplatelist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VlFv4zYM/isan66AEzvp9Ybz04qh64od2mLJcMDaoFBsJlErSzpJThME/u8DZTtxkl4zDMM9Jab4iR/Jj5I24PncQfoAYyyM5B4dTCLQBi33QqubHFKYo/fNqhTOQwSGW16gR0vQDSheIKSw6nEjel6/oIIIhIIUFshztBCBxW+lsJhD6m2JETi/loRxojASIQJcGalzhHTGpSOHbIEFh3QDfm2Cp7dCzaEiVx5AKfFUTsxVf7VaraCKtlSkKIRvSXwr0a73OLQxGhIzbYsuhYbiIQNVFlO0ewwGSSeoexHmB8RMqgnt64xWDh35DpOEfnJ0mRWG+kZsyixD52alZNt2QgSZVh6VJ39ujBRZWIifHYE2xwT09Bmz0HNL23hRh7ToSuk7ftxaTgkLj4U7ja/NJK/DBkehNNx3LbuOrwa/T1XhhvdBCWPhyXq8xQ7gwh/WCphQt9qfALXeTOka8puWpON3QbPgw4IYCCJOUVt4b1wax2200qHtZ7og9N2rOhVvSzKzyL3eRR6JuQqj+V+bcxv0/F7sZ41sighVFYGvm7Dl89TGp8XADfNL//5+w2R43hskveTn8eBT+vFzevGpnyTJ3xDBqpCEbWYsb3rYBm2/S5P/gDjVoVtXVod1gKpbHaGkUPjUzu3TMEmeLsiliuBjcnE8vzdqyaXI2eX9DRvTmfrT/ze9aK0+oa5ueF+HP05f1E71kb+XbNdeJ7mf3TX67Uyy5lYp0C90c+GES8YvIIX44O5xaJftxVNa2Zkj5/lcqHmPG9NvbwbJp45mKuZGxMsB0NnpMCut8OsRVasuSPfq6oyNEX8gzc3JC44SFGqmA7gpwp1BRaMQSrgcwGEJxgvhmHBhOddZWaDyoZ1spi07QLMpd5gzrZhfYFgk+3l/wJzBTMwaJfTZo3pUI10gKx3S2S+FenHpo+qxh7vZTGSCS/YVp054nHxoK/f6+npUsbOAuRZ+UU6ZRaN37vNgDGXtorYfZxCBR1u4u9kI7VJk7Wn3nVBxcI4bffMs6BsLLqi7jemXQxDpTYoMlcOOIi+v77+w834CUUcc/4Jy/OXm16vb0RXtSvKqWzToJ/2ETEY7X3DVCfSWgPf6u1WRx5WPjeQijEhgtWnE/QB74p5EsNDOk32zoYb/ZWVVkbl+TpDkc+H4VHYeFC+47jx4llyWFDQ8hr7j27xTdq4T+rCCfCF9mFRRK+s3Ax5kuT2S4MOfzWPnjJEA3sq+JrA/R3uUa4fLLEPTTefosCPO2/Pi+moMVfUPQUupzA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete template by ID",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,t.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"Get template list"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{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)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,l.jsx)(p.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsxs)(a,{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)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(p.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)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.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)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{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)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"template[]"})})]})}),(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)(s.p,{children:"Array ["})})}),(0,l.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{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)(s.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.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)(s.p,{children:"Array ["})})}),(0,l.jsx)(c.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)(s.p,{children:"]"})})})]})]})}),(0,l.jsx)(c.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,l.jsx)(c.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,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "result": [\n {\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 "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.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)(a,{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)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink