From 177ffecb2b05dac4e7bb46affc0d8fa54bb05d85 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Jan 2024 10:40:49 +0000 Subject: [PATCH] deploy: d6b12b75b0a492be252f0a53c14b582fff453241 --- 404.html | 2 +- assets/js/377084eb.96975bf8.js | 1 + assets/js/377084eb.fc47c37f.js | 1 - assets/js/770b40a9.a106d1ce.js | 1 - assets/js/770b40a9.c48a19a9.js | 1 + assets/js/bbdfc22d.0130c100.js | 1 + assets/js/bbdfc22d.dc75f692.js | 1 - assets/js/f0ff4a36.54a35a79.js | 1 - assets/js/f0ff4a36.5ab2b8c7.js | 1 + assets/js/{fa40969b.4b77d0d7.js => fa40969b.f555cec9.js} | 2 +- .../js/{runtime~main.316c4feb.js => runtime~main.93e16c68.js} | 2 +- blog/archive/index.html | 2 +- blog/first-blog-post/index.html | 2 +- blog/index.html | 2 +- blog/long-blog-post/index.html | 2 +- blog/mdx-blog-post/index.html | 2 +- blog/tags/docusaurus/index.html | 2 +- blog/tags/facebook/index.html | 2 +- blog/tags/hello/index.html | 2 +- blog/tags/hola/index.html | 2 +- blog/tags/index.html | 2 +- blog/welcome/index.html | 2 +- docs/API-docs/contactlist/index.html | 2 +- docs/API-docs/createcontact/index.html | 2 +- docs/API-docs/createdocument/index.html | 2 +- docs/API-docs/createtemplate/index.html | 4 ++-- docs/API-docs/delete-template/index.html | 2 +- docs/API-docs/deletecontact/index.html | 2 +- docs/API-docs/deletedocument/index.html | 2 +- docs/API-docs/get-template/index.html | 4 ++-- docs/API-docs/get-user/index.html | 2 +- docs/API-docs/getcontact/index.html | 2 +- docs/API-docs/getdocument/index.html | 2 +- docs/API-docs/getdocumentlist/index.html | 2 +- docs/API-docs/gettemplatelist/index.html | 4 ++-- docs/API-docs/intro/index.html | 2 +- docs/API-docs/opensign-api-v-1/index.html | 2 +- docs/API-docs/update-template/index.html | 2 +- docs/category/tutorial---basics/index.html | 2 +- docs/category/tutorial---extras/index.html | 2 +- docs/contribute/CODE_OF_CONDUCT/index.html | 2 +- docs/contribute/COMMUNITY/index.html | 2 +- docs/contribute/INSTALLATION/index.html | 2 +- docs/contribute/REPORTING_GUIDELINES/index.html | 2 +- docs/contribute/intro/index.html | 2 +- docs/help/New-Document/request-signatures/index.html | 2 +- docs/help/New-Document/sign-yourself/index.html | 2 +- docs/help/intro/index.html | 2 +- docs/intro/index.html | 2 +- docs/self-host/intro/index.html | 2 +- docs/self-host/tutorial-basics/congratulations/index.html | 2 +- docs/self-host/tutorial-basics/create-a-blog-post/index.html | 2 +- docs/self-host/tutorial-basics/create-a-document/index.html | 2 +- docs/self-host/tutorial-basics/create-a-page/index.html | 2 +- docs/self-host/tutorial-basics/deploy-your-site/index.html | 2 +- docs/self-host/tutorial-basics/markdown-features/index.html | 2 +- .../self-host/tutorial-extras/manage-docs-versions/index.html | 2 +- docs/self-host/tutorial-extras/translate-your-site/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 60 files changed, 59 insertions(+), 59 deletions(-) create mode 100644 assets/js/377084eb.96975bf8.js delete mode 100644 assets/js/377084eb.fc47c37f.js delete mode 100644 assets/js/770b40a9.a106d1ce.js create mode 100644 assets/js/770b40a9.c48a19a9.js create mode 100644 assets/js/bbdfc22d.0130c100.js delete mode 100644 assets/js/bbdfc22d.dc75f692.js delete mode 100644 assets/js/f0ff4a36.54a35a79.js create mode 100644 assets/js/f0ff4a36.5ab2b8c7.js rename assets/js/{fa40969b.4b77d0d7.js => fa40969b.f555cec9.js} (70%) rename assets/js/{runtime~main.316c4feb.js => runtime~main.93e16c68.js} (62%) diff --git a/404.html b/404.html index f2a63d907..5619d9996 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/377084eb.96975bf8.js b/assets/js/377084eb.96975bf8.js new file mode 100644 index 000000000..65926fd94 --- /dev/null +++ b/assets/js/377084eb.96975bf8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),m=(s(82723),s(9487)),d=s(41429),c=s(5397),p=s(4667),o=s(9472),h=s(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",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/get-template",title:"Get template by ID",description:"",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v4zYQ/SvsnDaAYstZ56JTg26aGl0kQe2iB8cIKGlkMZFILkk5Ngz992IoS1bsJA6KYk+Wh/PxZuYNh1twfGkhmsMMS11whxYWAaRoEyO0E0pCBBCA0mg4/Z2kEMESXasOAWhueIkODfnZguQlQgTrc67FuVPPKCEAQX5y5CkaCMDgj0oYTCFypsIArNsUZGNFqQtyiWtdqBQhynhhSSHJseQQbcFttNd0Rsgl1KTKvVFEGKUVSzlYr9drqIMOitthfRRpC0Vzl8NhnpNvTGWs1WYu545JxNQyp1iMLEOX5Jj+nwkEkClTctdIKKN6Qe6tVtKiJYOLMKSf11BtlSRobVYVrGsNBJAo6VA60udaFyLxB8MnS0bbYxQqfsLEUQ8NuXGiCZl46J2WrMrY962r9UUY1h5mVbjT7hoxMefj9BvJvqHr0R+xLO3FvW/0TLgC33KxN7D+o+sgWd0qd8Ko67dUjcnvqiCafmiUeR3mCUYm4hS03Dlto+GwjVZZNINElWR99yJPxetAJga5U/vIU7GUfvI6a24M3xDPHZb2dHNu/Yx8FPtJIYsRoa4DcE0T9iPVxq/pdF0W5Opg7OANu1fOhCyExMeW9Y8XYfg4CsllHcA4HB/Tf9brGctUJdNffiL7x+G4DqBEa/nyRO3eAvpR6uNw/HjZZX55nPlErnghUnZ1P2Ezulx/buKXn028j9M1OI8ZIhqlZkm8qkpf3lSjRJer3fLxS8flEEE3T8Nt75avIQCLZtWupMoUvRHkWg/aXVHw2NIYDrkWw9UI6Pa1mFRGuM2UytZUpr/MepOmxZ9Io3Zy5VECQmbKG++SvNMoaXp8iVajo200y4VlwvrjVCVVidL5vrJMGXZgzWJuMWVKMpejPyT518GIWY2JyHaUGLAH+SCnqkRWWaTtUQj5bKMHec7md1kmEsEL9g/GVjhcfGkr9vLyclSxM29zI1xexcygVnv1pRf6svatuj9nEIBDU9q7bIpmJZL2gnwn1NArD3dE54knOpZcUFd3ol8PjYhPhUhQWuwx7urm/jv7Oggh6JHiE5CH3ye/Xd9Or8kr0app0WgQDkISaWVdyWUv0A26/Usi3rDJt8MGb/djSy+sHaccrt1QF1z4gfAYtzuyz/e3ZwBR/1GzCCBX1pHKdktM+NsUdU3iHxWaDUTzRQArbgSPiXrzLaTC0nfaPVDehfblr91b54x9/n30ZjLt1EgamRUvKmwyf8bNwSOtXtRBOzr/Ge17MJpwr2e1Q0OvxkbhKklQu97Z0c1Kd0V3K91cz6Cu/wU9Kt9I",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.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,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get template by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{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)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsxs)(s,{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)(a.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.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)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{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)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.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)(a.p,{children:"Array ["})})}),(0,l.jsx)(p.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)(a.p,{children:"]"})})})]})]})})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\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 }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.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)(s,{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)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,t.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.fc47c37f.js b/assets/js/377084eb.fc47c37f.js deleted file mode 100644 index 976421503..000000000 --- a/assets/js/377084eb.fc47c37f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,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)),d=a(41429),p=a(5397),o=a(4667),c=a(9472),h=a(85162);const x={id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VltP20oQ/it75qlIS+LQ8OKnogNC0UGACtV5gAht7HG8YO9ud9chUeT/Xs06dkwCLVRVnxLPzuWb+6zBi7mD+A5usTSF8OhgyiFFl1hpvNQKYgAO2qAV9DlJIYY5+pYdOBhhRYkeLelZgxIlQgzLQ2HkoddPqICDJD05ihQtcLD4vZIWU4i9rZCD86uCZJwsTUEqcWkKnSLEmSgcMSQ5lgLiNfiVCZzeSjWHmlhFEIoJo3JyrgbL5XIJNe+g+A3WB5m2UIzwOez6OTllOmMtN/O58Ewhpo55zWbIMvRJjumfdIBDpm0pfEMhj+opqXdGK4eOBI6iiH5eQnVVkqBzWVWwLjXAIdHKo/LEL4wpZBIeho+OhNb7KPTsERNPObSkxsvGZBKgd1yqKmchb12sj6KoDjCrwv9a3WVIw89dbyjbZLrwp0sGZfpS+w+ruS5QOGQWFxKfmVApowphPpeOpTqpSopWzeG0H92PmejqpZ+hmsO3rxcfVZV7b1w8HK50ZWUp5jhIdEm6CHTor06fsFas+sJ38Kjxy7wUsghSHB51rnqEKYdlWZCKTVu0Sjk8W2FMW801B+mxdK+B30IlY5uvjbnXldccvPTFC1JNUShStDRMPhah5aObidG5WF4HNS9tJhaFx37JtKZ3X3pPUhVS4UPbcg9HUfQwiqCuiWkcjfd7rx19TGnPMl2p9J+/2HrjaFxzKNE5MX+1HbbBeg3oz1wfR+OH487z433PJ2ohCpmyk+sJu6XJ/ncdP36v432cvsG5Xy2yYWo21Iuo9OlNNEr0ud5svrDxfA4xDNuCGq57K6YGDg7tot2HlS16rS2MGbSLqhAzR80zFEYOFyOg0e8wqaz0qxsKWxOZ/ibtDQAj/0OaAL/ct+SAVJkOwhsnrwyqG5qEFKLFaG8V3tKAlC48t3My5JVl2rIdaTYTDlOmaa5ieCT658GIOYOJzDYlMWD36l7d6BJZ5ZBWVyHVk4vv1SG7u8oymUhRsP9x5qTH6ac2Ys/Pz3sROwgy59Ln1YxZNHrLPg/EENa+VPdxABw82tJdZTdoFzJpB+8bpoaBebgpdJGEQkeaqjRXGtKXXSGqp0ImqBz2Ku7k/PqCfR5EwHtF8Q7Iw4vJv2eXN2eklcqqSdFoEA0iIhntfClUz9A5+u0ZM1uxyelugtfbtqXzblNTHpd+aAohQ0MEjOtNsd91ew44xP2Lasoh184Ty3pNlfDNFnVN5O8V2hXEd1MOC2GlmIU9tYZUOvqfdtfRm9A+fd0cWgfs/cfZq860XaOoZRaiqLDx/AlXOxdiPa152zq/jfYtGI25l73aoaGTtWE4SRI0vve2N1lpVnRT6fzsFur6B2OiCzI=",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/get-template",title:"Get template by ID",description:"",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get template by ID",description:"",sidebar_label:"Get template by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VltP20oQ/it75qlIS+LQ8OKnogNC0UGACtV5gAht7HG8YO9ud9chUeT/Xs06dkwCLVRVnxLPzuWb+6zBi7mD+A5usTSF8OhgyiFFl1hpvNQKYgAO2qAV9DlJIYY5+pYdOBhhRYkeLelZgxIlQgzLQ2HkoddPqICDJD05ihQtcLD4vZIWU4i9rZCD86uCZJwsTUEqcWkKnSLEmSgcMSQ5lgLiNfiVCZzeSjWHmlhFEIoJo3JyrgbL5XIJNe+g+A3WB5m2UIzwOez6OTllOmMtN/O58Ewhpo55zWbIMvRJjumfdIBDpm0pfEMhj+opqXdGK4eOBI6iiH5eQnVVkqBzWVWwLjXAIdHKo/LEL4wpZBIeho+OhNb7KPTsERNPObSkxsvGZBKgd1yqKmchb12sj6KoDjCrwv9a3WVIw89dbyjbZLrwp0sGZfpS+w+ruS5QOGQWFxKfmVApowphPpeOpTqpSopWzeG0H92PmejqpZ+hmsO3rxcfVZV7b1w8HK50ZWUp5jhIdEm6CHTor06fsFas+sJ38Kjxy7wUsghSHB51rnqEKYdlWZCKTVu0Sjk8W2FMW801B+mxdK+B30IlY5uvjbnXldccvPTFC1JNUShStDRMPhah5aObidG5WF4HNS9tJhaFx37JtKZ3X3pPUhVS4UPbcg9HUfQwiqCuiWkcjfd7rx19TGnPMl2p9J+/2HrjaFxzKNE5MX+1HbbBeg3oz1wfR+OH487z433PJ2ohCpmyk+sJu6XJ/ncdP36v432cvsG5Xy2yYWo21Iuo9OlNNEr0ud5svrDxfA4xDNuCGq57K6YGDg7tot2HlS16rS2MGbSLqhAzR80zFEYOFyOg0e8wqaz0qxsKWxOZ/ibtDQAj/0OaAL/ct+SAVJkOwhsnrwyqG5qEFKLFaG8V3tKAlC48t3My5JVl2rIdaTYTDlOmaa5ieCT658GIOYOJzDYlMWD36l7d6BJZ5ZBWVyHVk4vv1SG7u8oymUhRsP9x5qTH6ac2Ys/Pz3sROwgy59Ln1YxZNHrLPg/EENa+VPdxABw82tJdZTdoFzJpB+8bpoaBebgpdJGEQkeaqjRXGtKXXSGqp0ImqBz2Ku7k/PqCfR5EwHtF8Q7Iw4vJv2eXN2eklcqqSdFoEA0iIhntfClUz9A5+u0ZM1uxyelugtfbtqXzblNTHpd+aAohQ0MEjOtNsd91ew44xP2Lasoh184Ty3pNlfDNFnVN5O8V2hXEd1MOC2GlmIU9tYZUOvqfdtfRm9A+fd0cWgfs/cfZq860XaOoZRaiqLDx/AlXOxdiPa152zq/jfYtGI25l73aoaGTtWE4SRI0vve2N1lpVnRT6fzsFur6B2OiCzI=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create template",permalink:"/docs/API-docs/createtemplate"},next:{title:"Update template by ID",permalink:"/docs/API-docs/update-template"}},g={},f=[{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 by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\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:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\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)(d.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)(c.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.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:"createtemplate"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "result": {\n "Name": "sample template",\n "Note": "Please review and sign this document",\n "Description": "template description",\n "URL": "https://yourimage.com",\n "signers": [\n "joe@gmail.com",\n "john@gmail.com"\n ],\n "folderId": "xjsba1GaxP"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Template not found!"})}),(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)(c.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "code": 404,\n "message": "Template not found!"\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)(c.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.a106d1ce.js b/assets/js/770b40a9.a106d1ce.js deleted file mode 100644 index 2fc9d9328..000000000 --- a/assets/js/770b40a9.a106d1ce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>b});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=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:"eJy9Vk1v4zYQ/SvqnDaAYsnJ7kWnZtM0DbrYBGsXPdhGQEkjmwlFcknKHzD034uhJFuxs3G2KOqL7eE8cubNmyG34NjcQjKBMZZaMIcWZiEojYY5ruRdDgnM0bl2VXDrIATNDCvRoSHoFiQrERJYnzPNz516RgkhcAkJLJDlaCAEg98rbjCHxJkKQ7BuIwhjeakFQgi41kLlCEnBhCWHbIElg2QLbqO9pzNczqEmV+ZBCcUpLZ/LwXq9XkM9a85B6z6rfEPYTEmH0tFPprXgmc8qerJKku3oEJU+YeYzNMSB42hpVfCSu56brMrUp1UoUzLXt+yCG8Z1CPaZ65/ExXUdwroUBGuJJdZTyqgOwXEnXtpqAhi0WknbhHsRx/SVo80M15Qx8VdlGVpbVCLYlRfC/4qhzNfuONFdWhdx3IRZiT6TzBi2IbU4LO3pYxozqfJQFz1Od5a9UNbDP1JZ2osHL6DfucDXdtj7L5zTNomiTveVRTPIVEnor74ob6Gt/xF0YA9S7gSo8w6kaiC/9cv3PiRFRvkpQV33JqjwPjvIiM+lb+d/W5nTrDwphLqn4C7sx+5sWrw2yBx+3rwz44zcVZfGUeP0K3B4LNT9YLgUXOJj10aPF3H8OLxsm+tj/Om4n+7kkgmeB1cPd8GYZt4v/2M3fYw/1SGUaC2bn6C9H6dr4jwmijdOzex+QUvf3rDxkoZbdDuhB+31UKJbKLo5tGqvC7eABKKDW8SiWXZXSGVEr+2Y1oNutguWWmq9iGkeLYd+ylvMKsPdZkR8NpT1L5+eiDX/E0nFJ68oyozK9G1/gdx0HO4ugGHcjXQaZlwWyp/VknWvUZKWPdXLIRxSNV5wG3Drl3OVVSVK5/URFMoEB+ggZRbzQMnALdAvkv1yMAysxowXrbQGwVRO5UiVGFQWabgLLp9tMpXnweS+KHjGmQj+xtRyh7MPHcGr1eqI4DOPueVuUaWBQa327nNv9FXoo3Z/ziAEh6a098UIzZJn3Qz9wVGRd47ahmGZbxgsGScRtKZfD0GkS8EzlBZ7yr26ffgSXA5iCHsaekfI0Ze765uvoxvalVTYlGg4iAcxmUi5JZO9g14Tev7qiHa4dpEWjPtW8lFt2x6YwIsemIWwoBZJJrDdUsH/MqKuyfy9QrOBZDILYckMZykpbDKrw06v1DQ5t7SQ7x5NB/HsphF8+Na+v84CKtVrcT7j5qhBlkxU5Al1uG0drps9z8e0x97jaNrtEVdZhtq96TvrzYyH+9EYQkjbF1zpRyEYtqJXJFtBAlOYAtAjlXbwze/tWxBMzis/EKHZlz7/ANj5vD8=",sidebar_class_name:"post 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:"eJy9Vk1v4zYQ/SvqnDaAYsnJ7kWnZtM0DbrYBGsXPdhGQEkjmwlFcknKHzD034uhJFuxs3G2KOqL7eE8cubNmyG34NjcQjKBMZZaMIcWZiEojYY5ruRdDgnM0bl2VXDrIATNDCvRoSHoFiQrERJYnzPNz516RgkhcAkJLJDlaCAEg98rbjCHxJkKQ7BuIwhjeakFQgi41kLlCEnBhCWHbIElg2QLbqO9pzNczqEmV+ZBCcUpLZ/LwXq9XkM9a85B6z6rfEPYTEmH0tFPprXgmc8qerJKku3oEJU+YeYzNMSB42hpVfCSu56brMrUp1UoUzLXt+yCG8Z1CPaZ65/ExXUdwroUBGuJJdZTyqgOwXEnXtpqAhi0WknbhHsRx/SVo80M15Qx8VdlGVpbVCLYlRfC/4qhzNfuONFdWhdx3IRZiT6TzBi2IbU4LO3pYxozqfJQFz1Od5a9UNbDP1JZ2osHL6DfucDXdtj7L5zTNomiTveVRTPIVEnor74ob6Gt/xF0YA9S7gSo8w6kaiC/9cv3PiRFRvkpQV33JqjwPjvIiM+lb+d/W5nTrDwphLqn4C7sx+5sWrw2yBx+3rwz44zcVZfGUeP0K3B4LNT9YLgUXOJj10aPF3H8OLxsm+tj/Om4n+7kkgmeB1cPd8GYZt4v/2M3fYw/1SGUaC2bn6C9H6dr4jwmijdOzex+QUvf3rDxkoZbdDuhB+31UKJbKLo5tGqvC7eABKKDW8SiWXZXSGVEr+2Y1oNutguWWmq9iGkeLYd+ylvMKsPdZkR8NpT1L5+eiDX/E0nFJ68oyozK9G1/gdx0HO4ugGHcjXQaZlwWyp/VknWvUZKWPdXLIRxSNV5wG3Drl3OVVSVK5/URFMoEB+ggZRbzQMnALdAvkv1yMAysxowXrbQGwVRO5UiVGFQWabgLLp9tMpXnweS+KHjGmQj+xtRyh7MPHcGr1eqI4DOPueVuUaWBQa327nNv9FXoo3Z/ziAEh6a098UIzZJn3Qz9wVGRd47ahmGZbxgsGScRtKZfD0GkS8EzlBZ7yr26ffgSXA5iCHsaekfI0Ze765uvoxvalVTYlGg4iAcxmUi5JZO9g14Tev7qiHa4dpEWjPtW8lFt2x6YwIsemIWwoBZJJrDdUsH/MqKuyfy9QrOBZDILYckMZykpbDKrw06v1DQ5t7SQ7x5NB/HsphF8+Na+v84CKtVrcT7j5qhBlkxU5Al1uG0drps9z8e0x97jaNrtEVdZhtq96TvrzYyH+9EYQkjbF1zpRyEYtqJXJFtBAlOYAtAjlXbwze/tWxBMzis/EKHZlz7/ANj5vD8=",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={},b=[{value:"Request",id:"request",level:2}];function f(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:"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)(d.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)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.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)(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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template name"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(o.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)(o.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)(o.Z,{collapsible:!1,name:"CreateBy",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(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 "code": 200,\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "File": "https://templateuser.com",\n "Name": "sample template",\n "Note": "template note",\n "Description": "template name",\n "Folder": "folder name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "CreateBy": "template creator name"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.c48a19a9.js b/assets/js/770b40a9.c48a19a9.js new file mode 100644 index 000000000..8fa8dabe4 --- /dev/null +++ b/assets/js/770b40a9.c48a19a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>j,default:()=>b,frontMatter:()=>x,metadata:()=>u,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)),d=a(41429),p=a(5397),o=a(4667),c=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:"eJy9Vk1v4zYQ/SvsnDaAYsvJ7kWnpos0DbpIgrWLHmwjoKSxzYQiuSTlDxj674uhPqzY27gtivpieziPM3zzZsg9eL50kExhgoWR3KODeQTaoOVeaHWfQwJL9L5ZlcJ5iMBwywv0aAm6B8ULhAS2l9yIS69fUUEEQkECK+Q5WojA4rdSWMwh8bbECJzfScI4URiJEAFujdQ5QrLg0pFDtsKCQ7IHvzPB01uhllCRKw+ghPJUTizVYLvdbqGa13HQ+V90viNsppVH5eknN0aKLJxq+OK0IttJEJ2+YBZOaIkDL9DRqhSF8D03VRZpONZC24L7vqVLbhRXEbhXYf4hLq6qCLaFJFhDLLGe0omqCLzw8q2tIoBFZ7RydbpXcUxfObrMCkMnJv7KLEPnFqVkXXkh+q8YykLtTg/aHesqjus0S9lnklvLd6QWj4U7H6Y2kyqPddHjtLMchLId/Zaqwl09BQFNag5PtzgAXPjBWt0T6kH7M6DWmyldQ37VkuT/LmgRfFgoNUHEudRW3huXDIdttNKhHWS6IPTjRp2L1yWZWeReHyKPxVKFjv63xXkIan0v9otGliJC1RNym89zG786bYB+GY5xtX9rFUoKhc9tOzxfxfHz6Lppko/xp9O+uFdrLkXObp7u2YRm10//Y1d8jD9VERToHF+e4a6fp6/zPCVK1E71DH5DS99es/GWhjv0ndpZM+YL9CtNN4DRzdj3K0hgeHQbOLTr9ioorexJlBszaGe05KkjmQ65EcP1KExrh1lphd+Nic+asv4l0lOiEb8jSfHsVUMnozJ9PVwEty2H3SAfxe1opqEk1EKHWA1ZjwYViTFQvR7BMVWTlXBMuLCc66wsUPmgD7bQlh2hWcod5kwr5lcYFsl+PRgxZzATi0ZaAzZTMzXWBbLSIQ1pKdSrS2bqkk0fFwuRCS7Zn5g64XH+oSV4s9mcEHwRMHfCr8qUWTT64L4MxlCFPqr7cwEReLSFe1yM0a5F1s6bvwg1DM7DpmF4FhoGCy5IBI3p52MQ6VKKDJXDnnJv7p6+sOtBDFFPQ38j5eGX+8+3D+Nb2pVUWJdoNIgHMZlIuQVXvUA/Evqb+nai87j1QyO5CK0Usto3PTCFNz0wj2BFLZJMYb+ngv9hZVWR+VuJdgfJdB7BmlvBU1LYdF5FrV6paXLhaCHvHj9H+XTTCD58bd5RF4xK9aM8X3F30iBrLkvyhCraNw6f6z0vJ7THweNk2h0QN1mGxr/rO+/NjKfH8QQiSJuXWBFGIVi+odcg30ACM5gB0GOTdgjNH+x7kFwtyzAQod6XPt8B9R2o0A==",sidebar_class_name:"post 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:"eJy9Vk1v4zYQ/SvsnDaAYsvJ7kWnpos0DbpIgrWLHmwjoKSxzYQiuSTlDxj674uhPqzY27gtivpieziPM3zzZsg9eL50kExhgoWR3KODeQTaoOVeaHWfQwJL9L5ZlcJ5iMBwywv0aAm6B8ULhAS2l9yIS69fUUEEQkECK+Q5WojA4rdSWMwh8bbECJzfScI4URiJEAFujdQ5QrLg0pFDtsKCQ7IHvzPB01uhllCRKw+ghPJUTizVYLvdbqGa13HQ+V90viNsppVH5eknN0aKLJxq+OK0IttJEJ2+YBZOaIkDL9DRqhSF8D03VRZpONZC24L7vqVLbhRXEbhXYf4hLq6qCLaFJFhDLLGe0omqCLzw8q2tIoBFZ7RydbpXcUxfObrMCkMnJv7KLEPnFqVkXXkh+q8YykLtTg/aHesqjus0S9lnklvLd6QWj4U7H6Y2kyqPddHjtLMchLId/Zaqwl09BQFNag5PtzgAXPjBWt0T6kH7M6DWmyldQ37VkuT/LmgRfFgoNUHEudRW3huXDIdttNKhHWS6IPTjRp2L1yWZWeReHyKPxVKFjv63xXkIan0v9otGliJC1RNym89zG786bYB+GY5xtX9rFUoKhc9tOzxfxfHz6Lppko/xp9O+uFdrLkXObp7u2YRm10//Y1d8jD9VERToHF+e4a6fp6/zPCVK1E71DH5DS99es/GWhjv0ndpZM+YL9CtNN4DRzdj3K0hgeHQbOLTr9ioorexJlBszaGe05KkjmQ65EcP1KExrh1lphd+Nic+asv4l0lOiEb8jSfHsVUMnozJ9PVwEty2H3SAfxe1opqEk1EKHWA1ZjwYViTFQvR7BMVWTlXBMuLCc66wsUPmgD7bQlh2hWcod5kwr5lcYFsl+PRgxZzATi0ZaAzZTMzXWBbLSIQ1pKdSrS2bqkk0fFwuRCS7Zn5g64XH+oSV4s9mcEHwRMHfCr8qUWTT64L4MxlCFPqr7cwEReLSFe1yM0a5F1s6bvwg1DM7DpmF4FhoGCy5IBI3p52MQ6VKKDJXDnnJv7p6+sOtBDFFPQ38j5eGX+8+3D+Nb2pVUWJdoNIgHMZlIuQVXvUA/Evqb+nai87j1QyO5CK0Usto3PTCFNz0wj2BFLZJMYb+ngv9hZVWR+VuJdgfJdB7BmlvBU1LYdF5FrV6paXLhaCHvHj9H+XTTCD58bd5RF4xK9aM8X3F30iBrLkvyhCraNw6f6z0vJ7THweNk2h0QN1mGxr/rO+/NjKfH8QQiSJuXWBFGIVi+odcg30ACM5gB0GOTdgjNH+x7kFwtyzAQod6XPt8B9R2o0A==",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 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:"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)(d.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)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,l.jsx)(o.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)(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)(c.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.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)(o.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)("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)(p.Z,{responseExample:'{\n "code": 200,\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 }\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)(c.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)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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)(p.Z,{responseExample:'{\n "code": 405,\n "message": "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)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.0130c100.js b/assets/js/bbdfc22d.0130c100.js new file mode 100644 index 000000000..4b517bffb --- /dev/null +++ b/assets/js/bbdfc22d.0130c100.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),i=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),c=a(41429),o=a(5397),p=a(4667),d=a(9472),u=a(85162);const h={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOs0gkwRm5rB9mll2hNAiQITRHiBCTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkFm6wsEoE9DDikKFPnbRBGg0J3OTI2mN24lCQnH27OmNCKTP3rPToPAuGpXSILC19MIX8KcYKWWgdczbPZZozj26GTHg2ViVaJ3XwbGIcm6JGJ4LUU5aZtCyQDuYy5Mw6zHAiNWbMB1emoXToe+yHNZr5Mk3R+0mp1jfVMKTRnIUcI1CHoXTaM8FKLZ9KZAcHrfZZdnDAQi4CS4VmY6TXZPSYBg920IwFnRkd/XqLqZxIUm5c9YCDsfERRp9lkEAdkPYcOFjhRIEBHQV9BVoUCAksDoWVh8E8ogYOkoKeo8jQAQeHT6V0mEESXIkcfFgqsvGysIpc4sIqkyEkE6E8KaQ5FgKSFYSljZrBST2FilRFNEoIpvZyqnuLxWIB1ai+B334w2RLsk2NDqgDfRTWKpnGR/UfPJXEav8SM37ANNALHYUgSPR0ehEfuAuFw8S4QoSuZIPNxw/rqBLwCxPe7eZKofDIHM4kzpnQGaMHs5BLv04p+f6zW+zvu2Jdcd2GqTj8uD5/r6s8BOuTfn9pSicLMcVeagryRaBjuaz9CefEsmt8Cw8Gv04LIVW04vBgct0RjDgsCkUumoJrnXKYO2FtW10VBxmw8M+B30Cly5pvzXXPO684BBnUlqiiKKgMHbXH+yK0ePBjcXQqFlfRzfadO43WuXr3pCJjh94a7esaPR4M6N8O6W2RCTHPmmjU8jfg/1aDpLF111q6LMax7dfvPh4MKg4Fei+mz/bAJkKvYK7fXarwOqpavJWjBlnFoXTq1zjaWm4kpaursOpkRWolNd63ebg/Hgzuf79v4L2q2GTx8+DLfuLO9EwomUXavyFG/S+T9Xnw5a3J6uIMNc79spa1Uj0ZtqLSldfRKDDkhoaONT5CFyGHBPp7MygO4GYAxVyuEyas7bWTQYmxp7T1hZX92VGcER7T0smwHFK86pB0R1eHoqz8C4mjXh1whJzScL0ZP9/bGLXjY28itAPhbRy/Q/HPs3ZD2i/wcIeG30K2G4rbYi16+cTEMDV5vLSoh4SYqmB2BPurl/RM+njcvqdev2hj2rHeXk/okOSfekftqlJXfY/d6Ts9NEVcdWhxUlI/+uROH7Lby8lEplIo9jeOvQw4+tAGZD6f79XGx2hzKkNejplDazbq0yiMBdS1Wn/5CBwCusJfToboZjJtieOFq/pRud/0skhjLyMFnTi+Fn3dNaKQK5mi9thpqm+nV+fsU28AvFP+b4DcPz87+X4x/E5eqYHqFB31Br0BiajtCqE7F53U63CnbLPtXWNNS//v2O/ZsRuSCbgIfauE1J2pVLPe7e7YH3HIiRaTW1it6IofTlUViZ9KdEtIbkccZsJJiid9q3jLUESTmfR0kK2X7BcT+eG62dc/speQPuJyjxJnQpWkCRVfNQontc/DG/Kx0dibXxuLb2mKNvxSd9SZE1eXwxvgMG42/iION3BiTr86xBwSuIM7iL9pyEOk+yhfgRJ6WsYRB7Vf+vsHohb7lQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOs0gkwRm5rB9mll2hNAiQITRHiBCTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkFm6wsEoE9DDikKFPnbRBGg0J3OTI2mN24lCQnH27OmNCKTP3rPToPAuGpXSILC19MIX8KcYKWWgdczbPZZozj26GTHg2ViVaJ3XwbGIcm6JGJ4LUU5aZtCyQDuYy5Mw6zHAiNWbMB1emoXToe+yHNZr5Mk3R+0mp1jfVMKTRnIUcI1CHoXTaM8FKLZ9KZAcHrfZZdnDAQi4CS4VmY6TXZPSYBg920IwFnRkd/XqLqZxIUm5c9YCDsfERRp9lkEAdkPYcOFjhRIEBHQV9BVoUCAksDoWVh8E8ogYOkoKeo8jQAQeHT6V0mEESXIkcfFgqsvGysIpc4sIqkyEkE6E8KaQ5FgKSFYSljZrBST2FilRFNEoIpvZyqnuLxWIB1ai+B334w2RLsk2NDqgDfRTWKpnGR/UfPJXEav8SM37ANNALHYUgSPR0ehEfuAuFw8S4QoSuZIPNxw/rqBLwCxPe7eZKofDIHM4kzpnQGaMHs5BLv04p+f6zW+zvu2Jdcd2GqTj8uD5/r6s8BOuTfn9pSicLMcVeagryRaBjuaz9CefEsmt8Cw8Gv04LIVW04vBgct0RjDgsCkUumoJrnXKYO2FtW10VBxmw8M+B30Cly5pvzXXPO684BBnUlqiiKKgMHbXH+yK0ePBjcXQqFlfRzfadO43WuXr3pCJjh94a7esaPR4M6N8O6W2RCTHPmmjU8jfg/1aDpLF111q6LMax7dfvPh4MKg4Fei+mz/bAJkKvYK7fXarwOqpavJWjBlnFoXTq1zjaWm4kpaursOpkRWolNd63ebg/Hgzuf79v4L2q2GTx8+DLfuLO9EwomUXavyFG/S+T9Xnw5a3J6uIMNc79spa1Uj0ZtqLSldfRKDDkhoaONT5CFyGHBPp7MygO4GYAxVyuEyas7bWTQYmxp7T1hZX92VGcER7T0smwHFK86pB0R1eHoqz8C4mjXh1whJzScL0ZP9/bGLXjY28itAPhbRy/Q/HPs3ZD2i/wcIeG30K2G4rbYi16+cTEMDV5vLSoh4SYqmB2BPurl/RM+njcvqdev2hj2rHeXk/okOSfekftqlJXfY/d6Ts9NEVcdWhxUlI/+uROH7Lby8lEplIo9jeOvQw4+tAGZD6f79XGx2hzKkNejplDazbq0yiMBdS1Wn/5CBwCusJfToboZjJtieOFq/pRud/0skhjLyMFnTi+Fn3dNaKQK5mi9thpqm+nV+fsU28AvFP+b4DcPz87+X4x/E5eqYHqFB31Br0BiajtCqE7F53U63CnbLPtXWNNS//v2O/ZsRuSCbgIfauE1J2pVLPe7e7YH3HIiRaTW1it6IofTlUViZ9KdEtIbkccZsJJiid9q3jLUESTmfR0kK2X7BcT+eG62dc/speQPuJyjxJnQpWkCRVfNQontc/DG/Kx0dibXxuLb2mKNvxSd9SZE1eXwxvgMG42/iION3BiTr86xBwSuIM7iL9pyEOk+yhfgRJ6WsYRB7Vf+vsHohb7lQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.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,t.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Body"})})}),(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:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"object"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Template created successfully!",\n "result": {\n "objectId": 0,\n "url": "https://exampleurl.com"\n }\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.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:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/bbdfc22d.dc75f692.js b/assets/js/bbdfc22d.dc75f692.js deleted file mode 100644 index 369af332f..000000000 --- a/assets/js/bbdfc22d.dc75f692.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var t=a(85893),l=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),o=a(4667),d=a(9472),u=a(85162);const h={id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOg3IJIGZOWyfhmURQjsaEGG0B4hGTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkDm6xsEoE9DDikKFPnbRBGg0J3ObI2mN25lCQnJ1eXzKhlJl7Vnp0ngXDUjpElpY+mEL+FGOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PfbdGs18mabo/aRU65tqGNJozkKOEajDUDrtmWCllk8lssPDVvsyOzxkIReBpUKzMdJrMnpMgwc7aMaCzoyOfr3FVE4kKTeuesDB2PgIoy8zSKAOSHsOHKxwosCAjoK+Ai0KhAQWR8LKo2AeUQMHSUHPUWTogIPDp1I6zCAJrkQOPiwV2XhZWEUucWGVyRCSiVCeFNIcCwHJCsLSRs3gpJ5CRaoiGiUEU3s51b3FYrGAalTfgz78YbIl2aZGB9SBPgprlUzjo/oPnkpitX+JGT9gGuiFjkIQJHo6/RYfuAuFw8S4QoSuZIPNxw/rqBLwbya82821QuGROZxJnDOhM0YPZiGXfp1S8v1nt9jfd8W64roNU3H4fvP1va7yEKxP+v2lKZ0sxBR7qSnIF4GO5bL2J5wTy67xHTwY/DIthFTRisODyXVHMOKwKBS5aAqudcph7oS1bXVVHGTAwj8HfgOVLmu+Ndc977ziEGRQW6KKoqAydNQe74vQ4sGPxfGFWFxHN9t37jRa5+rdk4qMHXprtK9r9GQwoH87pLdFJsQ8a6JRy9+A/1sNksbWXWvpshjHtl+/+2QwqDgU6L2YPtsDmwi9grl+d6nC66hq8VaOGmQVh9KpX+Noa7mRlK6uwpey1sK+aZKyn719jY6K1Epq/NGm9MfJYPDj9ybPnwaf91N7qWdCySwOhlvi3P8ynZ8Gn9+azi7OUOPcD6GslerZsRWVrryORoEhNzSWrPERugg5JNDfm1JxRDcjKmZ7nVJhba+dHUqMPSW2L6zsz47jFPGYlk6G5ZDiVYekO9w6JGblX0gs9uoIJOSUhpvNgDpvY9QOmL2Z0Y6Mt02BnSHwPK83tP4CU3eI+i10vCHBLV6jl09MDFOTxyuLekiIqQpmx7C/nEnPpI/H7XvqBY12qh3r7QWGDkn+sXfcLjN11ffYvb7XQ1PEZYhWKyX1o0/u9RG7u5pMZCqFYn/j2MuAow9tQObz+V5tHESbCxnycswcWrNRn0ZhLKCu1frLAXAI6Ap/NRmim8m0pZYXrupH5X7TyyKNvYwUdOKRWvRl14hCrmSKRCqbpjq9uP7KPvYGwDvl/wbI/a+XZ+ffhufklRqoTtFxb9AbkIjarhC6c9FZvTB3yjbb3kbWtPT/Fv6eLbwhmYCL0LdKSN2ZWzXr3e0uBiMOOdFicgerFV3x3amqIvFTiW4Jyd2Iw0w4SfGkbxVvGYpoMpOeDrL1Gv5iIj/cNBv9AXsJ6SMu9yhxJlRJmlDxVaNwVvs8uiUfG429+bWxOE1TtOGXuqPOnLi+Gt4Ch3Hzm6CIww2cmNPvEjGHBO7hHuKvHvIQ6T7KV6CEnpZxxEHtl/7+AVe8CCQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",source:"@site/docs/API-docs/createtemplate.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createtemplate",permalink:"/docs/API-docs/createtemplate",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createtemplate",title:"Create template",description:"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.",sidebar_label:"Create template",hide_title:!0,hide_table_of_contents:!0,api:"eJztV0tPIzkQ/iveOg3IJIGZOWyfhmURQjsaEGG0B4hGTnclbXDbxnbnMVH/91W5u5NOAgNIqz0tF5JyVflzPb6qrCCIqYfkDm6xsEoE9DDikKFPnbRBGg0J3ObI2mN25lCQnJ1eXzKhlJl7Vnp0ngXDUjpElpY+mEL+FGOFLLSOOZvnMs2ZRzdDJjwbqxKtkzp4NjGOTVGjE0HqKctMWhZIB3MZcmYdZjiRGjPmgyvTUDr0PfbdGs18mabo/aRU65tqGNJozkKOEajDUDrtmWCllk8lssPDVvsyOzxkIReBpUKzMdJrMnpMgwc7aMaCzoyOfr3FVE4kKTeuesDB2PgIoy8zSKAOSHsOHKxwosCAjoK+Ai0KhAQWR8LKo2AeUQMHSUHPUWTogIPDp1I6zCAJrkQOPiwV2XhZWEUucWGVyRCSiVCeFNIcCwHJCsLSRs3gpJ5CRaoiGiUEU3s51b3FYrGAalTfgz78YbIl2aZGB9SBPgprlUzjo/oPnkpitX+JGT9gGuiFjkIQJHo6/RYfuAuFw8S4QoSuZIPNxw/rqBLwbya82821QuGROZxJnDOhM0YPZiGXfp1S8v1nt9jfd8W64roNU3H4fvP1va7yEKxP+v2lKZ0sxBR7qSnIF4GO5bL2J5wTy67xHTwY/DIthFTRisODyXVHMOKwKBS5aAqudcph7oS1bXVVHGTAwj8HfgOVLmu+Ndc977ziEGRQW6KKoqAydNQe74vQ4sGPxfGFWFxHN9t37jRa5+rdk4qMHXprtK9r9GQwoH87pLdFJsQ8a6JRy9+A/1sNksbWXWvpshjHtl+/+2QwqDgU6L2YPtsDmwi9grl+d6nC66hq8VaOGmQVh9KpX+Noa7mRlK6uwpey1sK+aZKyn719jY6K1Epq/NGm9MfJYPDj9ybPnwaf91N7qWdCySwOhlvi3P8ynZ8Gn9+azi7OUOPcD6GslerZsRWVrryORoEhNzSWrPERugg5JNDfm1JxRDcjKmZ7nVJhba+dHUqMPSW2L6zsz47jFPGYlk6G5ZDiVYekO9w6JGblX0gs9uoIJOSUhpvNgDpvY9QOmL2Z0Y6Mt02BnSHwPK83tP4CU3eI+i10vCHBLV6jl09MDFOTxyuLekiIqQpmx7C/nEnPpI/H7XvqBY12qh3r7QWGDkn+sXfcLjN11ffYvb7XQ1PEZYhWKyX1o0/u9RG7u5pMZCqFYn/j2MuAow9tQObz+V5tHESbCxnycswcWrNRn0ZhLKCu1frLAXAI6Ap/NRmim8m0pZYXrupH5X7TyyKNvYwUdOKRWvRl14hCrmSKRCqbpjq9uP7KPvYGwDvl/wbI/a+XZ+ffhufklRqoTtFxb9AbkIjarhC6c9FZvTB3yjbb3kbWtPT/Fv6eLbwhmYCL0LdKSN2ZWzXr3e0uBiMOOdFicgerFV3x3amqIvFTiW4Jyd2Iw0w4SfGkbxVvGYpoMpOeDrL1Gv5iIj/cNBv9AXsJ6SMu9yhxJlRJmlDxVaNwVvs8uiUfG429+bWxOE1TtOGXuqPOnLi+Gt4Ch3Hzm6CIww2cmNPvEjGHBO7hHuKvHvIQ6T7KV6CEnpZxxEHtl/7+AVe8CCQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get document list by doctype",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Get template by ID",permalink:"/docs/API-docs/get-template"}},g={},b=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",p:"p",strong:"strong",...(0,l.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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Create template"})}),"\n",(0,t.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,t.jsxs)(s.p,{children:["The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique ",(0,t.jsx)(s.strong,{children:"templateId"})," that can be used to generate documents based on the specified template."]}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(s.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.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,t.jsx)(m.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json-schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Body"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"URL",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://yourimage.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"signers",required:!1,schemaName:"signers[]",qualifierMessage:void 0,schema:{type:"array",example:["joe@gmail.com","john@gmail.com"],xml:{name:"signers",wrapped:!0},items:{type:"string",example:"joe@example.com",xml:{name:"signers"},title:"signers"}}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"xjsba1GaxP"}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(u.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Template created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template created successfully!"}}),(0,t.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{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)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.p,{children:"createTemplateResponse"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://exampleurl.com"}})]})]})})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "code": 200,\n "message": "Template created successfully!",\n "result": {\n "objectId": 0,\n "url": "https://exampleurl.com"\n }\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(u.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{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)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,t.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.54a35a79.js b/assets/js/f0ff4a36.54a35a79.js deleted file mode 100644 index 6456966c7..000000000 --- a/assets/js/f0ff4a36.54a35a79.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=a(85893),n=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYhiUNLaYSCSXpBwbgm59kj5an6QYyrJlO2nWRbGXRB7ODL/5+ThTg+MzC/EdnKu0KlE6C+MAMrSpEdoJJSGGS3SMs2ylAAEojYbT4SiDGGboemeaG16iQ0Nea5C8RIhh8ZZr8dapR5QQgCCvOfIMDQRg8GslDGYQO1NhANYtC7KxotQFQgC40IXKEOIpLywppDmWHOIa3FJ7TWeEnEFDqtwbxYRRWjGTg8VisYAmWEPpsE5E1kHR3OWwG7VKHjB1o4ypKUuVdDx1/yfYAKbKlNz1JRv0+tfjJE9Pcp1A04zpWquVtGjJ0UkU0b9tuLZKU7R2WhVsXR4IgJBTYeIauNaFSP1B+GDJqN5H10ZNdTTkxon2ytSHtNaSVZn42q0Rn0RR42FWhXvdXZfbQ9Py4VI8npwm+ZffqNi3whV4qAvrP6ibycWVcgd70AVyi4yaa0OKJoAPqqCGPtDbtUZ5I2by7z//YudGzNG7EocHljunbRyGK0llikGqSvJ2/SQPx/WgkCXo0RA8z+e1B24MXxJ7HJb29XJfeebt3791GzRNAK4tKTgsdcEdTrq7GzpdlAW52SEy9Ow2sp5QyEJInHQcmpxE0eQ9eWwCGEbDfS51byGTyrGpqmT2w3ek0jAaNgGUaC2fvZK254D+W+TDaDg5XUf+bj/ykZzzQmTs7POI3dJr/X0Df/etgfdxuhbnfoOIVqmdOltZ6cvbbFhMKyPc0g+t/rSK78b0AJfocrWadn7KuRxiCLt+C+veWGmA/Jl5NwMrU/T4ybUedMOp4IklloZci3B+DHRTh+SG0tpmbgvPhoRafERi4aszlgIUcqq88SoJ3bvjUzg/3ht/t7mwTFh/3MXm686myrAda5ZwixlTkrkc/SHJTwfHzGpMxXTVMgN2L+/ljSqRVRZpVBVCPtr4Xr5ld9fTqUgFL9gfmFjhcPymy9jT09Nexo68zaVweZUwg1pt1Gde6NPat1r/OIIAHJrSXk9v0MxF2r2eL1wVeuVwRQRaA+IasOSCqroS/bxrRP1WiBSlxV5Hnl1+/sROBxEEvab4Bsjhp9EvF1c3F+SV2qot0fEgGkQk0sq6ksveRbSydVVjyZKNzncLXG9ovb/grTrM4cKFuuDC08cjrletfwc99bi/U40DyJV1pFLX1BdfTNE0JP5aoSGCjQOYcyN4Qo14V0MmLH1n653pRaBvfl+tX0fs+fXsWeAdXySRZc6Lin5BAI+43NkHm3ETdKT5z8hegtFet83SNRpaUFuFszRF7Xpne2/u1nt0eXELAfCKitJ/Gh7907D6oFiezcI2mhYA/SU4zxr8SMT+iMuf1urtyYsG6zW/1aZUjJum+QcuFUDz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocument",title:"Get document by ID",description:"Get a document",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYhiUNLaYSCSXpBwbgm59kj5an6QYyrJlO2nWRbGXRB7ODL/5+ThTg+MzC/EdnKu0KlE6C+MAMrSpEdoJJSGGS3SMs2ylAAEojYbT4SiDGGboemeaG16iQ0Nea5C8RIhh8ZZr8dapR5QQgCCvOfIMDQRg8GslDGYQO1NhANYtC7KxotQFQgC40IXKEOIpLywppDmWHOIa3FJ7TWeEnEFDqtwbxYRRWjGTg8VisYAmWEPpsE5E1kHR3OWwG7VKHjB1o4ypKUuVdDx1/yfYAKbKlNz1JRv0+tfjJE9Pcp1A04zpWquVtGjJ0UkU0b9tuLZKU7R2WhVsXR4IgJBTYeIauNaFSP1B+GDJqN5H10ZNdTTkxon2ytSHtNaSVZn42q0Rn0RR42FWhXvdXZfbQ9Py4VI8npwm+ZffqNi3whV4qAvrP6ibycWVcgd70AVyi4yaa0OKJoAPqqCGPtDbtUZ5I2by7z//YudGzNG7EocHljunbRyGK0llikGqSvJ2/SQPx/WgkCXo0RA8z+e1B24MXxJ7HJb29XJfeebt3791GzRNAK4tKTgsdcEdTrq7GzpdlAW52SEy9Ow2sp5QyEJInHQcmpxE0eQ9eWwCGEbDfS51byGTyrGpqmT2w3ek0jAaNgGUaC2fvZK254D+W+TDaDg5XUf+bj/ykZzzQmTs7POI3dJr/X0Df/etgfdxuhbnfoOIVqmdOltZ6cvbbFhMKyPc0g+t/rSK78b0AJfocrWadn7KuRxiCLt+C+veWGmA/Jl5NwMrU/T4ybUedMOp4IklloZci3B+DHRTh+SG0tpmbgvPhoRafERi4aszlgIUcqq88SoJ3bvjUzg/3ht/t7mwTFh/3MXm686myrAda5ZwixlTkrkc/SHJTwfHzGpMxXTVMgN2L+/ljSqRVRZpVBVCPtr4Xr5ld9fTqUgFL9gfmFjhcPymy9jT09Nexo68zaVweZUwg1pt1Gde6NPat1r/OIIAHJrSXk9v0MxF2r2eL1wVeuVwRQRaA+IasOSCqroS/bxrRP1WiBSlxV5Hnl1+/sROBxEEvab4Bsjhp9EvF1c3F+SV2qot0fEgGkQk0sq6ksveRbSydVVjyZKNzncLXG9ovb/grTrM4cKFuuDC08cjrletfwc99bi/U40DyJV1pFLX1BdfTNE0JP5aoSGCjQOYcyN4Qo14V0MmLH1n653pRaBvfl+tX0fs+fXsWeAdXySRZc6Lin5BAI+43NkHm3ETdKT5z8hegtFet83SNRpaUFuFszRF7Xpne2/u1nt0eXELAfCKitJ/Gh7907D6oFiezcI2mhYA/SU4zxr8SMT+iMuf1urtyYsG6zW/1aZUjJum+QcuFUDz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,n.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 document by ID"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(s.p,{children:"Get a document"}),"\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:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\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)("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)(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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(o.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:"document"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(o.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)(o.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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document not found!"})}),(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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\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.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"message",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 "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/f0ff4a36.5ab2b8c7.js b/assets/js/f0ff4a36.5ab2b8c7.js new file mode 100644 index 000000000..967cf46d2 --- /dev/null +++ b/assets/js/f0ff4a36.5ab2b8c7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),d=a(41429),c=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",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/getdocument",title:"Get document by ID",description:"Get a document",source:"@site/docs/API-docs/getdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocument",permalink:"/docs/API-docs/getdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocument",title:"Get document by ID",description:"Get a document",sidebar_label:"Get document by ID",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vs1u4zYQfhV2ThtAaymJdw9CUTRosqm7i2TRZNFDYgSUNLaYSCSXpBwbgm59kj5an6QYyrLlnzTrothLIpMzw29+vpmpwfGphfgOzlValSidhXEAGdrUCO2EkhDDJTrGWbYUgACURsPpcpRBDFN0vTvNDS/RoSGrNUheIsQwf8u1eOvUE0oIQJDVHHmGBgIw+LUSBjOInakwAOsWBelYUeoCIQCc60JlCPGEF5YE0hxLDnENbqG9pDNCTqEhUe6VYsIorZjKwXw+n0MTrKB0WB9E1kHR3OWw7bVKHjF1o4ypCUuVdDx1/yfYACbKlNz1T9bo9a/HSZ6e5DqBphnTs1YradGSoZMoon+bcG2VpmjtpCrYKj0QACGnxMQ1cK0LkfqL8NGSUr2LrvWa8mjIjBPtk6l3aSUlqzLxuVshPomixsOsCve6uS62h4blw6V4OjlN8i+/UbJvhSvwUBPWf1A1k4kr5Q62oAvkFhkV15oUTQAfVEEFfaC1a43yRkzl33/+xc6NmKE3JQ53LHdO2zgMlyeVKQapKsna9bM8HNejQpagR0PwPJ9XFrgxfEHscVja19N95Zm3+/7Ga9A0Abg2pWuSdm83dDsvCzKzRWTYo7dhTMhCSHzoOPRwEkUP78liE8AwGu5yqeuFTCrHJqqS2Q/fkUrDaNgEUKK1fPpK2PYB/TfPh9Hw4XTl+btdz0dyxguRsbPPI3ZL3fr7Ov7uWx3v43Qtzt0CEa1QO3U2otI/b6NhMa2McAs/tPrTKr4bUwMu0eVqOe38lHM5xBB29RbWvbHSANkzs24GVqbo8ZNrPeiGU8ETSywNuRbh7BjopQ7JDYW1jdwGnjUJtfiIxMJXZyw5KOREeeVlELq+40M4O94Zf7e5sExYf9355vPOJsqwLW2WcIsZU5K5HP0lnZ8OjpnVmIrJsmQG7F7eyxtVIqss0qgqhHyy8b18y+6uJxORCl6wPzCxwuH4TRex5+fnnYgdeZ1L4fIqYQa1WotP/aEPa19r9eMIAnBoSns9uUEzE2nXPV94KvTC4ZIItAbENWDJBWV1efTzthLVWyFSlBZ7FXl2+fkTOx1EEPSK4hsgh59Gv1xc3VyQVSqrNkXHg2gQ0ZFW1pVc9h6ila3LGksWbHS+neB6TevdBW9ZYQ7nLtQFF54+HnG9LP076InH/Z1qHECurCORuqa6+GKKpqHjrxUaItg4gBk3gidUiHc1ZMLSd7bamV4E+ub35fp1xPavZ3uBd3yRRJYZLyr6BQE84WJrH2zGTdCR5j8jewlG+9wmS1doaEFtBc7SFLXr3e303I1+dHlxCwHwipLSbw1PvjUsP8iXvVHYRNMCoL8EZ6/Cj0Tsj7j4aSXe3ryosFrzW2kKxbhpmn8ARVZA9g==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create document",permalink:"/docs/API-docs/createdocument"},next:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"}},g={},f=[{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",p:"p",...(0,l.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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document by ID"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,n.jsx)(s.p,{children:"Get a document"}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 200,\n "result": {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Document not found!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 404,\n "message": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(c.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.4b77d0d7.js b/assets/js/fa40969b.f555cec9.js similarity index 70% rename from assets/js/fa40969b.4b77d0d7.js rename to assets/js/fa40969b.f555cec9.js index 4ca8d7f4c..8cf6297d4 100644 --- a/assets/js/fa40969b.4b77d0d7.js +++ b/assets/js/fa40969b.f555cec9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>f,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtbR2lKJYFEXTxDHcBLFhO+jBFgxqd6RlzCUZkitLEPbWJ+mj9UmK4f5oZdmJHaQ55WKvhpzh/HzztwLPZw6SC3it07JA5R2MI8jQpVYYL7SCBJ48ecLaY3a+NOiSS3WK3gqcI+NMCueZnrKsFcEm3GHGtGJ+afBSXaq9AdvZeW351HeSXLKzc6kYY2x3TWM+555xiywtrUXl5ZIJxbLA6Tz3pRuQvH2SdyZmivvSIjvFTyW6z4m0+KkUFpnPkS11aZlrmYO85yTvSO2eWD2z6NxXaWka5iBxRBJf6cJI9Jg9RF7O58gmiIq5Mk3RuWkp5ZKlnYwb4XPGpWyNydZG1G++oDcPFiacPfRFbO5zlQWTlGZSqxlaxoMWYiJrH/0cYoipFOqxBmUt12QZIlA6tINLBRFog5YTzo4ySGCGvgURgQoiMNzyAj1aAukKFC8QEsh0SsiCCAQB1HCfw23UnucY4LeJTK+ZbZALEbSOhMTbEiNwfilJvhPkc4gAF0bqDCGZcunoQppjwSFZQXg/AeetUDO6qcqC8ihAtXsPIuhiZGuQBqVbqPQvdoHu0Zrg9CitK9fpWlVR55jFLjdi1+trVK1zcuQZ2m9pbEVXeWBKKICKTBwsFosFVOP6HXT+D50tiTfVyqPy9MmNkSIN4R5+dBSl1fYjevIR0xB6S+DwAh2dSlEI37umymISzJpqW3Dfp3TK7cVVBO5amEfyxVUVwaKQxNY4luA4IYuqCLzwcpNWEYNFZ7Rytbr7cUz/NiG5zmvW4T4E/pt4KA2x2za0M2s/jms1S9n3JLeWLwktHgv35WdqMqXrdhJ0Pl2nRQeUN4fiev/5JP/wJ/nwvPbh40S48EHZTCLea/9oCUYidxjqZlcUSNYbLSlJHint2KCiJvTv3/+w11bMMYgSjzcs9964ZDhsKKWVg1QXJO34Rj1er4861F3iJ/VC8fzacL8P+L+j3vVfg6qXFh4LI7nHq/btajud+r5v+da0vjShqNxdtcl1tR/HV780GTeKR9tJdopGW8+U9ozPuZB8IvGn75hlo3hURVCgc3z2Bc/drernrB/Fo6tRZ/2LbeuP1JxLkbGXJ0fsnNrA9zX9xUNN7+vpaz23USLqS3U72/BKn157w2FaWuGXYUzot8HkYkxdqUCfa5oxjG4GC59DAsP+vDFcNYNFRX0b7bwdO0ore1nKjRm0bU/yiaNcHXIjhvO90ABbVc7Ir7XrNhRap6IRb5Fy8YvdmyykcJ2ue+tB68uuN+7FbbejOi/UVIe3Gqe1xSq4fL53x7wkHBMuHLdOCThhU23ZLe7ehJ9jOCT688EecwZTMW0gNmA0OJ7pIox81PekUNe0Puyyi+PpVKSCS/YXTpzwOH7aOvjm5mbLwc8Cz6HweTlhFo1eX58FYohCn6v78Qwi8GgLdzw9QzsXaVty73lqGC4Pm8ThaUgcLLggEDSk328zET6lSFE57CH45eHJO/Z8EEPUw9ADVB6+O3p18P7sgKQSCusQ7Q3iQUwkwnDBVe+hQ/Rd1OqFbLJk6zF5I9S9mezHbvdjt/vfdrumynlc+KGRXIQaHtJg1ZTfC7i17iUtZMcR5FSokwtYrQhyH6ysKiJ/KtFSlR9HMOdWUM8MNToTjr6zbn25F/NPTxsfP2MPWRLvNKOt4IrK95zLkn5BBNe47O2n1biK2hL+1Trep0L91GbP6DShnbC+8KqWuXteV4L2xtYgsOZ4maZo/Gfv9hvqyfHZOUQwafa9IkwJYPkN7Zz8BhK4hEsIuz5JCP0w0FcguZqVYVaAWi71OV4SNPpN8jo0yeaD/Hin9zc9UZtCf8mwOxl+pZ71Fpe/ddfrk3sZulW6vk1hGFdV9R930J/8",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV81uGzcQfhV2ckmMtbR2lKJYFEXTxDHcBLFhO+jBFgxqd6RlzCUZkitLEPbWJ+mj9UmK4f5oZdmJHaQ55WKvhpzh/HzztwLPZw6SC3it07JA5R2MI8jQpVYYL7SCBJ48ecLaY3a+NOiSS3WK3gqcI+NMCueZnrKsFcEm3GHGtGJ+afBSXaq9AdvZeW351HeSXLKzc6kYY2x3TWM+555xiywtrUXl5ZIJxbLA6Tz3pRuQvH2SdyZmivvSIjvFTyW6z4m0+KkUFpnPkS11aZlrmYO85yTvSO2eWD2z6NxXaWka5iBxRBJf6cJI9Jg9RF7O58gmiIq5Mk3RuWkp5ZKlnYwb4XPGpWyNydZG1G++oDcPFiacPfRFbO5zlQWTlGZSqxlaxoMWYiJrH/0cYoipFOqxBmUt12QZIlA6tINLBRFog5YTzo4ySGCGvgURgQoiMNzyAj1aAukKFC8QEsh0SsiCCAQB1HCfw23UnucY4LeJTK+ZbZALEbSOhMTbEiNwfilJvhPkc4gAF0bqDCGZcunoQppjwSFZQXg/AeetUDO6qcqC8ihAtXsPIuhiZGuQBqVbqPQvdoHu0Zrg9CitK9fpWlVR55jFLjdi1+trVK1zcuQZ2m9pbEVXeWBKKICKTBwsFosFVOP6HXT+D50tiTfVyqPy9MmNkSIN4R5+dBSl1fYjevIR0xB6S+DwAh2dSlEI37umymISzJpqW3Dfp3TK7cVVBO5amEfyxVUVwaKQxNY4luA4IYuqCLzwcpNWEYNFZ7Rytbr7cUz/NiG5zmvW4T4E/pt4KA2x2za0M2s/jms1S9n3JLeWLwktHgv35WdqMqXrdhJ0Pl2nRQeUN4fiev/5JP/wJ/nwvPbh40S48EHZTCLea/9oCUYidxjqZlcUSNYbLSlJHint2KCiJvTv3/+w11bMMYgSjzcs9964ZDhsKKWVg1QXJO34Rj1er4861F3iJ/VC8fzacL8P+L+j3vVfg6qXFh4LI7nHq/btajud+r5v+da0vjShqNxdtcl1tR/HV780GTeKR9tJdopGW8+U9ozPuZB8IvGn75hlo3hURVCgc3z2Bc/drernrB/Fo6tRZ/2LbeuP1JxLkbGXJ0fsnNrA9zX9xUNN7+vpaz23USLqS3U72/BKn157w2FaWuGXYUzot8HkYkxdqUCfa5oxjG4GC59DAsP+vDFcNYNFRX0b7bwdO0ore1nKjRm0bU/yiaNcHXIjhvO90ABbVc7Ir7XrNhRap6IRb5Fy8YvdmyykcJ2ue+tB68uuN+7FbbejOi/UVIe3Gqe1xSq4fL53x7wkHBMuHLdOCThhU23ZLe7ehJ9jOCT688EecwZTMW0gNmA0OJ7pIox81PekUNe0Puyyi+PpVKSCS/YXTpzwOH7aOvjm5mbLwc8Cz6HweTlhFo1eX58FYohCn6v78Qwi8GgLdzw9QzsXaVty73lqGC4Pm8ThaUgcLLggEDSk328zET6lSFE57CH45eHJO/Z8EEPUw9ADVB6+O3p18P7sgKQSCusQ7Q3iQUwkwnDBVe+hQ/Rd1OqFbLJk6zF5I9S9mezHbvdjt/vfdrumynlc+KGRXIQaHtJg1ZTfC7i17iUtZMcR5FSokwtYrQhyH6ysKiJ/KtFSlR9HMOdWUM8MNToTjr6zbn25F/NPTxsfP2MPWRLvNKOt4IrK95zLkn5BBNe47O2n1biK2hL+1Trep0L91GbP6DShnbC+8KqWuXteV4L2xtYgsOZ4maZo/Gfv9hvqyfHZOUQwafa9IkwJYPkN7Zz8BhK4hEsIuz5JCP0w0FcguZqVYVaAWi71OV4SNPpN8jo0yeaD/Hin9zc9UZtCf8mwOxl+pZ71Fpe/ddfrk3sZulW6vk1hGFdV9R930J/8",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function b(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,n.jsx)(r(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var n=a(85893),l=a(11151),i=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),c=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tuGzcQ/RV28pIYa2lty0WxKIqmiWO4CWLDdtAHSzCo3ZGWMZfckFxdIOxbv6Sf1i8phnvRyrITK0jzlBd7NZwZzuXMhStwfGohuoHXOi4yVM7CKIAEbWxE7oRWEMGzZ89Yc8yulznaaKgu0RmBM2ScSWEd0xOWNCrYmFtMmFbMLXMcqqE66LG9vdeGT1yryUZ7e0PFGGP7axpzKXeMG2RxYQwqJ5dMKJZ4Seu4K2yP9B2SvisxVdwVBtklfirQfk6lwU+FMMhcimypC8NsI+z1HZG+M7V/YfTUoLVfZWVeC3uNA9L4Sme5RIfJU/SlfIZsjKiYLeIYrZ0UUi5Z3OqYC5cyLmXjTLJ2orrzmO48WeT+7Kk3Ys3PVeJdUppJraZoGPdWiLGsYvSzzyHGUqhdHUoaqfHSZ6CwaHpDBQHoHA0nnJ0lEMEUXQMiAhUEkHPDM3RoCKQrUDxDiCDRMSELAhAE0Jy7FO6j9jpFD79NZDrNTI1cCKAJJETOFBiAdUtJ+q2gmEMAuMilThCiCZeWGOIUMw7RCvz9EVhnhJoSpyoyqiMP1fY+CKDNkalA6o1uoNJlbBPdodXJ6VCaUK7LtSyDNjCLfZ6LfafvUDXBSZEnaL6lsyWxci8UUQIVudhbLBYLKEfVPWjdHzpZkmyslUPl6JPnuRSxT3f/o6UsrbYv0eOPGPvUGwKHE2jpVIpMuA6bKrKxd2uiTcZdl9IadxCWAdg7ke8oF5ZlAItMklgdWILjmDwqA3DCyU1aSQIGba6Vrcw9DEP6twnJdV2zFvc+8d8kQrHP3bajrVuHYViZWchuJLkxfElocZjZL19Tkalct4ugjem6LFqgvDkVd4dH4/TDnxTD6yqGu6mw/oOqmVS8125nDblEbtH3zbYpkK43WlKR7KjtPEdFQ+jfv/9hr42YoVcldncsdS63Ub9fUwoje7HOSNv5XO1u10ft+y7Jk3m+eX5tut97/D/Q77q3Qdkpiyaut83d5XY5dWN/X67ib6hCUbu7bYrr9jAMb3+pK24QDraL7BJzbRxT2jE+40LyscSfvmOVDcJBGUCG1vLpFyL3sKmf834QDm4HrffH296fqRmXImEvL87YNY2B7+v68VNd79rpKju3USIqpmqcbUSlS6+iYTEujHBLvyZ0x2B0M6KplKFLNe0Yua4XC5dCBP3uvtFf1YtFSXMbzaxZOwojO1XK87zXjD3Jx5Zqtc9z0Z8d+AHYmHJFca1Ct2HQuhRz8RapFr84vclDStfleraeNLFsZ+NB2Ew76vNCTbS/qw5a06x8yGcHD+xLwjJh/XETFI8TNtGG3ZPubPgp+kOiH/UOmM0xFpMaYj1Gi+OVzvzKR3NPCnVHz4d9dnM+mYhYcMn+wrEVDkfPmwDP5/OtAL/wMqfCpcWYGcz1mn3qiT4LXan2xwsIwKHJ7PnkCs1MxE3LfeSqvmfu14XDY184mHFBIKhJv98XInxKEaOy2EHwy9OLd+yoF0LQwdATTO6/O3t18v7qhLQSCqsUHfTCXkgkwnDGVeeiU3Rt1qoH2XjJ1mvyRqo7O9mPt92Pt93/9raru5zDhevnkgvfw30ZrOr2ewP3nntRA9lRACk16ugGViuC3Acjy5LInwo01OVHAcy4ETQzfY9OhKXvpH2+PIr555d1jF+wpzwSH3Sj6eCK2veMy4J+QQB3uOy8T8tRGTQt/KttfMyE6qrNmdFaQm/CiuFVpXP/uuoEDcfWIrCWeBnHmLvP8nYH6sX51TUEMK7fe5nfEsDwOb05+RwiGMIQ/FufNPh56OkrkFxNC78rQKWX5hwvCBrdIXnnh2T9QXF8MPqbkahcob/k2IMCv9LMeovL31r26uRRgfYpXXFTGkZlWf4HmEGf/w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get document list by doctype",description:"### Document Types:",sidebar_label:"Get document list by doctype",hide_title:!0,hide_table_of_contents:!0,api:"eJztV9tuGzcQ/RV28pIYa2lty0WxKIqmiWO4CWLDdtAHSzCo3ZGWMZfckFxdIOxbv6Sf1i8phnvRyrITK0jzlBd7NZwZzuXMhStwfGohuoHXOi4yVM7CKIAEbWxE7oRWEMGzZ89Yc8yulznaaKgu0RmBM2ScSWEd0xOWNCrYmFtMmFbMLXMcqqE66LG9vdeGT1yryUZ7e0PFGGP7axpzKXeMG2RxYQwqJ5dMKJZ4Seu4K2yP9B2SvisxVdwVBtklfirQfk6lwU+FMMhcimypC8NsI+z1HZG+M7V/YfTUoLVfZWVeC3uNA9L4Sme5RIfJU/SlfIZsjKiYLeIYrZ0UUi5Z3OqYC5cyLmXjTLJ2orrzmO48WeT+7Kk3Ys3PVeJdUppJraZoGPdWiLGsYvSzzyHGUqhdHUoaqfHSZ6CwaHpDBQHoHA0nnJ0lEMEUXQMiAhUEkHPDM3RoCKQrUDxDiCDRMSELAhAE0Jy7FO6j9jpFD79NZDrNTI1cCKAJJETOFBiAdUtJ+q2gmEMAuMilThCiCZeWGOIUMw7RCvz9EVhnhJoSpyoyqiMP1fY+CKDNkalA6o1uoNJlbBPdodXJ6VCaUK7LtSyDNjCLfZ6LfafvUDXBSZEnaL6lsyWxci8UUQIVudhbLBYLKEfVPWjdHzpZkmyslUPl6JPnuRSxT3f/o6UsrbYv0eOPGPvUGwKHE2jpVIpMuA6bKrKxd2uiTcZdl9IadxCWAdg7ke8oF5ZlAItMklgdWILjmDwqA3DCyU1aSQIGba6Vrcw9DEP6twnJdV2zFvc+8d8kQrHP3bajrVuHYViZWchuJLkxfElocZjZL19Tkalct4ugjem6LFqgvDkVd4dH4/TDnxTD6yqGu6mw/oOqmVS8125nDblEbtH3zbYpkK43WlKR7KjtPEdFQ+jfv/9hr42YoVcldncsdS63Ub9fUwoje7HOSNv5XO1u10ft+y7Jk3m+eX5tut97/D/Q77q3Qdkpiyaut83d5XY5dWN/X67ib6hCUbu7bYrr9jAMb3+pK24QDraL7BJzbRxT2jE+40LyscSfvmOVDcJBGUCG1vLpFyL3sKmf834QDm4HrffH296fqRmXImEvL87YNY2B7+v68VNd79rpKju3USIqpmqcbUSlS6+iYTEujHBLvyZ0x2B0M6KplKFLNe0Yua4XC5dCBP3uvtFf1YtFSXMbzaxZOwojO1XK87zXjD3Jx5Zqtc9z0Z8d+AHYmHJFca1Ct2HQuhRz8RapFr84vclDStfleraeNLFsZ+NB2Ew76vNCTbS/qw5a06x8yGcHD+xLwjJh/XETFI8TNtGG3ZPubPgp+kOiH/UOmM0xFpMaYj1Gi+OVzvzKR3NPCnVHz4d9dnM+mYhYcMn+wrEVDkfPmwDP5/OtAL/wMqfCpcWYGcz1mn3qiT4LXan2xwsIwKHJ7PnkCs1MxE3LfeSqvmfu14XDY184mHFBIKhJv98XInxKEaOy2EHwy9OLd+yoF0LQwdATTO6/O3t18v7qhLQSCqsUHfTCXkgkwnDGVeeiU3Rt1qoH2XjJ1mvyRqo7O9mPt92Pt93/9raru5zDhevnkgvfw30ZrOr2ewP3nntRA9lRACk16ugGViuC3Acjy5LInwo01OVHAcy4ETQzfY9OhKXvpH2+PIr555d1jF+wpzwSH3Sj6eCK2veMy4J+QQB3uOy8T8tRGTQt/KttfMyE6qrNmdFaQm/CiuFVpXP/uuoEDcfWIrCWeBnHmLvP8nYH6sX51TUEMK7fe5nfEsDwOb05+RwiGMIQ/FufNPh56OkrkFxNC78rQKWX5hwvCBrdIXnnh2T9QXF8MPqbkahcob/k2IMCv9LMeovL31r26uRRgfYpXXFTGkZlWf4HmEGf/w==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete document by ID",permalink:"/docs/API-docs/deletedocument"},next:{title:"Create template",permalink:"/docs/API-docs/createtemplate"}},f={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.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,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,n.jsx)(t(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Header Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.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,n.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,n.jsx)(s.p,{children:"Body"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 200,\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ]\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:404}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 404,\n "message": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.316c4feb.js b/assets/js/runtime~main.93e16c68.js similarity index 62% rename from assets/js/runtime~main.316c4feb.js rename to assets/js/runtime~main.93e16c68.js index 2ce7b6222..ee8d380f9 100644 --- a/assets/js/runtime~main.316c4feb.js +++ b/assets/js/runtime~main.93e16c68.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,d,c,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var d=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(d.exports,d,d.exports,r),d.loaded=!0,d.exports}r.m=b,r.c=t,e=[],r.O=(a,d,c,f)=>{if(!d){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](d[o])))?d.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[d,c,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},d=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,d({}),d([]),d(d)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=d(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var d in a)r.o(a,d)&&!r.o(e,d)&&Object.defineProperty(e,d,{enumerable:!0,get:a[d]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,d)=>(r.f[d](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"4b77d0d7",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"54a35a79",1359:"49fdcec2",1477:"b31b2642",1520:"a106d1ce",1531:"dc75f692",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"f4361f8a",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"b4037d80",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"56636457",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"b9986137",7971:"e89d4ca1",8106:"fc47c37f",8140:"901b2f91",8163:"8057ae9d",8468:"0d9e94c0",8475:"d27b3009",8489:"04f4277f",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5a3fe832",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},f="OpenSign-Docs:",r.l=(e,a,d,b)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==d)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(d))),a)return a(d)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,d)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)d.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((d,f)=>c=e[a]=[d,f]));d.push(c[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(d=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var f=d&&("load"===d.type?"missing":d.type),b=d&&d.target&&d.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,d)=>{var c,f,b=d[0],t=d[1],o=d[2],n=0;if(b.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(d);n{"use strict";var e,a,c,d,f,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,r.c=t,e=[],r.O=(a,c,d,f)=>{if(!c){var b=1/0;for(i=0;i=f)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[c,d,f]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,d){if(1&d&&(e=this(e)),8&d)return e;if("object"==typeof e&&e){if(4&d&&e.__esModule)return e;if(16&d&&"function"==typeof e.then)return e}var f=Object.create(null);r.r(f);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&d&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(f,b),f},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",119:"ac608ad7",230:"d91ad230",273:"fa40969b",292:"1d835c2e",453:"30a24c52",533:"b2b675dd",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1359:"f0349969",1477:"b2f554cd",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2535:"814f3328",2832:"1f73ca32",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",4013:"01a85c17",4195:"c4f5d8e4",4258:"b5b81866",4368:"a94703ab",4478:"d1393a72",4651:"05632a52",4955:"e226bb09",5507:"8320e026",5900:"38e3d9c8",6103:"ccc49370",6177:"611db08b",6261:"3dbb8da8",6543:"17e5210b",6586:"976116a8",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7336:"d6096017",7414:"393be207",7429:"debc6b9f",7608:"ca7b15b9",7729:"3532e686",7894:"a88a3db3",7971:"8a725248",8106:"377084eb",8163:"5a2de241",8468:"52d5c0f9",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8892:"38ec836e",9003:"925b3f96",9035:"4c9e35b1",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"d8fb2ce8",110:"ab20026d",119:"da728717",230:"f1caf6f2",273:"f555cec9",292:"f4c59cb7",453:"61f3e45f",533:"2d5f5b1d",841:"b9d70538",853:"3d363c27",948:"b2da1fd1",1332:"5ab2b8c7",1359:"49fdcec2",1477:"b31b2642",1520:"c48a19a9",1531:"0130c100",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2245:"f4361f8a",2267:"a4846e2b",2362:"ebdb1814",2529:"2079a565",2535:"f3b6b0ab",2832:"b4037d80",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",4013:"e5e25f55",4195:"1659087e",4258:"2f2f6e9d",4311:"86f3bfc6",4368:"7d12b1da",4478:"cf430417",4651:"56636457",4682:"18721add",4955:"d23a608f",5507:"36c41078",5900:"a995c609",6103:"ebc8482f",6177:"b0d3e9d2",6261:"7cefc749",6543:"951fd832",6586:"838adce6",6759:"c81d0e01",6938:"d44251bf",7100:"c3706b41",7178:"9a58922d",7336:"a736ced8",7414:"8d31e6a7",7429:"7a5a40a6",7608:"18f42e4e",7729:"2130c9d6",7894:"b9986137",7971:"e89d4ca1",8106:"96975bf8",8140:"901b2f91",8163:"8057ae9d",8468:"0d9e94c0",8475:"d27b3009",8489:"04f4277f",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8892:"8d297d45",9003:"1e8e0783",9035:"37598b09",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"5a3fe832",9700:"ad032cc8",9817:"424c677a"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),d={},f="OpenSign-Docs:",r.l=(e,a,c,b)=>{if(d[e])d[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var f=d[e];if(delete d[e],t.parentNode&&t.parentNode.removeChild(t),f&&f.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",ac608ad7:"119",d91ad230:"230",fa40969b:"273","1d835c2e":"292","30a24c52":"453",b2b675dd:"533",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f0349969:"1359",b2f554cd:"1477","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",a2bc1463:"2245",e273c56f:"2362","814f3328":"2535","1f73ca32":"2832","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608","01a85c17":"4013",c4f5d8e4:"4195",b5b81866:"4258",a94703ab:"4368",d1393a72:"4478","05632a52":"4651",e226bb09:"4955","8320e026":"5507","38e3d9c8":"5900",ccc49370:"6103","611db08b":"6177","3dbb8da8":"6261","17e5210b":"6543","976116a8":"6586",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178",d6096017:"7336","393be207":"7414",debc6b9f:"7429",ca7b15b9:"7608","3532e686":"7729",a88a3db3:"7894","8a725248":"7971","377084eb":"8106","5a2de241":"8163","52d5c0f9":"8468","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","38ec836e":"8892","925b3f96":"9003","4c9e35b1":"9035","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var d=r.o(e,a)?e[a]:void 0;if(0!==d)if(d)c.push(d[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((c,f)=>d=e[a]=[c,f]));c.push(d[2]=f);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(d=e[a])&&(e[a]=void 0),d)){var f=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+f+": "+b+")",t.name="ChunkLoadError",t.type=f,t.request=b,d[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var d,f,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(d in t)r.o(t,d)&&(r.m[d]=t[d]);if(o)var i=o(r)}for(a&&a(c);n Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 3ec9ed326..ecdedddf8 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,7 +5,7 @@ First Blog Post | OpenSign™ - + diff --git a/blog/index.html b/blog/index.html index dc32b32e3..091ed0435 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | OpenSign™ - + diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index a5877aa70..5868247d9 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,7 +5,7 @@ Long Blog Post | OpenSign™ - + diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 9f709e8ac..27bb6bced 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,7 +5,7 @@ MDX Blog Post | OpenSign™ - + diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index 692193ccc..b3b137e1c 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,7 +5,7 @@ 4 posts tagged with "docusaurus" | OpenSign™ - + diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index b7f0b99ab..43f65fc86 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,7 +5,7 @@ One post tagged with "facebook" | OpenSign™ - + diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index b5d8d2b80..a1d823351 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,7 +5,7 @@ 2 posts tagged with "hello" | OpenSign™ - + diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index e4afb9e18..b34364b4f 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,7 +5,7 @@ One post tagged with "hola" | OpenSign™ - + diff --git a/blog/tags/index.html b/blog/tags/index.html index e8b979d2b..9d71adb38 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | OpenSign™ - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 65c4d0d0e..e4fc3e831 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | OpenSign™ - + diff --git a/docs/API-docs/contactlist/index.html b/docs/API-docs/contactlist/index.html index 42927d5ac..b5e0ebb3a 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get contact list | OpenSign™ - + diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index bef378119..6bfe99c00 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create contact | OpenSign™ - + diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 272ea0537..d1e81d5e5 100644 --- a/docs/API-docs/createdocument/index.html +++ b/docs/API-docs/createdocument/index.html @@ -5,7 +5,7 @@ Create document | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 076409675..e70571964 100644 --- a/docs/API-docs/createtemplate/index.html +++ b/docs/API-docs/createtemplate/index.html @@ -5,7 +5,7 @@ Create template | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    Name string
    Note string
    Description string
    URL string
    signers signers[]
    folderId string
-

Responses​

Template created successfully!

Schema

    code number
    message string

    result

    createTemplateResponse

    objectId number
    url string
Loading...
+

Responses​

Template created successfully!

Schema

    code number
    message string

    result

    object

    objectId number
    url string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 15b37ee71..205284a13 100644 --- a/docs/API-docs/delete-template/index.html +++ b/docs/API-docs/delete-template/index.html @@ -5,7 +5,7 @@ Delete template by ID | OpenSign™ - + diff --git a/docs/API-docs/deletecontact/index.html b/docs/API-docs/deletecontact/index.html index 808dc7c9c..eb0c41d3a 100644 --- a/docs/API-docs/deletecontact/index.html +++ b/docs/API-docs/deletecontact/index.html @@ -5,7 +5,7 @@ Deletes contact | OpenSign™ - + diff --git a/docs/API-docs/deletedocument/index.html b/docs/API-docs/deletedocument/index.html index b30d25e35..e74edca8b 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete document by ID | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 6135c17dd..3b676f31d 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get template by ID | OpenSign™ - + @@ -14,6 +14,6 @@

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx
-

Responses​

successful operation

Schema

    code number

    result

    createtemplate

    Name string
    Note string
    Description string
    URL string
    signers signers[]
    folderId string
Loading...
+

Responses​

successful operation

Schema

    code number

    result

    template

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index 781cbfe6f..3faf20c15 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 9405e5a04..600478e1d 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get contact | OpenSign™ - + diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index d684ebc44..bb364ece5 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get document by ID | OpenSign™ - + diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index 53c1edcd4..cfb13f471 100644 --- a/docs/API-docs/getdocumentlist/index.html +++ b/docs/API-docs/getdocumentlist/index.html @@ -5,7 +5,7 @@ Get document list by doctype | OpenSign™ - + diff --git a/docs/API-docs/gettemplatelist/index.html b/docs/API-docs/gettemplatelist/index.html index d5acb8d60..fdbcf8572 100644 --- a/docs/API-docs/gettemplatelist/index.html +++ b/docs/API-docs/gettemplatelist/index.html @@ -5,7 +5,7 @@ Get template list | OpenSign™ - + @@ -15,6 +15,6 @@

Request​

Header Parameters

    x-api-token stringrequired
    Example: opensign.xxxx

Body

    limit number
    skip number
-

Responses​

successful operation

Schema

    code number

    result

    template[]

  • Array [

    • objectId string
    File string
    Name string
    Note string
    Description string
    Folder string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • CreateBy string

  • ]

Loading...
+

Responses​

successful operation

Schema

    code number

    result

    template[]

  • Array [

    • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index 57a5d7dff..68f075689 100644 --- a/docs/API-docs/intro/index.html +++ b/docs/API-docs/intro/index.html @@ -5,7 +5,7 @@ Overview | OpenSign™ - + diff --git a/docs/API-docs/opensign-api-v-1/index.html b/docs/API-docs/opensign-api-v-1/index.html index ae6ea9aed..6ab4571e2 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/update-template/index.html b/docs/API-docs/update-template/index.html index 5c375ec99..5aeb8d1b9 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update template by ID | OpenSign™ - + diff --git a/docs/category/tutorial---basics/index.html b/docs/category/tutorial---basics/index.html index adba6ad19..be0d3a78d 100644 --- a/docs/category/tutorial---basics/index.html +++ b/docs/category/tutorial---basics/index.html @@ -5,7 +5,7 @@ Tutorial - Basics | OpenSign™ - + diff --git a/docs/category/tutorial---extras/index.html b/docs/category/tutorial---extras/index.html index 395889073..9bfead7fa 100644 --- a/docs/category/tutorial---extras/index.html +++ b/docs/category/tutorial---extras/index.html @@ -5,7 +5,7 @@ Tutorial - Extras | OpenSign™ - + diff --git a/docs/contribute/CODE_OF_CONDUCT/index.html b/docs/contribute/CODE_OF_CONDUCT/index.html index 3ecf06b8f..35bbc47ed 100644 --- a/docs/contribute/CODE_OF_CONDUCT/index.html +++ b/docs/contribute/CODE_OF_CONDUCT/index.html @@ -5,7 +5,7 @@ Code of conduct | OpenSign™ - + diff --git a/docs/contribute/COMMUNITY/index.html b/docs/contribute/COMMUNITY/index.html index aa4beba40..3d0852b06 100644 --- a/docs/contribute/COMMUNITY/index.html +++ b/docs/contribute/COMMUNITY/index.html @@ -5,7 +5,7 @@ COMMUNITY | OpenSign™ - + diff --git a/docs/contribute/INSTALLATION/index.html b/docs/contribute/INSTALLATION/index.html index 4235a2564..627f2e371 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATION | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 730ef6cc6..4ebd2f41e 100644 --- a/docs/contribute/REPORTING_GUIDELINES/index.html +++ b/docs/contribute/REPORTING_GUIDELINES/index.html @@ -5,7 +5,7 @@ REPORTING_GUIDELINES | OpenSign™ - + diff --git a/docs/contribute/intro/index.html b/docs/contribute/intro/index.html index 7771e5fa6..e89ea547b 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 7e733127d..223a8b037 100644 --- a/docs/help/New-Document/request-signatures/index.html +++ b/docs/help/New-Document/request-signatures/index.html @@ -5,7 +5,7 @@ Request signatures | OpenSign™ - + diff --git a/docs/help/New-Document/sign-yourself/index.html b/docs/help/New-Document/sign-yourself/index.html index c1bf879ba..b0782c2e0 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign yourself | OpenSign™ - + diff --git a/docs/help/intro/index.html b/docs/help/intro/index.html index 90e14b745..434fc74af 100644 --- a/docs/help/intro/index.html +++ b/docs/help/intro/index.html @@ -5,7 +5,7 @@ Intro | OpenSign™ - + diff --git a/docs/intro/index.html b/docs/intro/index.html index b62948a04..20b6106a0 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index f8fbe0a16..c44e3aa31 100644 --- a/docs/self-host/intro/index.html +++ b/docs/self-host/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/congratulations/index.html b/docs/self-host/tutorial-basics/congratulations/index.html index 2c25a97e0..55695116a 100644 --- a/docs/self-host/tutorial-basics/congratulations/index.html +++ b/docs/self-host/tutorial-basics/congratulations/index.html @@ -5,7 +5,7 @@ Congratulations! | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-blog-post/index.html b/docs/self-host/tutorial-basics/create-a-blog-post/index.html index f6da011e5..9c9c6c4e8 100644 --- a/docs/self-host/tutorial-basics/create-a-blog-post/index.html +++ b/docs/self-host/tutorial-basics/create-a-blog-post/index.html @@ -5,7 +5,7 @@ Create a Blog Post | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-document/index.html b/docs/self-host/tutorial-basics/create-a-document/index.html index a6a8fc778..2c954a604 100644 --- a/docs/self-host/tutorial-basics/create-a-document/index.html +++ b/docs/self-host/tutorial-basics/create-a-document/index.html @@ -5,7 +5,7 @@ Create a Document | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/create-a-page/index.html b/docs/self-host/tutorial-basics/create-a-page/index.html index 269a7b66f..f9f3e98d1 100644 --- a/docs/self-host/tutorial-basics/create-a-page/index.html +++ b/docs/self-host/tutorial-basics/create-a-page/index.html @@ -5,7 +5,7 @@ Create a Page | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/deploy-your-site/index.html b/docs/self-host/tutorial-basics/deploy-your-site/index.html index 04858187f..8939748f4 100644 --- a/docs/self-host/tutorial-basics/deploy-your-site/index.html +++ b/docs/self-host/tutorial-basics/deploy-your-site/index.html @@ -5,7 +5,7 @@ Deploy your site | OpenSign™ - + diff --git a/docs/self-host/tutorial-basics/markdown-features/index.html b/docs/self-host/tutorial-basics/markdown-features/index.html index 43e1a9ca5..8f1d9371a 100644 --- a/docs/self-host/tutorial-basics/markdown-features/index.html +++ b/docs/self-host/tutorial-basics/markdown-features/index.html @@ -5,7 +5,7 @@ Markdown Features | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/manage-docs-versions/index.html b/docs/self-host/tutorial-extras/manage-docs-versions/index.html index af955dcd9..18da28fbf 100644 --- a/docs/self-host/tutorial-extras/manage-docs-versions/index.html +++ b/docs/self-host/tutorial-extras/manage-docs-versions/index.html @@ -5,7 +5,7 @@ Manage Docs Versions | OpenSign™ - + diff --git a/docs/self-host/tutorial-extras/translate-your-site/index.html b/docs/self-host/tutorial-extras/translate-your-site/index.html index a23792248..42be6c3d8 100644 --- a/docs/self-host/tutorial-extras/translate-your-site/index.html +++ b/docs/self-host/tutorial-extras/translate-your-site/index.html @@ -5,7 +5,7 @@ Translate your site | OpenSign™ - + diff --git a/index.html b/index.html index 166067e3f..83c86133c 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 6fe6256aa..4d1afd3a7 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +