WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 20:44:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
d962e64ad2352b6a1dd5ec3012a2d4207c34714f
OpenSign/assets/js/fa40969b.e2316308.js
T

1 line
13 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:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var i=n(85893),t=n(11151),a=n(58219),l=(n(62316),n(51039)),r=n.n(l),d=(n(82723),n(9487)),c=n(41429),o=n(5397),m=n(4667),p=n(9472),h=n(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:"eJztV9tu3DYQ/RVm8pIY8l7ipA9CUTRNXMNNEBu2gz54FwUlza4YUyRDUnvBQm/9kn5av6QY6rKy1068QfqWF1s74twPz4w24PncQXwNb3VaFqi8g2kEGbrUCuOFVhDD06dPWfuaXa0NuniiLtBbgQtknEnhPNMzlrUmWMIdZkwr5tcGJ2qixgN2cPDW8pnvLLn44GCiGGPscCtjPueecYssLa1F5eWaCcWyoOk896UbkL0XZO9SzBX3pUV2gZ9LdF8yafFzKSwynyNb69Iy1yoHe0dk71Qdnls9t+jcN0VpGuVg8SVZfKMLI9Fj9hh7OV8gSxAVc2WaonOzUso1SzsbS+FzxqVsk8m2SdQ+X5HP45UJ7x7rEZvzXGUhJaWZ1GqOlvEQhUhkXaOfQg8xlULtm1DWaiXr0IHSoR1MFESgDVpOODvNIIY5+hZEBCqIwHDLC/RoCaQbULxAiCHTKSELIhAEUMN9DndRe5VjgN9tZHrNbINciKAtJMTelhiB82tJ9p2gmkMEuDJSZwjxjEtHB9IcCw7xBoL/GJy3Qs3ppCoLukcBqp0/iKDrka1BGoJuodI/2DW6J2ua05O0pdxe16qKusKsDrkRh17foGqLkyPP0H7PZCs6yoNSTA1UlOJgtVqtoJrWftD533S2Jt1UK4/K0yM3Roo0tHv4yVGXNrtOdPIJ09B6S+DwAh29laIQvndMlUUS0pppW3Dfl3TBjUdVBO5GmD31RlUVwaqQpNYUluCYUEZVBF54eVtWkYJFZ7RydbgvRiP6dxuS23vNOtyHxn+XCtViuke76OyS3eK16+DvJ+LmxVGSf/yDkruqk9vPhAsPdM3IxAft97ZgJHKHgdC620q2fteS0LuntTODiqbDv3//w95ascBgSuyfWO69cfFw2EhKKwepLsja2VLtH9cnHQiR9Cm8wGqdBW4tX9Ot9Vi4r7f7QwDmPUTU9wZVD69tXf9qfVe7OO/X/q5eg/OXo5e70L5Ao61nwjGlPeMLLiRPJD6BoPBqV+FULbgUGXt9fsquiK+ehFgdpqUVfh3Yvs9m8fWUyKVAn2saFUY388HnEMOwPzaGm2Y+VES/aBft9Cit7PWUGzNo2UvyxFFnh9yI4WIceKwN5ZLuX13zWwFtG2fEO6TOfZWEKUO61hdbijxu29VR3HjUkhbRl1AzHXw1zWihHQq3GN8z9oSjNtDrtiiBT9hMW3ZHu7eo5RhekvxoMGbOYCpmDRUNGM3/S12EyU30JYW6oS3wkF2fzWYiFVyyPzFxwuP0WVvg5XK5U+DnQedE+LxMmEWjt8fnQRi60NfqfjyHCDzawp3NLtEuRNpe0AdcDcPhYUOwPA0EiwUXBIJG9OtdJcKrFCkqh71b8frk/D07Gowg6mHoESEP35++Of5weUxWCYV1i8aD0WBEIsJwwVXP0Qn6rmv1Xp2s2XbbudXq3mj9saL/WNH/txW9YTmPKz80kgtF0A3XYNPQ7zXc2drjFrLTCHIi6vgaNhuC3Ecrq4rEn0u0xPLTCBbcChoWgaMz4eg567bQBzH/7KKp8XP2mF3/3jRaBldE3wsuS/oFEdzguveZUU2rqKXwb47xoRBqV7dnRhcJrfb1gTe1zcOrmgnaEzsL41bjdZqi8V882x+o52eXVxBB0qztRfgSAMuX9OnAlxDDBCYQPtnIQpiHQb4BydW85POwcwS7NOd4SdDoD8mbMCSbB6rjvdW/XYk6FfpLid2r8DPNrHe4/qU7Xr95UKH7IqpPUxumVVX9B5ho3I0=",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:"eJztV9tu3DYQ/RVm8pIY8l7ipA9CUTRNXMNNEBu2gz54FwUlza4YUyRDUnvBQm/9kn5av6QY6rKy1068QfqWF1s74twPz4w24PncQXwNb3VaFqi8g2kEGbrUCuOFVhDD06dPWfuaXa0NuniiLtBbgQtknEnhPNMzlrUmWMIdZkwr5tcGJ2qixgN2cPDW8pnvLLn44GCiGGPscCtjPueecYssLa1F5eWaCcWyoOk896UbkL0XZO9SzBX3pUV2gZ9LdF8yafFzKSwynyNb69Iy1yoHe0dk71Qdnls9t+jcN0VpGuVg8SVZfKMLI9Fj9hh7OV8gSxAVc2WaonOzUso1SzsbS+FzxqVsk8m2SdQ+X5HP45UJ7x7rEZvzXGUhJaWZ1GqOlvEQhUhkXaOfQg8xlULtm1DWaiXr0IHSoR1MFESgDVpOODvNIIY5+hZEBCqIwHDLC/RoCaQbULxAiCHTKSELIhAEUMN9DndRe5VjgN9tZHrNbINciKAtJMTelhiB82tJ9p2gmkMEuDJSZwjxjEtHB9IcCw7xBoL/GJy3Qs3ppCoLukcBqp0/iKDrka1BGoJuodI/2DW6J2ua05O0pdxe16qKusKsDrkRh17foGqLkyPP0H7PZCs6yoNSTA1UlOJgtVqtoJrWftD533S2Jt1UK4/K0yM3Roo0tHv4yVGXNrtOdPIJ09B6S+DwAh29laIQvndMlUUS0pppW3Dfl3TBjUdVBO5GmD31RlUVwaqQpNYUluCYUEZVBF54eVtWkYJFZ7RydbgvRiP6dxuS23vNOtyHxn+XCtViuke76OyS3eK16+DvJ+LmxVGSf/yDkruqk9vPhAsPdM3IxAft97ZgJHKHgdC620q2fteS0LuntTODiqbDv3//w95ascBgSuyfWO69cfFw2EhKKwepLsja2VLtH9cnHQiR9Cm8wGqdBW4tX9Ot9Vi4r7f7QwDmPUTU9wZVD69tXf9qfVe7OO/X/q5eg/OXo5e70L5Ao61nwjGlPeMLLiRPJD6BoPBqV+FULbgUGXt9fsquiK+ehFgdpqUVfh3Yvs9m8fWUyKVAn2saFUY388HnEMOwPzaGm2Y+VES/aBft9Cit7PWUGzNo2UvyxFFnh9yI4WIceKwN5ZLuX13zWwFtG2fEO6TOfZWEKUO61hdbijxu29VR3HjUkhbRl1AzHXw1zWihHQq3GN8z9oSjNtDrtiiBT9hMW3ZHu7eo5RhekvxoMGbOYCpmDRUNGM3/S12EyU30JYW6oS3wkF2fzWYiFVyyPzFxwuP0WVvg5XK5U+DnQedE+LxMmEWjt8fnQRi60NfqfjyHCDzawp3NLtEuRNpe0AdcDcPhYUOwPA0EiwUXBIJG9OtdJcKrFCkqh71b8frk/D07Gowg6mHoESEP35++Of5weUxWCYV1i8aD0WBEIsJwwVXP0Qn6rmv1Xp2s2XbbudXq3mj9saL/WNH/txW9YTmPKz80kgtF0A3XYNPQ7zXc2drjFrLTCHIi6vgaNhuC3Ecrq4rEn0u0xPLTCBbcChoWgaMz4eg567bQBzH/7KKp8XP2mF3/3jRaBldE3wsuS/oFEdzguveZUU2rqKXwb47xoRBqV7dnRhcJrfb1gTe1zcOrmgnaEzsL41bjdZqi8V882x+o52eXVxBB0qztRfgSAMuX9OnAlxDDBCYQPtnIQpiHQb4BydW85POwcwS7NOd4SdDoD8mbMCSbB6rjvdW/XYk6FfpLid2r8DPNrHe4/qU7Xr95UKH7IqpPUxumVVX9B5ho3I0=",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 f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,t.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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get document list by doctype"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.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,i.jsxs)(n,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Header Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.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,i.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(n,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"limit",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:10}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"skip",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:0}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(a.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(n,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(n,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"Signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\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}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report is not available!"})}),(0,i.jsx)("div",{})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink