WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 17:44:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
e98a4b594de09e6ea27c25f05bc3acba404dcd6c
OpenSign/assets/js/770b40a9.010e8daa.js
T

1 line
13 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:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),d=a(4667),p=a(9472),h=a(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvOZVuhKDYogjTYoAkQFwWaGAEtjS0mFMklKV9g6N+LoSRbjjdxUSz2oS+JNTyHM3M4M+QGPJ87SB5gjIWR3KODSQQZutQK44VWkMA4R3aFnrUQdiOcZxd314xLqZeOrXXJvGYWvRW4QMaZJISeMb7gQvKpRObb/ftsnAvHZqVKaX8uhV8zY/VCZOgYV0wv0C4ELgNfyh0zYqj4VAo1Z6VD68hnmmvtkM2sLhiuhPO0umWwZY6KpRZ5sGc6LQtU3vUhAm3QcorgOoME5uhbFsUOERhueYEeLcmzAcULhASkKAStChLmS4l2DRFY/FIKixkkMy4dRuD8WhJ6pm0BEeDKSJ0hJN6WtJrmWHBINlDwlSjKApKzOI7Arw2RVFlM0UJFPF4Y2mgYV9E2BPcizDeL4G2fcTWhfZ3RyqEj7CiO6d9+cbgyTdG5WSnZVlGIINXKo/KE58ZIkYaFwbMj0uYwAD19xjTIbmkbL2qXFl0pfQfHreWUsPBYuOP82kwnvEU6b4WaQxSk4b5r2eYOq+HvU1W40d2cNPHCk/Vwix3BhR/byiOW0v4IqUWzAK0oJJmh/V5p1fX0XoB1PCwAq50Q28CfmoApdHFMotx745LBoCVTD/dTXRBbL9Ve3u+JFdpZt1FF4MRchS79r0VyXIdnjWyKwRsWXMij6Cnip8bQpmhyrY64OT07Hw1Pfvo4/LrY902itBhEwOzCv7/jKB6d9IZxL/44Hp4npz8nZ+f9OI7/hghWhdwlD1lTtK3T9rs02XfwU72GdfvotQ5QddURSgqFT+2gehrF8dM5QaoITuOzw4F1rRZciizcX2P9guqHbzeu0Fp9pIy77n3t/jB9UYPCOuwl27XXSTpMSyv8OtxSqx43olevJw8TGuEF+lw3V1y41nwOCQxe3XYO7aK96korO+3Kjelrg4raTPKpo3oecCMGiyHQrbSPdp7PhZr33mVNdlHfk7K1eHux73rZiM9IzdxI00U1l2COPAyhir5nOpAbwW4NKmqbIPdiCIdPG+GYcGG5fR2Eo2czbdkrNptyhxnTivkcwyLZT/pD5gymYtZUTZ89qkd1rwukZwpdjFKoF5c8qh57uJ3NRCq4ZH/h1AmPkx9b5ZbL5YFiHwLnSvi8nDKLRu/g82AMsnZZ248PEIFHW7jb2T29p9J2BL/hahDAg6YXeBp6oRl2renTaxLVphQpKoed6r24urthC3bSjyHqlMe/CHpwc/3b5R/3l7QvlWN9SMN+3I/DCNXOF1x1XO09S5tS3jvhza61/6fv2KZPPK78wEguwsAIqm+aZn+AvWafRJBr58m+2VBJ/2llVZG5fk3SCMiEo2x378kXXHdevwsuS3IaBsAb2OaZuoNO6MMKwobZFLWNSw5rzkWaouk6OBjGexPt6nIMEfCSkuwOjJcwMJoftHu7pNadvfcnSR0A/aWcvkr4hUrlM65/3cLrlTcJTX4tmo5mUlXVP1osmVQ=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",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:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVttu4zYQ/RV2nrqAbMvOZVuhKDYogjTYoAkQFwWaGAEtjS0mFMklKV9g6N+LoSRbjjdxUSz2oS+JNTyHM3M4M+QGPJ87SB5gjIWR3KODSQQZutQK44VWkMA4R3aFnrUQdiOcZxd314xLqZeOrXXJvGYWvRW4QMaZJISeMb7gQvKpRObb/ftsnAvHZqVKaX8uhV8zY/VCZOgYV0wv0C4ELgNfyh0zYqj4VAo1Z6VD68hnmmvtkM2sLhiuhPO0umWwZY6KpRZ5sGc6LQtU3vUhAm3QcorgOoME5uhbFsUOERhueYEeLcmzAcULhASkKAStChLmS4l2DRFY/FIKixkkMy4dRuD8WhJ6pm0BEeDKSJ0hJN6WtJrmWHBINlDwlSjKApKzOI7Arw2RVFlM0UJFPF4Y2mgYV9E2BPcizDeL4G2fcTWhfZ3RyqEj7CiO6d9+cbgyTdG5WSnZVlGIINXKo/KE58ZIkYaFwbMj0uYwAD19xjTIbmkbL2qXFl0pfQfHreWUsPBYuOP82kwnvEU6b4WaQxSk4b5r2eYOq+HvU1W40d2cNPHCk/Vwix3BhR/byiOW0v4IqUWzAK0oJJmh/V5p1fX0XoB1PCwAq50Q28CfmoApdHFMotx745LBoCVTD/dTXRBbL9Ve3u+JFdpZt1FF4MRchS79r0VyXIdnjWyKwRsWXMij6Cnip8bQpmhyrY64OT07Hw1Pfvo4/LrY902itBhEwOzCv7/jKB6d9IZxL/44Hp4npz8nZ+f9OI7/hghWhdwlD1lTtK3T9rs02XfwU72GdfvotQ5QddURSgqFT+2gehrF8dM5QaoITuOzw4F1rRZciizcX2P9guqHbzeu0Fp9pIy77n3t/jB9UYPCOuwl27XXSTpMSyv8OtxSqx43olevJw8TGuEF+lw3V1y41nwOCQxe3XYO7aK96korO+3Kjelrg4raTPKpo3oecCMGiyHQrbSPdp7PhZr33mVNdlHfk7K1eHux73rZiM9IzdxI00U1l2COPAyhir5nOpAbwW4NKmqbIPdiCIdPG+GYcGG5fR2Eo2czbdkrNptyhxnTivkcwyLZT/pD5gymYtZUTZ89qkd1rwukZwpdjFKoF5c8qh57uJ3NRCq4ZH/h1AmPkx9b5ZbL5YFiHwLnSvi8nDKLRu/g82AMsnZZ248PEIFHW7jb2T29p9J2BL/hahDAg6YXeBp6oRl2renTaxLVphQpKoed6r24urthC3bSjyHqlMe/CHpwc/3b5R/3l7QvlWN9SMN+3I/DCNXOF1x1XO09S5tS3jvhza61/6fv2KZPPK78wEguwsAIqm+aZn+AvWafRJBr58m+2VBJ/2llVZG5fk3SCMiEo2x378kXXHdevwsuS3IaBsAb2OaZuoNO6MMKwobZFLWNSw5rzkWaouk6OBjGexPt6nIMEfCSkuwOjJcwMJoftHu7pNadvfcnSR0A/aWcvkr4hUrlM65/3cLrlTcJTX4tmo5mUlXVP1osmVQ=",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",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},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,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:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\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)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.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)(p.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)(d.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.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:"folder"})}),(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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.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)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(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)(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,l.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,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)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\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)(p.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)(d.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink