WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-02 13:38:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
fda95286f00a9425ce8ecacff55c4be1156769a8
OpenSign/assets/js/fa40969b.adc233e1.js
T

1 line
16 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var a=n(85893),l=n(11151),i=n(58219),t=(n(62316),n(51039)),r=n.n(t),c=(n(82723),n(9487)),d=n(41429),m=n(5397),o=n(4667),p=n(9472),h=n(85162);const x={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:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmSlBPB0N2eZI+2JxkOJcpy7HRJsfWqN4lFnt/vfDw8XFLH5pYml/S1SssCpLN0EtEMbGq4dlxJmtBnz56RsE0uKg02uZJn4AyHBRBGBLeOqBnJggkyZRYyoiRxlYYreSXHQ7Kz89qwmess2WRn50oSQshgtUZczhxhBkhaGgPSiYpwSTKvaR1zpR2ivV20d87nkrnSADmDzyXYL5k08LnkBojLgVSqNMQGZW9vD+2dyMEHo+YGrP2qKHWr7C3uo8VXqtACHGSPsZezBZApgCS2TFOwdlYKUZG0s3HLXU6YECGZbJVE4/MAfR7dab/3WI/QyjOZ+ZSkIkLJORjCfBR8KhqMXvoaQiq4fGpCWdCaVr4CpQUzvJI0okqDYcizk4wmdA4ukAhJRSOqmWEFODBI0iWVrACa0EylyCwaUY4E1czl9D5rL3Lw9FtnplPEtMylEQ1A0sSZEiJqXSXQvuWIOY0o3GmhMqDJjAmLAmkOBaPJknr/CbXOcDlHSVkWeI48VTt/NKJdjUxDUh90oEpfsCt0b60tTm8lQLk6rnUddcAIXnAXYPlcgqnWsgxZtGnOlCn6SbYg3M9RlsUUDK1RknlgknHcc2pvuP4GPuN6gnatVtKCRdndOMZ/63VfHR7SkcujKx1Ih/JMa8FTvzH6ZFFpuRmAmn6C1DPQoBnHG5cGbClcT44ZwzBh7qCw/67fLCPZNymE0DC3RqqQO31zzG9296b5x98QkwvucPVpJqz/gWcBTbxX7skWtABmwXed7kihrTdKZGCeau1Ug8QW/veff5HXhi/Am+JPTyx3TttkNGpXSiOGqSrQ2umtfHpcn5TvWqiP4fnW87Xlfu9PyJZu0fdG6zqirikpDbheB9+4mRpgDrJD92Vbu/Hu3mAcD+IfL8Yvk/2fkoOXwziO/6ARvSsE6ob+yZzPr3Pafpc6+wZ+6g2xHpfu40DrPjpcYvO7Dl3gejeOr/dQpI7ofry/2Q3OQCvjiFSOsAXjgk0F/PDftQMwRm0l2Aqs7RF8Kan9eP/6oEvqYDOpE7lggmfk8MMJuVA3IL9tRn33rnG/WVPeCPl9upZsf71J0kJaGu4qf8XfDZjmg2Y/uZxg0y/A5aqdD/xM4HKa0FF/VBgt25mgxisXzCJMDKURvRZhHZtzOR8wrYdKg8RWJtjUYsMYMc1HizFFjyGic0StAWYtrlU/0PwtYENo0+5LtVdiDgy7IybK5Ux55RaM0AI9lIvxlhmGW8Kt3w7Z+rKSmTLknnZv6s7Bb+L63nBMrIaUz1pGDAkOc+eq8GMYXpOCyxsc6Qfk8nQ24ylngvwOU8sdTJ4H5G5vbzcQe+F1jrnLyykxoNVKfO4XPax9re7jBY2oA1PY09k5mAVPQyN/wNXIC49anrPU8xwKxrG67dKv95WQd4KnIC30mHl4/OEd2RvGNOqR4xEhj96dvDp6f36EVpFeTYnGw3gY45JW1hVM9hwdg+uq1jySphVZja5rpV6uzu/399b399b/9t5q25aDOzfSgnHfm/0xWLZ99ZLee4IlgbKTiObKOhRZLpFyH42oa1xupn5stxm3eMGt5v4bqHrvkgUTJfqn+Hx4QLZ9TqxEJ/hhOMpu9/HgSXp+1lbuBXnMc3ArOKHRy6ofVAg2YFNP6ih0eoyx2T1MU9D9vDdu5rXr7fjogkaUlViG/g1z42+Y9gda3xrT+tXTBIB/EeqtCj/j/fAWql868WbnQYU2vyCN+Ezquv4HoSg/vQ==",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/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:"eJztV91u2zYUfhWOvWkD2Zbz02HCMCxo0yBr0RRJigFLjICWji02FMmSlBPB0N2eZI+2JxkOJcpy7HRJsfWqN4lFnt/vfDw8XFLH5pYml/S1SssCpLN0EtEMbGq4dlxJmtBnz56RsE0uKg02uZJn4AyHBRBGBLeOqBnJggkyZRYyoiRxlYYreSXHQ7Kz89qwmess2WRn50oSQshgtUZczhxhBkhaGgPSiYpwSTKvaR1zpR2ivV20d87nkrnSADmDzyXYL5k08LnkBojLgVSqNMQGZW9vD+2dyMEHo+YGrP2qKHWr7C3uo8VXqtACHGSPsZezBZApgCS2TFOwdlYKUZG0s3HLXU6YECGZbJVE4/MAfR7dab/3WI/QyjOZ+ZSkIkLJORjCfBR8KhqMXvoaQiq4fGpCWdCaVr4CpQUzvJI0okqDYcizk4wmdA4ukAhJRSOqmWEFODBI0iWVrACa0EylyCwaUY4E1czl9D5rL3Lw9FtnplPEtMylEQ1A0sSZEiJqXSXQvuWIOY0o3GmhMqDJjAmLAmkOBaPJknr/CbXOcDlHSVkWeI48VTt/NKJdjUxDUh90oEpfsCt0b60tTm8lQLk6rnUddcAIXnAXYPlcgqnWsgxZtGnOlCn6SbYg3M9RlsUUDK1RknlgknHcc2pvuP4GPuN6gnatVtKCRdndOMZ/63VfHR7SkcujKx1Ih/JMa8FTvzH6ZFFpuRmAmn6C1DPQoBnHG5cGbClcT44ZwzBh7qCw/67fLCPZNymE0DC3RqqQO31zzG9296b5x98QkwvucPVpJqz/gWcBTbxX7skWtABmwXed7kihrTdKZGCeau1Ug8QW/veff5HXhi/Am+JPTyx3TttkNGpXSiOGqSrQ2umtfHpcn5TvWqiP4fnW87Xlfu9PyJZu0fdG6zqirikpDbheB9+4mRpgDrJD92Vbu/Hu3mAcD+IfL8Yvk/2fkoOXwziO/6ARvSsE6ob+yZzPr3Pafpc6+wZ+6g2xHpfu40DrPjpcYvO7Dl3gejeOr/dQpI7ofry/2Q3OQCvjiFSOsAXjgk0F/PDftQMwRm0l2Aqs7RF8Kan9eP/6oEvqYDOpE7lggmfk8MMJuVA3IL9tRn33rnG/WVPeCPl9upZsf71J0kJaGu4qf8XfDZjmg2Y/uZxg0y/A5aqdD/xM4HKa0FF/VBgt25mgxisXzCJMDKURvRZhHZtzOR8wrYdKg8RWJtjUYsMYMc1HizFFjyGic0StAWYtrlU/0PwtYENo0+5LtVdiDgy7IybK5Ux55RaM0AI9lIvxlhmGW8Kt3w7Z+rKSmTLknnZv6s7Bb+L63nBMrIaUz1pGDAkOc+eq8GMYXpOCyxsc6Qfk8nQ24ylngvwOU8sdTJ4H5G5vbzcQe+F1jrnLyykxoNVKfO4XPax9re7jBY2oA1PY09k5mAVPQyN/wNXIC49anrPU8xwKxrG67dKv95WQd4KnIC30mHl4/OEd2RvGNOqR4xEhj96dvDp6f36EVpFeTYnGw3gY45JW1hVM9hwdg+uq1jySphVZja5rpV6uzu/399b399b/9t5q25aDOzfSgnHfm/0xWLZ99ZLee4IlgbKTiObKOhRZLpFyH42oa1xupn5stxm3eMGt5v4bqHrvkgUTJfqn+Hx4QLZ9TqxEJ/hhOMpu9/HgSXp+1lbuBXnMc3ArOKHRy6ofVAg2YFNP6ih0eoyx2T1MU9D9vDdu5rXr7fjogkaUlViG/g1z42+Y9gda3xrT+tXTBIB/EeqtCj/j/fAWql868WbnQYU2vyCN+Ezquv4HoSg/vQ==",sidebar_class_name:"get 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 f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:n}=s;return n||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,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,a.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,a.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,a.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,a.jsxs)(s.ol,{children:["\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,a.jsxs)(s.li,{children:["\n",(0,a.jsx)(s.p,{children:(0,a.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,a.jsxs)(s.ul,{children:["\n",(0,a.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.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,a.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(s.p,{children:"Query Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsxs)("ul",{children:[(0,a.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:10}}),(0,a.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(i.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"result"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"document[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,a.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsxs)("span",{className:"openapi-schema__container",children:[(0,a.jsx)("strong",{className:"openapi-schema__property",children:(0,a.jsx)(s.p,{children:"Signers"})}),(0,a.jsx)("span",{className:"openapi-schema__name",children:(0,a.jsx)(s.p,{children:"object[]"})})]})}),(0,a.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,a.jsx)(s.p,{children:"Array ["})})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})}),(0,a.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,a.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,a.jsx)("li",{children:(0,a.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,a.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\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 "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Report not available!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(s.p,{children:"Invalid API Token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(s.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink