Files
OpenSign/assets/js/770b40a9.cf3449cd.js
T

1 line
9.5 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>j,metadata:()=>u,toc:()=>f});var l=a(85893),t=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),p=a(5397),d=a(4667),o=a(9472),h=a(85162);const j={id:"gettemplatelist",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1v4zYQ/SvsnDaA4o9se9Gp2TTNGg02QexFD7ZRUNLIZkKRXJJy5Br678XQkqzYaZICzSX2cN5wPt48cweerxzEc5hhYST36GAZgTZouRdaTTKIYYXeN6dSOA8RGG55gR4tQXegeIEQQ3XOjTj3+gkVRCAUxLBGnqGFCCz+KIXFDGJvS4zA+a0kjBOFkQgRYGWkzhDinEtHDukaCw7xDvzWBE9vhVpBTa48gGLKUzmxUoOqqiqol/t70PkvOtsSNtXKo/L0kRsjRRqqGj46rch2colOHjENFVrqgRfo6FSKQviemyqLJJSVa1tw37d0yY1HdQTuSZj/iBvVdQRVIQnWNJa6nlBFdQReePnSVhPAojNauX26F6MR/cvQpVYYqpj6V6YpOpeXknXjhej/6pDITkfVK7OzHGZXjb8mqnAX92Gm3x9uXwtwcF97b1w8HLZMLB3aQaoLAn8LbXoL7cIH1oIDSPt3QK03U3oP+a3f0I8hKbM6gt+1pD14E5QHnw4yFSsVFqzDcGv5ljbLY+HeH8nePHlvMMdp/F2lRpcXXxP3sdY+aoS6R8y29r/aAujwyiL3+GX7wbal5K7bXpzsQ3+Mx9c2+/Dz6JfTFZioDZciY5f3EzYjmfopBH/pdIO+4wlr9K5Av9YkhUY3+ufXEMPwSBYd2k2riaWVPdZyYwatWEmeOGLukBsx3IyDbDlMSyv8dkrrth9fX017HDDiDyQSvKu5VBlt8cNBEa/bTneKNh61GkVqJVSuw11NT+8MKppiaNhmDMetmq2FY8KF40ynZYHKB/lgubbsCM0S7jBjWjG/xnBI9s+DMXMGU5E3yjNgC7VQU10gKx2SWkmhnly8UOdsfpfnIhVcsj8xccLj8lPb4Ofn55MGnwXMjfDrMmEWjT64r4IxTKGP6r6cQQQebeHu8inajUhbCfqXq4bBedjoKU+DnmLBBZGgMf16DCL6SpGictgj9+XN/S37PBhB1OPQB1Ie3k6urr9NrykqsXA/ovFgNBiRiZhbcNW76DWiZ68qnMfKD43kQlGkkNWu2YE5vNiBZQRrWpF4DrsdDfy7lXVN5h8l2i3E82UEG24FT4hh82UdtXylpcmEo4OsewUc5dP9WMGnh+ZBccZoVK/l+YTbkwXZcFmSJ9TRrnG42sc8n1GMg8fJj+EBcZmmaPybvsueZtzfTWcQQdI8SYrwygHLn+lZxJ8hhgUsAOjVRRHC8gf7DiRXq5KvgsyGuPT3D3l1U/4=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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:"eJytVk1v4zYQ/SvsnDaA4o9se9Gp2TTNGg02QexFD7ZRUNLIZkKRXJJy5Br678XQkqzYaZICzSX2cN5wPt48cweerxzEc5hhYST36GAZgTZouRdaTTKIYYXeN6dSOA8RGG55gR4tQXegeIEQQ3XOjTj3+gkVRCAUxLBGnqGFCCz+KIXFDGJvS4zA+a0kjBOFkQgRYGWkzhDinEtHDukaCw7xDvzWBE9vhVpBTa48gGLKUzmxUoOqqiqol/t70PkvOtsSNtXKo/L0kRsjRRqqGj46rch2colOHjENFVrqgRfo6FSKQviemyqLJJSVa1tw37d0yY1HdQTuSZj/iBvVdQRVIQnWNJa6nlBFdQReePnSVhPAojNauX26F6MR/cvQpVYYqpj6V6YpOpeXknXjhej/6pDITkfVK7OzHGZXjb8mqnAX92Gm3x9uXwtwcF97b1w8HLZMLB3aQaoLAn8LbXoL7cIH1oIDSPt3QK03U3oP+a3f0I8hKbM6gt+1pD14E5QHnw4yFSsVFqzDcGv5ljbLY+HeH8nePHlvMMdp/F2lRpcXXxP3sdY+aoS6R8y29r/aAujwyiL3+GX7wbal5K7bXpzsQ3+Mx9c2+/Dz6JfTFZioDZciY5f3EzYjmfopBH/pdIO+4wlr9K5Av9YkhUY3+ufXEMPwSBYd2k2riaWVPdZyYwatWEmeOGLukBsx3IyDbDlMSyv8dkrrth9fX017HDDiDyQSvKu5VBlt8cNBEa/bTneKNh61GkVqJVSuw11NT+8MKppiaNhmDMetmq2FY8KF40ynZYHKB/lgubbsCM0S7jBjWjG/xnBI9s+DMXMGU5E3yjNgC7VQU10gKx2SWkmhnly8UOdsfpfnIhVcsj8xccLj8lPb4Ofn55MGnwXMjfDrMmEWjT64r4IxTKGP6r6cQQQebeHu8inajUhbCfqXq4bBedjoKU+DnmLBBZGgMf16DCL6SpGictgj9+XN/S37PBhB1OPQB1Ie3k6urr9NrykqsXA/ovFgNBiRiZhbcNW76DWiZ68qnMfKD43kQlGkkNWu2YE5vNiBZQRrWpF4DrsdDfy7lXVN5h8l2i3E82UEG24FT4hh82UdtXylpcmEo4OsewUc5dP9WMGnh+ZBccZoVK/l+YTbkwXZcFmSJ9TRrnG42sc8n1GMg8fJj+EBcZmmaPybvsueZtzfTWcQQdI8SYrwygHLn+lZxJ8hhgUsAOjVRRHC8gf7DiRXq5KvgsyGuPT3D3l1U/4=",sidebar_class_name:"post 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"}},g={},f=[{value:"Request",id:"request",level:2}];function y(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:"post",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:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.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)(m.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",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:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder 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:"objectId",required:!1,schemaName:"sting",qualifierMessage:void 0,schema:{type:"string",format:"sting",example:"zxcpou2Hbs"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(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:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "id": "x1Hbnms2Pg",\n "URL": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "objectId": "zxcpou2Hbs",\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\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",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]);