WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-08 18:57:39 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3dfdd5d03dfd8e85dfaf575ce72e19963b65acd5
OpenSign/assets/js/770b40a9.cfe051cf.js
T

1 line
16 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:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),o=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:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",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:"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:"eJzdV21v2zYQ/ivcfVoB2Zadl3bCMDQYiixYsRRIhgFLjYCWzhYbimRJyi8w9N+HoyRbipu42Yp+2JfEIp+Hd3x4dzxuwfOFg+QObrEwknt0MI0gQ5daYbzQChK4zZFdomcthL0XzrOLD1eMS6lXjm10ybxmFr0VuETGmSSEnjO+5ELymUTm2/WH7DYXjs1LldL6XAq/YcbqpcjQMa6YXqJdClwFvpR7ZsRQ8ZkUasFKh9aRzTTX2iGbW10wXAvnaXbHYKscFUst8jCe6bQsUHk3hAi0QcvJg6sMEligb1nkO0RguOUFerQkzxYULxASkKIQNCtImM8l2g1EYPFzKSxmkMy5dBiB8xtJ6Lm2BUSAayN1hpB4W9JsmmPBIdlCwdeiKAtIzuI4Ar8xRFJlMUMLFfF4YWihcVxFOxfcgzDfzIOnbcbVlNZ1RiuHjrCTOKZ//eBwZZqic/NSsp2iEEGqlUflCc+NkSINE6NPjkjbQwf07BOmQXZLy3hRm7ToSuk7OG4tpw0Lj4U7zq+H6YR3SOetUAuIgjTcd0d2e4f1+LeZKtzkw4I08cLT6OESe4ILP3aRRyyl/RFSi2YBWpFLMkP7vbZVx9NzDtb+sACs9kLsHL9vHCbXxTGJcu+NS0ajlkw5PEx1QWy9Ur19PydWSGfdehWBEwsVsvTfBonVx1xPUX+dYJ80shkGt7DgQh5FzxDfNgOtFibX6oiZ07Pzyfjkzesx4VciW6D/D/uvZw/t9RP9gmo9ZmzJZYmODRjpzn1pMWLO88IMjwTfDk9Orw+LT4e9G9mxJ6enVQSbF7Jej0mfF5JO3lQR5C8knZ7TyfEFvpA3/mJa3dQhfd8ebfUcKmSmQ5VdqWvbLx8zrSVy1TUY7ocqgpBFmF345yNtEk9OBuN4EL++HZ8npz8lZ+fDOI7/hgjWRQjv5lbKmqrXetl+lyb7Dnaqx7BuIX4sXF9OoaRQeN/edPeTOL4/J0gVwWl8dnjjXakllyILDdCtfkD1w7e779BafaQOds372vzh9kUNCvPQ22x3vN6kw7S0wm9Cm7MecCMG9XxyN6UeoECf66ZHCn2RzyGB0aN2yaFdtr1SaWWn3nNjhtqgovyXfOaozo24EaMlla/HaOf5QqjF4FnWdO/1DSlbi9fzfV8MjfgdqRo20nRRTReVIw+3WEXfcx3IjWDXBhXlWZB7OT6oiqGXFS5Mt+1lOHo215Y9YrMZd5gxrZjPMUzS+MlwzJzBVMybqBmyj+qjutEFUp9LnZUU6sElH9WA3V3P5yIVXLK/cOaEx+mPrXKr1epAsVeBcyl8Xs6YRaP38EUYDLJ2WbuPVxCBR1u46/kNNeRpe4c/YWoUwKMmF3gacqG5BNuht49JFJtSpKgcdqL34vLDe7ZkJ8MYok54fIXTo/dXv7774+YdrUvhWB/SeBgP43C1aucLrjqmeu+aJpR7J7zdp/b/9CHU5InHtR8ZyUUoGEH1bZPsd9BL9mkEuXaexrdbCuk/rawqGq6fI1QCMuFot/sHyQNuOs+n0ERAAqEAPIFt3jl76JQ+rCBsqE1Rm7hksOZcpCmaroGDYtyraJfvbiECXvq8XzAeQsFoftDq7ZTadNbuV5LaAfpLe/oi4WcKld9x88sOXs88SWj216LpaKZVVf0DxOlbkA==",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"}},f={},g=[{value:"Request",id:"request",level:2}];function b(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)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(c.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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(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)(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:"widgets"})}),(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:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(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)("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:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(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)(o.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 "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\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)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,i.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