Files
OpenSign/assets/js/bbddd603.98af8ba4.js
T

1 line
8.9 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5483],{56109:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>x,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),m=s.n(n),r=(s(82723),s(9487)),o=(s(41429),s(5397)),p=s(4667),d=s(9472),c=s(85162);const h={id:"template-list",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1v4zYQ/SvEnLqA4o9N0YNOzWbTNGiwCdZZ9GAbC0oayUwokkuO/AFD/70Y2rJVJ5ukQH2Sh/Nmhm/ejLQFklWAdAqEtdOSMMA8AevQS1LW3BSQHo5uVSBIwOOPBgN9ssUG0i0UGHKvHHtDCs7bpSpQZKjtSjjpZY2EXpAVFZIwTZ2hF7YUx3wJ5NYQGuJo0jmt8ph7+Bg45BZCvsBa8hNtHEIKNnvEnEtxnislhYFPtaoV9dyUIazQQwKl9bWknen8IySAa1k7jZCOR20C4Um5/4gbtW0C61ozzMiaYVoFypiUNgFSpP9taxngMThrwq7cAkvZaHrOYWjyHEMoGy0Ojfj/WFJFzyeQV6bq3/RgOVwV1uM/M1OHj/cVX+3b19uXAhzdF0QupMNh1+EmoB/ktmbwl0jVa+gQHw7yiCBLb4A6b2HsDvK5T+j7kFxZm8AfVhfoXweV0ecAmajKoA89jPRebiABRViHt1uyM98Ub2rwt1/fR+KjRWh7Muxu+b0rlQ8vPUrCT5t3EpSzu+1u/Uz9/Yadpo3qb5MTmV8jHdos9G631EgLyzvH2fjfSVpACgct7d0C+mVkfLqFxuue6KRzA+vQBFUZLbPAwhtKp4bLMbRzRuaNV7SZ8LTs2JdOfX/CPg3Sqb+Q+7e/2/pMOnVG9gl5DhUXv0DJMuFb8QB+Pe7Eq466w0Iaj7oVw8tGmdLGXHuS7hwabou4uL8RyzGc0vSwUEGoEI8Lmzc1GoqTL0rrxQlaZDJgIawRtMB4yPbzwVgEh7kq90tjIGZmZia2RtEE5EWjlXkK6cycieldWapcSS3+xiwowvkvHbmr1eoZuR8i5lrRosmER2eP7lU0xg70UYc/HyABQl+Hu3KCfqnybnv8JNUwOg/3q1DmcRViLRULYG/6/RTEetQqRxOwp9aL6/tbcT4YQdLTzztKHt7eXF59mVxxVFbgrkXjwWgwYhOrtpaml+glkRcvLifCNQ2dlspwpFjVdq//49s5RpgnsODxSKew3XLDv3ndtmz+0aDfQDqdJ7CUXsmMFTadt0mnVx6YqHW43L1Nzh44O7vrZif9kzdLm3SIizxHR6/6znsTfH83eYAEsv1nQm0Lxni54k8IuYIUZjAD4I8NjhBHMdq3oKWpGlnFTRbj8u8fliv8NQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/template-list",title:"Get template list",description:"Get template list",source:"@site/docs/API-docs/template-list.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/template-list",permalink:"/docs/API-docs/template-list",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"template-list",title:"Get template list",description:"Get template list",sidebar_label:"Get template list",hide_title:!0,hide_table_of_contents:!0,api:"eJytVk1v4zYQ/SvEnLqA4o9N0YNOzWbTNGiwCdZZ9GAbC0oayUwokkuO/AFD/70Y2rJVJ5ukQH2Sh/Nmhm/ejLQFklWAdAqEtdOSMMA8AevQS1LW3BSQHo5uVSBIwOOPBgN9ssUG0i0UGHKvHHtDCs7bpSpQZKjtSjjpZY2EXpAVFZIwTZ2hF7YUx3wJ5NYQGuJo0jmt8ph7+Bg45BZCvsBa8hNtHEIKNnvEnEtxnislhYFPtaoV9dyUIazQQwKl9bWknen8IySAa1k7jZCOR20C4Um5/4gbtW0C61ozzMiaYVoFypiUNgFSpP9taxngMThrwq7cAkvZaHrOYWjyHEMoGy0Ojfj/WFJFzyeQV6bq3/RgOVwV1uM/M1OHj/cVX+3b19uXAhzdF0QupMNh1+EmoB/ktmbwl0jVa+gQHw7yiCBLb4A6b2HsDvK5T+j7kFxZm8AfVhfoXweV0ecAmajKoA89jPRebiABRViHt1uyM98Ub2rwt1/fR+KjRWh7Muxu+b0rlQ8vPUrCT5t3EpSzu+1u/Uz9/Yadpo3qb5MTmV8jHdos9G631EgLyzvH2fjfSVpACgct7d0C+mVkfLqFxuue6KRzA+vQBFUZLbPAwhtKp4bLMbRzRuaNV7SZ8LTs2JdOfX/CPg3Sqb+Q+7e/2/pMOnVG9gl5DhUXv0DJMuFb8QB+Pe7Eq466w0Iaj7oVw8tGmdLGXHuS7hwabou4uL8RyzGc0vSwUEGoEI8Lmzc1GoqTL0rrxQlaZDJgIawRtMB4yPbzwVgEh7kq90tjIGZmZia2RtEE5EWjlXkK6cycieldWapcSS3+xiwowvkvHbmr1eoZuR8i5lrRosmER2eP7lU0xg70UYc/HyABQl+Hu3KCfqnybnv8JNUwOg/3q1DmcRViLRULYG/6/RTEetQqRxOwp9aL6/tbcT4YQdLTzztKHt7eXF59mVxxVFbgrkXjwWgwYhOrtpaml+glkRcvLifCNQ2dlspwpFjVdq//49s5RpgnsODxSKew3XLDv3ndtmz+0aDfQDqdJ7CUXsmMFTadt0mnVx6YqHW43L1Nzh44O7vrZif9kzdLm3SIizxHR6/6znsTfH83eYAEsv1nQm0Lxni54k8IuYIUZjAD4I8NjhBHMdq3oKWpGlnFTRbj8u8fliv8NQ==",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"},next:{title:"Update an existing pet",permalink:"/docs/API-docs/update-pet"}},x={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.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 list"})}),"\n",(0,t.jsx)(m(),{method:"post",path:"/templatelist"}),"\n",(0,t.jsx)(a.p,{children:"Get template list"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(c.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,t.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,t.jsx)(a.p,{children:"provide below parameter to get number of templates"})})}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:10}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"int32",qualifierMessage:void 0,schema:{type:"integer",format:"int32",example:0}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsx)(l.Z,{children:(0,t.jsxs)(c.default,{label:"default",value:"default",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(c.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(c.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)(p.Z,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"int64",qualifierMessage:void 0,schema:{type:"integer",format:"int64"}}),(0,t.jsx)(p.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)(p.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}})]})]})}),(0,t.jsx)(c.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.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": 0,\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\n}',language:"json"})})]})})})})]})})})})]})}function f(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]);