add help docs

This commit is contained in:
nxglabs
2024-01-18 21:09:17 +05:30
parent 50c3133dae
commit e38a1f9c1a
19 changed files with 976 additions and 1426 deletions
+1 -1
View File
@@ -5,7 +5,7 @@ description: "Add a new pet to the store"
sidebar_label: "Add a new pet to the store"
hide_title: true
hide_table_of_contents: true
api: eJztWN+P4jYQ/lesPPUkINBe+4CqqnRvdVr11EVlq1ZiUWWSgfg2sV3bWRah/O+dsRMSYHd76t295QUl4/k93+cYHyLHtzaaLqPSgrHRahClYBMjtBNKRtNolqaMMwk7psExp5jLgFmnDESDSGkwnBRvUlTlaToHh2ID/5Rg3S8q3UfTw5nDKwPcQcenkCc+EyUdSEeGXOtcJD5A/NGS9SGySQYFpyeKIgyklLzkBdnqTDn1h8l9HW6vAeOp9UdIKCttKF0nwJK1SOm31hEYcgsGlTbKFNwF0Q9vUQBPvNA5Kk3G1SDEae2sM0Juu1pRqrZbARHqYuKwVWbf0f9iuXxSKu8UTrZC1aciJ81g0eaFK044r3rVkbVNbL1zY/g+OnraGRwNdd6ZEtBEOCjsc8mcRm48Y1IU2wPv/4b4rFa+2L7LbmGW3Ubd8aBkHXflsyWfop0AHnTPcQ6yLAi6/JGLnK9zj1+QafBiVZ5Gq8t00F83HeIbKXWZUhv0ROmJ0hPlVaIMd7vdkCoeliYHmagU0p46PXV66lxSpxp0yFD3y4DVStrQlW/H48vD3qJMErB2U+bseFbsz3g9/3r+9We8nig9Ub7Ghwolb8ffX36LbuQjz0WKoXUZGGUhKY1wCMolfYjE3w9Az6sKCVOAyxTdamhlfWe5y/At3oKjmxLKCswjXZmQMZ4fcTFzTttpHOOwRjgHacVWYjV2lKgChSJ+nETku4m7IPqGUR2jtxDQ4lcgDNTF/jWcc2NhOGvkgorKgKeYDVVDX8/f25uX6wb6AQeT8dFTzcpTUnqdo0pgywn8l81UVw1al8GqddzgZtVCojNRwq3cKF9iPbFbbNICm8Rm8xuGzTkHzF0mECrWL6cqKQs8NPgNkCGG2Zk1W3MLKVMBWbRI8u9GE2Y1JGJT750jdi/v5UIVwHCQdDLJhXyw03s5ZMvbDaoJnrM/YW2RZatvmpniX4WLmb7xNu+Fy8o1M6BVq771Qj/4rtXx5Q3W6sAU9nazQByJBGr8vBAq9spxfXbiiT874d4vCHe16OdzI2o5fjJQCB3WzN7PP2Bbxuirhe0npBx/uLm6/m1xTV4J+GFEk9EYXRFUkCcFl91Ar10dngz60J4IX7equeHgycU650iBqq7iUDN0GTUMRRRmxF0UHQ6EDcRxVZEYOWI80bEQboRHJ9F+0NCJoO3ZGF2FvIZ3FJjU8zKQ87/+RlaDxsUMj8DavWDsj7wn+838dnGHyuv68rRAbyjteB50X0LavKTSu1vHg98i6gcqp1mS+04mF3tKyJh+Kf9nbX4kVqH2T0f1sPKiQd3TRptmhnt59S82CpVV
api: eJztWN9v2zYQ/lcIPq2AbdlbtwdjGJalQRGsWII6wx4cY6Cls8RGIjWSimMY+t93R0qWbCdZ0a5vejGk0/2+7yNp7rkTqeXzJa8sGMtXI56AjY0sndSKz/lFkjDBFGxZCY45zVwGzDptgI+4LsEIUrxOUFUkyS04FBv4pwLrftPJjs/3Jw4vDQgHPZ9SHfmMtXKgHBmKssxl7ANEnyxZ77mNMygEPVEUaSCh5JUoyLbMtNN/mtzX4XYlYDy9/gQxZVUaStdJsGQtE/ptdCSGTMGg0kabQrgg+uktCuBJFGWOSrNpPQpxOjvrjFRpX4snOk0lcNTFxCHVZtfT/99y+axU3mmcbI2qT0VOmsGiywu/OOm86mVP1jWx8y6METt+8LQ1OBrqvDMVoIl0UNjnkjmO3HrGpCi2B96XhviqVr7YvvNuYZb9Rt2JoGSdcNWzJR+jnQAedE9xDqoqCLriUchcrHOPX1BJ8GJ1nvDVeTror58O8Y2U+kxpDAaiDEQZiPIqUcbb7XZMFY8rk4OKdQLJQJ2BOgN1zqlTj3pkaPplwJZa2dCV76fT88PeoopjsHZT5exwVhzOeAP/Bv4NZ7yBKANRvsVGhZK30x/P96Jr9ShymWDosgqMshBXRjoE5ZI2Ivn3A9DzqkbCFOAyTbcapba+s8Jl+Bal4OimhLIC80hXJmSM50f8mDlX2nkU4bAmOAdlZaqwGjuJdYFCGT3OOPlu4y6IvmFUh+gdBEr5OxAGmmKfxigZO/0AtINKqigDkWAqVAptnR+7a5erFvcBBLPpwU1DyWNGep2DSqDKEfaX7UhXLVSXwapz3IJm1eGhN04CrdpoX18zrhvs0AI7xC5urxl25hQtd5lEnFj/OdFxVeCJwa9+DAHMTqzZWlhImA6woo8k/2EyY7aEWG6ahXPC7tW9WugCGE6RjiW5VA92fq/GbHmzQTUpcvYXrC1SbPVdO1D8n3A20Dfe5r10WbVmBkrdqade6Kfetzq8vMFaHZjC3mwWCCIZQwOeF0JFXjlqDk4i9gcnXPglga4R/XpqRC3H/QKF0KPMxfvbD9iWKfrqMPsZKUcfri+v/lhckVdCfRjRbDJFVwQVJEkhVD/Qa/eGR4Ped8fB160aYjh4clGZC6RA3VSxb+i55C09EYUZERdF+z1hA3Fc1yRGjhjPcixEGOnRSZwftXQiaHsq8suQ1/iOApN6XgVm/td/yHrUurjA82/pXjD2592jxeb2ZnGHyuvm5rRAbyjteR71X0LaoqLS++vGg183mgcqp/2kdr1MjheUkC79UvLPGvxMlMI16ZeDevjyokHT0FabBoareP0vA9iTzw==
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
-637
View File
@@ -1,637 +0,0 @@
---
id: create-user
title: "Create user"
description: "This can only be done by the logged in user."
sidebar_label: "Create user"
hide_title: true
hide_table_of_contents: true
api: eJztV99v2jAQ/lesPK0SEGi7PfBUVlVVt6qg0WqTKJqc5CBuEzuznVKE8r/vzgkh0F/seUg8kPN35/Pddz7fyrN8brz+xLOQZgm3YLxpy4vAhFpkVijp9b3bWBgWcsmUTJYsABYpCSxYMhsDS9R8DhETkuUGdMdreSoDzUn1KkLlUANavcM1XNLwJwdjv6po6fVXO9ucO2Tk7DAVPEBoUSVU0oK0BOdZlojQmfYfDOmsPBPGkHL6Z5cZoJVaMdPkiBV4IlwVUQMj0OTcOTRTOuW2FH05RQE8c4wDgnrdouWRK5Kn0NA1Vgs5byI9DIM7HyrMhDb25kONbyqWBE/4XmhEGILjSUXyPvYBLZ85XCdUKSll3JiF0tH7er3jk9PPDh5jcvfEUnjGltvcvBrc7fRSiFiF3g78yfFW4Au0/Jy6c5axd/vQflZY50AZbRQ0GVGpHAhxIERFiPZisWiT3XauE5ChiiA6UOT/pggBNZhMSVMmOYIZzxP7sh2ZPAzBmFmesLqjHfrRgVuHfnQgxN6XDcpSsLGil3CmjEs7tzF++esHdyKcGDWeQNNTfOVhu0JEbG1m+r6PpOogU6QRc5nwwFDcUCj8p55XTEkzzLWwyzExrSQTrv5+hGXj0Cj5joLW2uNf7RHXBtqDtVxQCGLgUUVlutB+bJ7rF+vTl0ztdZvcqwm2xa+SRE0OVUSpebJLhiYXqiTW+a6/mzntFeT4TLmDVrEfYqjGGCo2GF0xDNGr0wz+aDlSYZ7ibe4qlmHK2Y42C7jBkQQXadahRZKfdHrMZBCKWVXsHXYv7+VYpUDTC7WMRMhH07+XbTYZzhAmeMJ+QmCEhemndWbxffIis0dO51LYOA+Yhkxt4HMndOlvatUfR3hWCzo1w9kY2SRCqFj0xla+A/tVU+Oha2rr1FSis10ldyugaeyfjQIYXI6uMSxdyk9N3j1c9q+vzi9uxhdklehfpqjX6aIpqnUsmZTLxkblkOhmxN3Mrja9+V9H1qpILDxbH4tSuLvPHWRV1etmQHb1imUXUzmjfLUijtzppChIjBWjsfAm+PeJa8EDIuVkivaq4qICd7XpnZfutm9pd4IneVmqH71hi9baxADfKJl9Q9m9SeiGqK+g0XB8i+Cgmr9TtEa318Zyq/lBbhfFXysscmQ=
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Create user
</h1>
<MethodEndpoint
method={"post"}
path={"/templatelist"}
>
</MethodEndpoint>
This can only be done by the logged in user.
## Request
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"request"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
<div
style={{"marginTop":"1rem","marginBottom":"1rem"}}
>
Created user object
</div>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"theUser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"firstName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"John"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lastName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"James"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"john@email.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"password"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"phone"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"userStatus"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"application/xml"}
value={"application/xml"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
<div
style={{"marginTop":"1rem","marginBottom":"1rem"}}
>
Created user object
</div>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"theUser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"firstName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"John"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lastName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"James"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"john@email.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"password"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"phone"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"userStatus"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"application/x-www-form-urlencoded"}
value={"application/x-www-form-urlencoded"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
<div
style={{"marginTop":"1rem","marginBottom":"1rem"}}
>
Created user object
</div>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"theUser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"firstName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"John"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lastName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"James"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"john@email.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"password"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"phone"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"userStatus"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<TabItem
label={"default"}
value={"default"}
>
<div>
successful operation
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"theUser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"firstName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"John"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lastName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"James"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"john@email.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"password"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"phone"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"userStatus"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": 10,\n \"username\": \"theUser\",\n \"firstName\": \"John\",\n \"lastName\": \"James\",\n \"email\": \"john@email.com\",\n \"password\": \"12345\",\n \"phone\": \"12345\",\n \"userStatus\": 1\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem><TabItem
label={"application/xml"}
value={"application/xml"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"username"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"theUser"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"firstName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"John"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"lastName"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"James"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"email"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"john@email.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"password"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"phone"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"12345"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"userStatus"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"<root>\n <id>10</id>\n <username>theUser</username>\n <firstName>John</firstName>\n <lastName>James</lastName>\n <email>john@email.com</email>\n <password>12345</password>\n <phone>12345</phone>\n <userStatus>1</userStatus>\n</root>"}
language={"xml"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+242
View File
@@ -0,0 +1,242 @@
---
id: createtemplate
title: "Template Creation API"
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: "Template Creation API"
hide_title: true
hide_table_of_contents: true
api: eJztVt9v4zYM/ld0upddkSbp3T3l6bquKIIVbdCk2ENaDLLNxGplyZPk/FiQ/32kbCeOkxsaYI/rFT2bpEjqI/nRG+7F3PHBlHvIciU8OP7a4Qm42MrcS6P5gE9SYJNKzW4sCJKz69GQCaXM0rHCgXXMGxaTElhcOG8y+beIFLCd4w5bpjJOGRovgAnHIlVAbqX2js2MZXPQYNG3nrPExEUGpFhKn7LcQgIzqSFhztsi9oUF12XPOabhijgG52aF2kUq08AcO8xj6pSoBTyjHROs0PKvAtjFRW09TC4u0E54FgvNIqDbJHSZKh9oZBMJ0mFU8utyiOVMknHlqss73OThEkYPE4SuBKTWo9oCRnf+V5Os+WDDY6M9eqZHkedKxuFo780R8Bvu4hQyQU9+nQP6M9EbxB795JYCeYn1Qu2DyKBhhSAhimiFsGbCNyWwEphLMAoPu9z5tsMfjD/bzUgBgoIALyQsmdBYIjkngKTbAUe+f2u21HkhdnVttiW6fH66P9dV6n3uBr3e2hRWZmIO3dhk5IuSxiZu+BPWinXz8JS/Gfgxz4RU4VQH31PdEODgrDJFLnSox85phy8tlhewI7B9AcNJvJM7lfw+VQpWvVXhTjtHb156dSDaEgoqAUtNeB5CqzcXias7sRoFN4cxW+3cCN3WbOkwTimOqCt79Gu/T/+1qOVgZGm+d+Os1p8wsf9oQGKTNDsbOQfmYJtQoOjb13CjYNIGDRUZ5oUdc0J3hNPnz8hXolD+GKL6xk8VNhVU3/vfj9EZ6oVQMgkMNjHvoD+FWBn41BC75MaFqwqf4lvviGwC01JTTze8sKrR/4hlF/HR1DFKRI46DIWyt7ji21c6GeOA+PWY8C0hRO2f77BuTkgufwcakerWq0uUXHpKFIWSbpCCwC4MWVPJnvbsd1t3XM1eR4RU89HHKKbFMKdJo+KMn9BAgwU+Muv7CTsYGrr5zASYqsI/ItBjypjqiAAf71e8CP6Sur5PuWNpLbZOH+4gUpL8W/eq3kflhHTZi37RY5OFfUbbUUn97gYv+pJNH2doJoVif0DkkIpef6kBWS6XR33xJZy5w0VcRFiE3OzN50EYmqd5avfyBe/qwWbucTbGXpRxzcE/CdULxr1q7kUc5h4IdJqfUvSjfYggR2IAGqb9CF7fje4Rlj762rf+B1Lu3Q9vbh/Gt+SVhqcs0VW3j65QRCOXCd0IdPLLqF3jxqb//3PqnM+pimo8rHwPhTIs/lDQTcV70/buwdFMiRhRs9lQiGertlsSY6YWCWyKjwthJeFJb+ix4ikiysBx/KYs1+WE4pM5ghsor7WDtp36xDUCl/t/tX1tcPfocTxB46j6EMzCguJWLOkjEf8O+Av+Cx+U5CFQcJBvuBJ6XoRNxEu/9PMPphMdww==
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Template Creation API
</h1>
<MethodEndpoint
method={"post"}
path={"/createtemplate"}
>
</MethodEndpoint>
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.
## Request
<MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"Name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"sample template"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Note"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"template description"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"URL"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"https://yourimage.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"signers"}
required={false}
schemaName={"signers[]"}
qualifierMessage={undefined}
schema={{"type":"array","example":["joe@gmail.com","john@gmail.com"],"xml":{"name":"signers","wrapped":true},"items":{"type":"string","example":"joe@example.com","xml":{"name":"signers"},"title":"signers"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"folderId"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<TabItem
label={"200"}
value={"200"}
>
<div>
Template created successfully!
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"code"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"type"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"message"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"code\": 0,\n \"type\": \"string\",\n \"message\": \"string\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"404"}
value={"404"}
>
<div>
Invalid API Token!
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+3 -3
View File
@@ -5,7 +5,7 @@ description: "delete a pet"
sidebar_label: "Deletes a pet"
hide_title: true
hide_table_of_contents: true
api: eJyVVdtq20AQ/ZVlnxJwLIeGPohSGhoTTENj6pQWHBPW0shaIq02u6ukQejfO7O6+QotGFua65kzF1fciY3l4ZJHhXIicpavRjwGGxmpnSwUD/EtAwdMMA2Oj3ihwQhSzeJeOfcaLYzI8c1QwIorfEELoeXTM7yjXlK0FEQMhu8nQYGBl1IawKiJyCyMuI1SyAUPK+7eNYWyzki14XU96qO3sJ9k3CXQwqUH4REgkzFzBWsA76RzpjyWTSoHGw81KUwuXCP6eIX5V+RudaEsWPK4mkzoZzfnTL2KDJMibQyfSiDg3EJUGunePUUdN+FyRTGRvLQYWPWUYjEhD9oyg2qot+YUzLx2dJcmI3qd0zYMAqH1GDulrNyoTKztOCpyFMrg9ZJTqg7GgqpuiujB9Ayg5JvvXEv274u5MBYurjv5dkepOKmSwvtLl5HDPSJYIAJ2PZ8xzLzflodUWoYfUsdFVOaA1ZGOIeVsz5uthYWYodKl4JUk/zC+ZFZDJBMZedcxe1SPalHkwEoLSZmxTKpnGz6qC7a8T9BMioz9grWVDlZnHWFvb28HhJ17n1vp0nLNDOhiMN94oWd126t/OcdacRNye58ssEkygrY5J1IF3jhAr7bDRCPOo8yGIf+y78SR8gxD4xiSedul69v5HdIywVjDTPwD5OBu9nX6fTGlqDRVTYsuxxMMhSJdWJcLtZXoxk+p7S/DTm8rjxr7eXhB2uly8McFOhM4RHULtWoHvj9HaB1urTgOboowyKCqaBx+mqyuSfxSgvF7hNiFkWJN84dbEUtLz8NROQny7Ed7EM7ZkWtxFHO3Jop2oVlxf8n8Fm2fpnqF1u2e/B+qU6mbFMNt7bPv3JGb6d30YYpqURKt24vduLUPhOloMQcb3+SlbzrCR30+0Vqi9efevL1+pxz6v4TGmgpc1XX9F0LcPJ0=
api: eJydVW1r2zAQ/itCn1pI45SVfTBjrKyhhJW1LBv70Iai2OdY1JZUSW4bjP/77mTHTtIEtkFI7Ht97rmX1NyLlePxPU+08iLxji9GPAWXWGm81IrH+FaAByaYAc9HXBuwglSztFfeBY0RVpT4ZilgzRW+oIUw8vEJ1qiXFC0HkYLl+0lQYOG5khYwaiYKByPu/LqgCE6WBh9GHN5MoVMYDJIcSsHjmvu1CZbeSrXiTTPq03d1Pcp0g8AIn7/LjxUwmTKvWVvRDh5vq/+CI5WHVSg207YUvhV9vECAC4rvjFYOHHlcTCb0swtqpl5EgaiQeIZPFVBl3EFSWenXgeQNu/H9gmIi/bke+hKagtXGPOp4iOqBkIZTMPuyaVhlC2qQ98bFUSSMGWOvlZMrVYilGye6RKGMXs45pdrAmFPVbRE9mJ4BlHwLve+68XaGkjOvn0DtDQRVJlWmg7P0gelbTD/H9OzybsYw7X7TfubSMfyQOtVJVQKWRjqGfLM9b7YUDlKGSp9DUJL8w/icOQOJzGQSXMfsQT2ouS6BVQ6yqmCFVE8uflBn7P42QzMpCvYblk56WJxs2Hp9fX3H1mnwuZY+r5bMgtGD+SoIA6XbXv3LKdaKi1S622yOHZIJdJ05kioKxhF6de0lGnEYZTGswJd9J46UFxgaZ5DMuxZdXt/dIC0TjDUMxF9Ajm5mX6ff51OKSiPVtuh8PMFQKDLa+VKorURXYURdf1h2elsH1NjP9weoGy0Pbz4yhcAhajqodTft/TVD63jrAODU5giDDOqaxuGXLZqGxM8V2LBEiF1YKZY0f7gSqXT0PNykoyBPfnTn4pQduCUHMW92RNGCtPsdDmFYoe3D1SzQutuTf0N1LHWbYjjNffadI3I1vZn+nKJaVETr9la3bt0DYTpYzO66t0npm+7zQYdPtJN4MT735t3dO+bQ/5201lTdommaP8yWUbU=
sidebar_class_name: "delete api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -59,7 +59,7 @@ delete a pet
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"contact_id","in":"path","description":"Pet id to delete","required":true,"schema":{"type":"integer","format":"int64"}}}
param={{"name":"contact_id","in":"path","description":"Pet id to delete","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
@@ -83,7 +83,7 @@ delete a pet
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"api_key","in":"header","description":"","required":false,"schema":{"type":"string"}}}
param={{"name":"api_key","in":"header","description":"","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}}
>
</ParamsItem>
@@ -1,11 +1,11 @@
---
id: delete-order
title: "Delete purchase order by ID"
description: "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors"
sidebar_label: "Delete purchase order by ID"
id: delete-template
title: "Delete template by ID"
description: "Delete template by ID"
sidebar_label: "Delete template by ID"
hide_title: true
hide_table_of_contents: true
api: eJzFVFFr2zAQ/iuHnlpI44SVPYQ9LCxZCStLWTo2aEOR7XMsakuuJKcLwf99nxxnydJtbE+DQOTTd7q777u7rfBy5cToTnguq0J6dmLZEym7xKrKK6PFSLw3ltayUClZdpXRjsnbDSntecWWZhNHz8rnAVMzvaHhYDDo01hvfK70imRs1twaCQ9pozvH4FUUtGLNFoFpfDMjttZYJ3rCVMGI+LMUGaRcsOe5TdnirpJWlvi2IfGt0PgAZl/Ag0qBUSHxSvpcnFYzm5DJyOeMbPAeTtKTZk4deUMx0y5YeMTyU60sjiNva+4Jl+RcSjHaCr+pQsyuEkAzY0vpd6bXl6JplsF9x5YLHpeDQfg7yUXveEVOrq6qQiFW0wP28iW2rR70ecpMrYEDECzk5kBQyw1KHoloz0a0PeKlAcCxXe+Zq20BbO595UZRJKuqD9q1UytdyNj1E1PCqKL1UIRyHCe1VX6zCCzsisLtwyNvjhiB5QMMvb0qXy9upHV8Md7bW2FylkHKUILSmWn9lS+CwxwZLJBB2w6IfCrfba4c4ReuU5PUJWvfNgposXTiTbF0nBIug97hMthf9YfkKk5UppLWtU/3+l4vTMlUO87qggqlH93oXl/Q3TwDTMmCvnDslOfl2Z6w5+fnF4Sdtz5XGIc6xrhU5gBftcaW1WOvHx/nqBVNXbp5toBIKuFOnN+EilpwBK/EgIPEBxrRnyqI2pnenjqF9irwNNoywDuVxlc316BlgLcOPfEXKUfXs3fTj4tpeDV01U6iYX+Ap2CqjPOl1EeBJm2fUlXbJIc03QjGG0zAqdLbtgao+582UNfQnr/5CAOEvm06drbdlB2WJuCj4/2DaclRe4Bst6EHP9uiaYL5qWaLebnDcS2tknFoeoxiqlw4Y5YzWTj+Axdnn7qtdE7/sMp+Wc1+ZnUYzJY7fOHYjvRPC7VZHm+byfR6egvRm+8IziRL
api: eJyVVF1r2zAU/StCTyukccrKHvy0soYSVpaydOyhDUWxr2NRW1IlOW0I/u8714mbNF1hg0Ck63O/zj26GxnVMsj0TkaqXaUiBTkfSOvIq6itmeQylTlVFOl2B5AD6ZRXNUyePTfS4AJYH+FB58BoA5NTscQ5p5B57TggjJNLYQsRSxK9By4qCkOUBxGtWJDYpuQ4np4a7XFMo29oIENcV5wtaPhyMfTiKpvDVKgqMCArqVYy3ci4dozUJtKSPKCF9bWKW9OXc9m2c44fnDUBfcPjfDTiv6N6zUpVOheoOzTOVRrFtANgz99jpz4nL4yNorCNAa497v6y62zf+mKNwKgNfJZ2z3bHMshLZdJDk80Bwy0Agfyqn0HjK2DLGF1Ik0Q5N8QMTdBLU6lFGGa2hlEnqzPJTQfKGq/jesZcbVvH14dHWh/wBst3GAb9fF9OYTmN9pFMP9+SFPrtutSmsJ2zjt18pkg/Q3pxcTMRSHvMw22pg8CPP+c2a2oysZMcmPPiyFssVKBc4CPLhj+y/fPwTARHmS501rkOxb25NzNbk2gCFU0lKm0eQ3pvTsXdtABMq0r8pkXQkeaferaen5/fsXXS+VzpWDYL4cnZPXzZGTtKD71eLyfoFW+jDtNihgnpjHaT+SBV0oETeGUWHGSRaYSENU90Z/p67MQKrBAaymX4bkQXVzfXoGWEWHtB/EPJyfXk2/jHbMxRWVLbEZ0NRwgFk7Mh1socJPpIxW9m/KqkSC8xARCaaXeVbXby3i8eeKeHKwQyLZGXIZsNz/+Xr9qWzU8NeQj1DseV8lotWHB4A7kOfM5fV8FRNcwlVIaCPv3cbZUT8X/b6K8N9e/F8GPBrmj4hmP3nN6sxXbeHrz0y/H1+Bact38AF7LlPw==
sidebar_class_name: "delete api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -25,7 +25,7 @@ import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Delete purchase order by ID
Delete template by ID
</h1>
<MethodEndpoint
@@ -37,7 +37,7 @@ import TabItem from "@theme/TabItem";
For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
Delete template by ID
## Request
@@ -59,7 +59,7 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"template_id","in":"path","description":"ID of the order that needs to be deleted","required":true,"schema":{"type":"integer","format":"int64"}}}
param={{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
@@ -5,7 +5,7 @@ description: "Multiple status values can be provided with comma separated string
sidebar_label: "Finds Pets by status"
hide_title: true
hide_table_of_contents: true
api: eJztVttu4zYQ/RWCT13AsZx20QdjUTTdpkHQbWPAKVogMQpaGlncSCSXpOwYhv69MxRlyXYMBNt9zEtiDedyODeeHfdi5fj0gWc6rStQ3vHFiGfgUiuNl1rxKf+jLr00JTDnha8dW4uyBsdSodgSmLF6LTPI2Eb6gqW6qgRzYIQVHoXOW6kwwohrAyhCj7cZ+sylymbg3S/beXCKCmRSgQdLeHZc4Qcquu5YEpQvNdgtPwY4P8DlC+GZAgzuNQFMtXII0KIg15blssQY6MPCl1qilE9zUToYcXg2pc4wqLc1frq0gErw6Y77rWmh0F1C9FxgTlAk1kKWYlkCSkHVFWVyKDOgstbG6TLji6ZZUGBnEBM48v39ZEL/Di/k6jQF5/K6ZPu0oQ+8iccSkb4wppRpOEg+OzLanQIW1grKlvRQhWD9lR/a/CLCQnv9ly1D3aOdXn6G1NOhpfBetlBlNvAtEcoq5BGTWgnfin58T4l4FhW2C59eTppRrONpEvda2HqrlQSOunghWGmscK//zbC8CsqvGnu1QdXnqiTN2IR7XHjipQ+qHweyPomnyY+eNhZLRpmn5moGNTkGcxi584ygKHYY1q8N8b9SeTZ9p9lClMNE3YtWKU7yi/M0bH4Dvts0UuE0097R9vUTdpJC8EM4M/okreEIRYu3CXqboLcJeuUEkd77l16vW4UvscwO6EKLH9LaSr8N77sw8t8noN8LehTx5S80MYMVhAQLX+BH0tGSUjoSO7DrjiDUWNMpL7w3bpokWLgx1gSf+pXCm7kxMhEUymR9ycl/F3tOI96WbY+gbwcjfwfqh3jxfy5mwjq4uOrkgYQUIJBOhBtJletgH1NzhwjmiIBdzW4ZRj6uzH0hsSYuHHdXCxsoUJMja7YUDkmLbktIhyT/YXzJnIFU5nF5jdmjelRzXQGrHRBnKKV6ctNHdcEe7nJUk6Jkf8PSYTsvvusSttlsThL2LtjcIJGrl8yC0b36KghDVodW+493eFfkVZW7y+dYJJlCLM6ZUElQTiKrEWlgNbh8JRU1in4+NqIuxJ2NQhi059XN7BOmZYK++p54BeTk0+3H6z/n1+SVuqot0eV4gq5oJWnnK6EGgX5D0uoY0Va23LI9Mz0o8a5nad+IOMfe9PDsE1MKbMEmXnQXx6Rn72FMsNsLxE7y3Y56CLdf05C4pc80PJl0NP49+T17ia8j1y+CDsPWM/p2MUx5mM+1sDIsJNoHo27GCGprdYWM2PiB1QkDPtgiN9f3qCtqSs9wvJ/CGMcf5L07UtuB75O5bzHQ32Z0xuYDDSdq/7RXj4vvnEG8YqdNKcLd2/wHPTKgNQ==
api: eJztVk1v4zYQ/SuETl3AiZ120YNRFJtu0yDotgngFHtIjIKWRhY3EskVKTuGof/eN5RkyXYMBNs95pJYw/l4fPPB2UZeLl00fYgSE1cFae+i+ShKyMWlsl4ZHU2jv6rcK5uTcF76yomVzCtyIpZaLEjY0qxUQolYK5+J2BSFFI6sLKWH0PlSaUQYRcYSRPB4k8BnqnRyR979tpkFp1Bgk4I8lYxnG2l8QNF1x4qhfK2o3ESHAGd7uHwmvdCE4N4wwNhoB4AlBKkpRapyxICPkr5WCtJomsrc0QihNjmHhFaBc3q2uUkg8GXFp3FGhYym28hvbIOMrxbApBIUQSRXUuVyAS8w11XBxA5llnTS2DiTJ9G8rueMw1lAJMe+f5xM+N/+/VwVx+RcWuVixyJ84GIeGWN9aW2u4nAw/uLYaHsMWJalZPKUpyIE6xl4aOgGwsx480+ZhzJo7cziC8WeD0sO71UDVSUD3wpQloFWZk/6RvTz+8CjLCwTezGpR21aj0ncaaESl0tFEXRxIVoaJLzX/25YXgXld4PSraH6XOSs2dbkDhdOvPJB9eNA1pN4TH7raV0iZcw8F1c9yMkhmP3InWeA4tihd781xP+i8iR9x2wB5ZCoe9kotY39Yj8Ni9+S7waP0mhuHkOmfH2HHVFIfgjnjj9Za9hCrcVbB7110FsHvbKDWO/9S6/XjcbDrJK97aHBT3FVKr8Jz7206t8n4t9zfhSxCGSGF4UlBYKlz/Ax7raUXDkWOypX3b5QIafTKPPeuul4jMSdIyd4+ZcaN3PnWEwgVOPVRcT+u9gzbvEmbTsEfTlY9SdxPbQXfz6D5MybJ9LdQpKRxGoRrqN0aoJxy8stws8QXlze3QiEPUzLfaaQEBeOu3uF8RPWlANrsZAOC4xp8seHLP/p/EI4S7FK28l1Lh71o56ZgkTliBeGXOknN33UZ+LhNoWakrn4TAuHWp7/0LG1Xq+P2HoXbK6x1FULUZI1vfoyCAOlQ6vdxzvcFTtW4W7TGTKkYmozcyLUOCiP25VGxmGlweRVnNFW9OHQiEsQAxtCGtTm5fXdJ9Ayga++IF4Befzp5uPV37Mr9sol1aTo4nwCVzyPjPOF1INAf2CBdYJXWLHYiN2Wupfibb+ifaclui1MT89+bHOJEqzbi27bHuk3+dAjKPUM2Fm+3XINYfTVNYubVZo7J1GOe79fhE9e4tsW7RdBh07rt/tmKkyj0JwrWaowjXgYjLoeY6iN1SXWYesHVkfr794Iub66h66smJ5hbz+F3m5/sPfuSG8GvvebvgHAf+vRCYNfuDMxN37dqbcj75RBe79Om/nB1K3/A98eo4I=
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -59,7 +59,7 @@ Multiple status values can be provided with comma separated strings
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"status","in":"query","description":"Status values that need to be considered for filter","required":false,"explode":true,"schema":{"type":"string","default":"available","enum":["available","pending","sold"]}}}
param={{"name":"status","in":"query","description":"Status values that need to be considered for filter","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"available","enum":["available","pending","sold"]}}}
>
</ParamsItem>
+2 -2
View File
@@ -5,7 +5,7 @@ description: "Multiple tags can be provided with comma separated strings. Use ta
sidebar_label: "Finds Pets by tags"
hide_title: true
hide_table_of_contents: true
api: eJztVt1v2zYQ/1cIPq2AYtltsQejGJq1aRC0Www4xQYkRkFLJ4uNRKokZccw9L/vjqIsxY6BYFvf8iKbx999f/B23ImV5dNbnuqkLkE5yxcRT8EmRlZOasWn/I+6cLIqgBGWJUKxJbDK6LVMIWUb6XKW6LIUzEIljHBItM5ItbIj9tV6tklE39f++4Zl2jAH1iFkxCOuK0Au1HWVorZMqnQGzv6+vSHTIk4yS3BgyM4dV3hAmGsvJRn4owaz5YdmEztzmmWyQGa2JISBH7U0gHoyUViIODxUhU5RoDM1Hm2SQyn4dMfdtiI1whhBjNJBaQf01kHeNM2CpNpKKwse8Ho8pp/Httg6ScDarC7Y3luUmmjlMOaEF1VVyMRfxN8tMe2eYU3vz20bGAxXrp3+agqfyMCnl98hcXRpSL2TrakyHciWaMoKDIIwPaVwLenXt5yCJErMP59Oxk0UEnAYiQEKa2m1ksARiw7BSmNyevz/ZsuzTPmosUwahD6UBSFD9eztwhsnnYd+GND6IB4HP0jaGEwZRZ4qpzlZIYeaO8lUOlHovn+r4j+F8mT4jqOFVg4DdSNakHXC1U+6/Lj4K3CsxTKpmMsBT9pQrYKqSypdsRayEMvC1y+otJVidZHyxbE5KG9ozoyOhBq2UOB46aCXDnrpoGd2EOHePvV6Xam1KGRKjzfDfzW0xkNSG+m2/lUWlfx2D/R/QS8ivte5ptd8BT66wuV4iLslIybbwKy7N73GbE557lxlp3GMKRthNpSVK4U+2RFuF0iU8XrCSXineE7N3SZsr74vhEp+BqqE4PLfZzNhLJydd3S/OeQgUkwtuSNVpj1/CMo1WjBHC9j57Iqh5qP1IpeYDeuvO7/87PHrzQE3WwqLa5Fuk0eXRH8zmjBbQSKzMLZG7E7dqbkugdUWaFsopLq30zt1xm6vM4RJUbC/YGmxkBe/dAHbbDZHAXvleS5xOauXzECle/jKE31Uh1z7wyv0FTem0l5nc0ySTCAk54Sq2IPjsM+IxO8zOHYlJTWQ3h8yUf3htEYiDArz/HL2BcMyRll9TTzD5PjL1YeLP+cXJJWqqk3RZDRGUTSMtHWlUANFn3DLtIz2TFwMWVgmHyV4129nP30DDjXr4MHFVSGwNJsQgF3onX5BRzi9Szm6ROTdjkoLx2HTELldhamnUmlpHvSr7knvnlqUn7TId1i3ebeDYMp9S66FkX76UP9HXVuRGS3POa6/lRtwHa27j6bG5cUNYkVNng87+t53bvhD0rsrtR3IPmr11gb6NtEJnnfUj4j+bQ8Pg+4UQ3CxQ1OAcNA2/wDHj4Is
api: eJztVktv4zYQ/isET13AsezdRQ9GUTTdpkHQbRPAWfSQGAUtjSRuJJJLUnYMQ/+9MxRly3YMBH3ccpHN4TfvB2fLvSgcnz3wTKdNDco7vhjxDFxqpfFSKz7jvzeVl6YCRliWCsWWwIzVK5lBxtbSlyzVdS2YAyOs8Eh03kpVuDH74gLbdETf9+H7geXaMg/OI2TMR1wbQC7UdZOhtlyq7A68+3lzT6aNOMmswYMlO7dc4QFhvruUZOC3BuyGH5tN7MxrlssKmdmSEBa+NdIC6slF5WDEnd9UJA5NqvEenk2lMyR429BtWkIt+GzL/cYQTFgrSI70ULsBvfOXt227ICXOaOUgAN5PJvRzaJpr0hScy5uK7ZxHqalWHlNAeGFMJdNwkXx1xLR9hTV79x66OGH0Su31F1uFvEY+vfwKqadLS+q97EyV2UC2RFMKsAii0Ajfkb7/GIIkakNRm07aUczHcSQGKCytopDAEYsOQaExV3v8f2bLq0z5RWPVtAh9ritCxmLa2YU3XvoA/TSg7YN4GvwoaW0xZRR5qpz2bIUca+4lU+mMYjP+UxX/KpRnw3caLbRyGKh70YGcF7550eXD4jfgWYdlUjFfAp60pVoF1dRUumIlZCWWVahfUFknxekq44tTc1De0Jw7OhJq2EKR462D3jrorYNe2UGE+/jS63WjVqKSGb3lDP810BkPaWOl34RHWhj51xPQ/wW9iPh8l5oe9wJCdIUv8ZD0O0dCtoFd9U98g9mc8dJ742ZJgikbYzaUk4VCn9wYlw0kymQ15SS8Vzyn5u4StlO/LwQjfwOqhOjy8wVSLrx+AtVvESWIDPNKvkiV68AcI3KL6ueonl3e3TBUe7JqlBJT4cJ171QYPGHVOeJmS+FwRdJd5uiS6B/GU+YMpDKPM2vMHtWjmusaWOOAVoVKqic3e1QX7OE2R5gUFfsTlg6rePFdH631en0SrXeB5xoXtWbJLBi9hxeBGEI65Nod3qGvuD3V7jafY4ZkCjEzZ1QlAZzEZUakYZnBmSspo5H00zETFR+OaiTCoCovr+8+Y1gmKGtfEK8wOfl88+nqj/kVSaWS6lI0HU9QFE0i7Xwt1EDRr7hxOkY7Jy6JLC6WBwne7lez/30bjgXr4dknphJYmm0MwDY2zn5ZRzg9SiW6ROTtlkoLZ2HbErlbi6mhMuloGOzX3rPevbQ0v2hRaK9+C++mwIyHflwJK8PooeYf9W1FZnQ8l7j7Gj/gOtl1D0bG9dU9YkVDng/b+Sm0c/xD0vsrtRnIPuzzzgD6tqMzDD9QM+Ko+HEHjyPuHEP0r0dTdHDEtn8DnqqFeQ==
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -59,7 +59,7 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"tags","in":"query","description":"Tags to filter by","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}}
param={{"name":"tags","in":"query","description":"Tags to filter by","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}}
>
</ParamsItem>
+1 -1
View File
@@ -5,7 +5,7 @@ description: "Returns a map of status codes to quantities"
sidebar_label: "Returns pet inventories by status"
hide_title: true
hide_table_of_contents: true
api: eJyVVG1rGkEQ/ivLfmrAeCb5JqVUSgjS0EhNacFI2VtHb5O73c3unKkc/vfOrHdqDIFWRO9mnnl23p5tJKpVlMOZXDhdV2AxynlPLiDqYDwaZ+VQfgesg41CiUp54ZYiosI6Cu0IJ9CJ51pZNGggyp50HoLiyPGCYleAY7smXhc25AwQvbORgMNGXg4G/Pf6sFhrDTEu61LsmShQO4vEwnjlfWl0cmSPkYMaGXUBleIn3HggGpc/gkYKVIuFYagqJ4EJU5YHnCHaFQQCLl2oFO5MV5dymz49GUHXweCGesRHm99PwM/zLbWpAixcWyUxeIUFvWQ6gELoGiqZI6whxERRh5IwBaKPwyyjWvqUlY1mZUuVx752FRlNtr6QfEJ3+pTr2yW+z2FfA1m+AnfXqorff51PVIhwPurshhtbgFpQoVyTsUuX4g2WHHBHGUwpAzGajAWdfLoA94WJgr7s7spK/RfUNHESLXIVYSHIiQUkJ9uv+hcietBm2Y6uLx7sg526CkQdgcddGvsUhw/2XMzulgQzqhQ/IY8GYf6ha9jLy8ubhp2lmBuDRZ2LAN4d4KtkTF09jtq/nFGtCKGKd8spDcloaIfzzlFZAmftQiqdFpI2z/BQW9Pn0yBJLaeNJSMwvJ3S6GZyS20ZENdhJ/4h5ex2/OX62/SaWXmrdiO66A+IikzeRayUPTqok68HFKbVIolA5JtWyKfzbg5q+0/ttwuJ8AczXyrau21bXdOqYyZP1EFLXlDK7GkaXp0fodxu2fxcQ0hSozpVMCrnXSXh9bpVZjklJcgR3RmelbZWZb2TxMkd8UquN9f3fDPUnNCxip6SWtoHZu9cdnPE/UZeuxz4d9t7J+Yja4DQn/bwnefdgLbEDs2dnNN99Bf1+fU5
api: eJyVVG1r2zAQ/itCn1ZI47T9FsZoGaWElbUsHfvQhqHI51iNLanSOW0w+e+7U+wkzShsISTS3XPv96iVqBZRjh9l7nRTg8UoZwOZQ9TBeDTOyrH8AdgEG4UStfLCFSKiwiYK7Qgn0ImXRlk0aCDKgXQegmLLSU62C8CJXZFfF9akDBC9s5GA41aej0b89z5YbLSGGIumEjtPZKidRfLCeOV9ZXRSZM+RjVoZdQm14hOuPZAbN38GjWSo8twwVFX3gR2mLPc4Q24XEAhYuFAr3IouzuUmfQYygm6CwTX1iEOb30vg82xDbaoBS9dVSR68wpIumQ6gEPqGSvYRVhBictGEijAloo/jLKNahpSVjWZhKzWPQ+1qEppsdSY5Qh99yvVtE9/lsKuBJN+Au2tVzfe3U5KcolsCd85wV0tQOVXJBRlbuGRssGL0HYWfUnhxdT8RFPZ4+g+liYK+rO5rSs0X1DFxZC3mKkIuSIklJCXLL4ZnInrQpujmNhRP9slOXQ2iicCzroxdxvGTPRWPdwXBjKrEL5hHgzD71Hfr9fX1r26dJJsbg2UzFwG828MXSZhaemi1u5xQrQihjnfFlCZkNHST+SBUlsBZt41Kp22ktTM80U50eWwkqeW0riQEhncjurq5v6W2jMjXfiH+IeXsdvL1+vv0mr3ySm1HdDYckSsSeRexVvYgUM9dDyhMR0RigJivOxYfz7vdU+0/id9tI8IbZr5StHebrrq2o8ajPKIGbXhJKbOmbXl1foZqs2HxSwMh8YzqVMGoOe8qsW7QrzJzKdFAXtGD4ZlmK1U1Wz4cPRDvuHpz/cDPQsMJHVJomSjUHdh7r7LrA9/vubVNgH83gw8MPjMBiJ5fdvCt5kODrr4ezW2c0Uv0B0/s87M=
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
-319
View File
@@ -1,319 +0,0 @@
---
id: get-order-by-id
title: "Find purchase order by ID"
description: "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions."
sidebar_label: "Find purchase order by ID"
hide_title: true
hide_table_of_contents: true
api: eJztVm1rIzcQ/itCny7geO1c2rSmLU2bXDA96lBfaSEJh7w769XdWtpIWifG7H/vM9p1snHSNv1SKBQMXo2eZ2Y0b9JWBrX0cnIlA62qUgXy8mYgM/Kp01XQ1siJfGedWKtSZ8KRr6zxJILbCG0CLcmJ6ZkXdzoUjKlJfPOt+EKA8Z0Yj4ZiFgpy7Q6jylIsyZCDIUH3KUUTfigH0lYsxWqaweSSwsxl5H7YYDmQlXJqRYEcu7qVBguAdi5/1IzR7GqlQiH3/Z+eCZvDJegToVBBGKLMi2DFgkROIS2IFTi6rbXD5yS4mgbSQ75ScrKVYVOxve7AgObWrVRoRV8ey6a5YXobG8+Mo9GI/5764es0Je/zuhQPp4Wy1EKvCYxXVVXqNG4knzyTts/dsItPlAaOimM1QbcmEYRXuDqQdK8QNoDGowY6KEz/MfHrr05OjkC+rZUJOmz+lv/2qM8/AdUXujpD7npUH5w2yz4zA+AwaCSbGUGF2r+EfxrlWDdi3qJ7Vjm4zq5jqsnUKy56lE8aBb29jEq9Jq6Dm4aTw+wnfi6sLUkZZH0g71cl73QFGUuMfUVQoslZK2gGTzLbkf5P7H8/sQw9fqnXp6admJg9vubcw2zEHj/HtgczNojc1iaL9jHtCttNwjgAMdcmMtmNvGTbG34NAJ7cejceawffZRFC5SdJgggMUU7G66Up1cIPcXIIdbIeS55bntLaIddzLse24rD78TP1sw/JTxAMdgH5/fBSOU+Hpzt5nL4FqV29a5PbyN8FDB7M4YE4vZwKWN5P7odCe4Efb2c2rVeYiLFbEBMn9thioTxlApu4XeImy98Ox8JXlOq8a7ShuDbXZm5XJGpPPHZLbT77ybU5FFezHDCtSvEbLbwOdPNmF7C7u7tnATuInAvccvUCt2BlH+HLKIxR7bMeFgc4K26ulZ/lcyRJp9Ql509MJRGcdBeDSuPFgEGhOamd6Pt9EtcW5guE1Cvb04vL9wjLCLoea+IVLifvpz+e/zw/Z61cVW2KxsMRVPFosT6slOkZeqdNJqrapQUS0920iw2Kfz/P28fb7t95VnT1G+g+JOgXlGnTBWPbNdXj0wfwSf9NgeYocFSGbLdccr+6smlYfFuTQ3tc4XOtnFYLrnF0XqY9f6Nvc1V6+ovDv/mle20ciFc+T148ya49DfdgDAdW+Izd++SB1PDQ6xqUXW0RpykHq8d99gLhEfEwjC7OP6C7/wB/6nim
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Find purchase order by ID
</h1>
<MethodEndpoint
method={"get"}
path={"/template/{template_id}"}
>
</MethodEndpoint>
For valid response try integer IDs with value &lt; 5 or > 10. Other values will generate exceptions.
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"template_id","in":"path","description":"ID of order that needs to be fetched","required":true,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs>
<TabItem
label={"200"}
value={"200"}
>
<div>
successful operation
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": 10,\n \"petId\": 198772,\n \"quantity\": 7,\n \"shipDate\": \"2023-12-24T21:10:12.539Z\",\n \"status\": \"approved\",\n \"complete\": true\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem><TabItem
label={"application/xml"}
value={"application/xml"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"<root>\n <id>10</id>\n <petId>198772</petId>\n <quantity>7</quantity>\n <shipDate>2023-12-24T21:10:12.539Z</shipDate>\n <status>approved</status>\n <complete>true</complete>\n</root>"}
language={"xml"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
Invalid ID supplied
</div><div>
</div>
</TabItem><TabItem
label={"404"}
value={"404"}
>
<div>
Order not found
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+2 -2
View File
@@ -5,7 +5,7 @@ description: "Returns a single pet"
sidebar_label: "Find pet by ID"
hide_title: true
hide_table_of_contents: true
api: eJztVttu4zYQ/RWCTxvAsZw26INRFE1308DoojHWKXaBxFjQ0sjiRiK5JJXEEPTvnaEkS74VQdvHvNgieWbmcC6cqbgXa8en9zzWyovYO74c8QRcbKXxUis+5Z/Al1Y5JpiTap0DM+D5iGsDVhBkliBoDX4O/rcNLkbcCCsK8GBJc8UVLhDSWvgqCSJJsxE+4/vmZh+YTskG85rZYBsxFr6X0gKa8raEEXdxBoXg04r7jSHtUnlYg0Voqm0hfLP10yWv6yWJO6OVA0cSP0wm9Ldr1pVxDM6lZc62N0NlRBqUJ7wwJpdxOIi+ORKqBjR6gvfNhdENmfb6L5sHn7Y09eobxOQ+Y8mMlw0l9MkrrjLi8CIKkyPoYlKPWsdu5Zy3GKAhiid6vZbAEYvEYa3tZoD/37i8isoHjYlWI/SlyAnZZUXHC0+89AH6frDXO7HXLqwVG77V9GwxNF1qoIj0ULhjZHYtd5qRFNkOdfBvTfwnV55036G3kOXQUXeiATkvfHn0yrtJTlXVYJlUzGeAK20pV0GVBaWueBIyF6s85C+opNHidJ7w5SEdegkGdOa0xPWwUlqBt0J5K5S3QtktFIJdHutFM/UkcpkwbIWupFpChwbs5SEWVTGlPUt1qZLmjhCXVvpN6L3CyK+PQN9L6oPYlTPd9uvQqLEBT3nUtuao6nt0TbcB+9Q18RLjP+WZ98ZNowiDPMb4KSfXCr3gxrEucFNGTxec7HQcFlT2TYi3TPrUMfIPoNxpnfTlfC6sg/Orbj8MCRmIBJOBbiZVqoN868ZbZLBABuxqPmNoeT+Kd5nE+LlwnOi4LLCTh1cJvWXZnjRbCQcJ00246ZD2fxxfMGcglmn7oI3Zg3pQC10AKx3QuJBL9eimD+qc3d+mCJMiZ59h5TD1l+86hz0/Px847CzI3EiflSucdIzu4euwGbw6lNouzvCuOF8V7jZdYJBkDG1wTpiKAjhqBxqMMLkRH2SZ94PZr/tClHP4juMmDFL56mb+Ed0yQV19TryCcvRx9v76z8U1aaWsakJ0MZ6gKnq+tPOFUANDv0uVhDlwtcFK2A9u1Y9mpybUNs08vPjI5AKzqW45V23mb8deRE8H8ylmcIZ8CFBVlBf4+tU1bX8vwYZqwksIK8MDQOWRSEffWFqpyB38A9l3n9oGeMaOj7pHaXclo6gu8HUoaYWfoaKGo3W9RHRbM0SsAVzhcGv8QPRgmN15HW6u7xArSvLRsFwfQ1m2H6T9KK2DOm440G89OiHzMxUbon/ZwpuTkwLtFTs0eQnf3fpvF4pUHA==
api: eJztVktv4zYQ/isETxvAsZw26MEoiqa7aWB00QTrFD0kxoKWRhI3EsklqSSGoP/eGUqy5BcQtD3mYovkNw9+M8OZmnuROT5/4LFWXsTe8dWEJ+BiK42XWvE5/wK+ssoxwZxUWQHMgOcTrg1YQZBFgqAM/B343za4mHAjrCjBgyXNNVe4QEhn4askiCTNRvic75tbfGI6JRvMa2aDbcRY+F5JC2jK2wom3PlNQUqdLA1+TDi8mkInuJWKwhEgzqEUfF5zvzGElMpDBhahqbal8O3WT5e8aVak3xmtHDiS+GE2o79dv1wVx+BcWhVse3VURrcC5QkvjClkHA6ib46E6pEbww0eWkaQp1x7/ZctAumdm3r9DWLi11gy42XrEpL2hqsQDSIQMr+YNZOO+a2c8xYjOEbxRGeZBI5YdBwybTcj/P/my5tc+aQxExuEvpYFIfu06f3CEy99gH4c7Q0kDtqFtWLDt5peLIamzx0UkR5Kd8yZXcu9ZnSKbIdC+bcm/hOVJ+k7ZAu9HBN1L1qQ88JXR6+8m+RUdi2WScV8DrjSNtSXqkpKXfEsZCHWoeYMqKTV4nSR8NWhO/RUjNy5oyWux5XSCbwXynuhvBfKbqEQ7PJYL1qoZ1HIhGGvdBXVEhIasJeHWFTFlPYs1ZVK2jtCXFnpN6E5CyO/PgF9r6gPYtvOddfQQyfHDj3nUde7o3po4g3dBuxz3+UrjP+c594bN48iDPIU46eczBSy4KaxLnFTRs8XnOz0Piyp7NsQbz0ZUsfIP4BypyPp9Rx3zr1+AtWPEDmIBDOBriVVqoNwx+Etml+ieXZ1t2Bodj+E97nE4LlwnOi4KrGNhycJqbJsT5qthYOE6TbWdEj7P04vmDMQy7R7zabsUT2qpS6BVQ5oViikenLzR3XOHm5ThElRsL9h7TDvVx96tl5eXg7YOgsyN9Ln1RrnIKMHeBY2A6Vjqe3iDO+K01fpbtMlRkjG0EXmhKkogKNumsHwEo34GstiGNt+3ReihMNHHDdhlMdXN3efkZYZ6hoS4g0uR58XH6//XF6TVkqpNkQX0xmqordLO18KNTL0u1RJmBLXGyyD/eDWw1x2an7tcszDq49MITCbms7nukv77VCM6PloesX0zdEfAtQ15QU+fU1D298rsKGU8BLCylD9VBuJdPSdbKfTk85++NJ1vzN2fBA+6nZfL4qKBZ+Gilb4GcppPHg3K0R3NUOOtYArnGyNH4keTLI7T8PN9T1iRUUcjWv1KdRq90Haj7q1W8StA/TbTE4I/EyVhu/AL1t4e3JSoLtfjyaK8MVt/gG/tF3l
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -59,7 +59,7 @@ Returns a single pet
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"contact_id","in":"path","description":"ID of pet to return","required":true,"schema":{"type":"integer","format":"int64"}}}
param={{"name":"contact_id","in":"path","description":"ID of pet to return","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
+219
View File
@@ -0,0 +1,219 @@
---
id: get-template
title: "Get template by ID"
description: ""
sidebar_label: "Get template by ID"
hide_title: true
hide_table_of_contents: true
api: eJyVVU1v2zAM/SuaLluBNG63nXJasRZBsKItlg47tMUg23Ss1pY8ic4HDP/3kYqduGk3rECAWBT5SJF8ZCNRLbyc3EmEsioUgpcPI5mCT5yuUFsjJ1KOpK3AKT7OUhIsAG87dbqrlFMlIDjGaaShA+n0eL90SjqacSqFuTwEn50Lm4leW2CuUBiA1Au0IgaRASY5MIaD37V29DlBV8NIetwU7MlrsuVAYF0VNiVRpgrPCmRYKjlpJG6qoIlOmwVpZtaVCrcSErTtA8P7yhpPCSCDjycn/Pc8VF8nCXif1YXY5YPAEmsQDLK+qqpCJ+EievRs1LyMwsaPkCAnzjEM6q3Lq5C3f8e6lcBahReTKHzssifbkbyy+GaYmwKUB+FgqWEllEmF1wtDtdBepDapS34eYZ8P0/E2F7sCD1NKkD++X74VKkes/CSKNrZ2ulQLGCe2ZCwOOnThDk85pzZD4zv5aOHLolS6CFYjOudmIKBGWJcFQ3R93IOO5MpRefv2I3ea3uRfC34fKjvrTp2718EJDTUWz0QtZ6FIwTHl3pah9aOP1elUrW8CzHOfiQOqw7BleteHNy0bf36NCT37hbEoMlub9J0Mup9f6s7MUhU6FWc3M3Frn8C8ex+iopGR226ahClCw2Eio9591AwmSEsKHtyynzG1KwaNQGUZE5MMp65QsedUk1BHy1PJzPaQUKfgZs5M3JKNbn89wWbYKpX+BtwrXZrWxyQ5Rg64n185KCpHCF6bzAbjLnXX5H7OnOFXktvDKXfLVKIfX/eMCmOCsufEgbWIiY2psMxACJcs/zQ+Fb6CRGfdhBmLe3Nv5rYEUXvgqVRo8+Qn9+ZY3F1npKZVIX5C7KlTHz702VqtVi+ydRRsphrzOqYxUNm9+iIIQ0qHVrvDEb2VZn/pr7M5VUgnPUX/4ioKylE3N1US5iYw/7gDt6Ivh0bcXDRYSQiDTj6b3lxSWk4Ia98Q/xFydDn7enE1v2BUbqltiU7HJwRFosp6LJUZOJoC7jdUvBGz88MCN/stwOuy6ymENUZkpcOoCzE2XaPvFy6pT4bLkho2pwhYpWm4E364om1Z/LsGRy17R59L5bSKw0QjvmnP3+lu8f01tA/fux16JP5/7776mJ41hilDBK9h+/JAqmfLv30g9Y46HO1W44xWaYUD2xerk5m7mxHTi1vi3R8/Pvp4
sidebar_class_name: "get api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Get template by ID
</h1>
<MethodEndpoint
method={"get"}
path={"/template/{template_id}"}
>
</MethodEndpoint>
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}}
>
</ParamsItem>
</ul>
</div>
</details><div>
<div>
<ApiTabs>
<TabItem
label={"200"}
value={"200"}
>
<div>
successful operation
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"Name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"sample template"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Note"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"template description"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"URL"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"https://yourimage.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"signers"}
required={false}
schemaName={"signers[]"}
qualifierMessage={undefined}
schema={{"type":"array","example":["joe@gmail.com","john@gmail.com"],"xml":{"name":"signers","wrapped":true},"items":{"type":"string","example":"joe@example.com","xml":{"name":"signers"},"title":"signers"}}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"folderId"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\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}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"400"}
value={"400"}
>
<div>
Template not found!
</div><div>
</div>
</TabItem><TabItem
label={"404"}
value={"404"}
>
<div>
Invalid API Token!'
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+1 -1
View File
@@ -65,7 +65,7 @@ Some useful links:
<th>
Header parameter name:
</th><td>
X-Parse-ApiKey
x-api-token
</td>
</tr>
</tbody>
-436
View File
@@ -1,436 +0,0 @@
---
id: place-order
title: "Place an order for a pet"
description: "Place a new order in the store"
sidebar_label: "Place an order for a pet"
hide_title: true
hide_table_of_contents: true
api: eJztV21v0zAQ/iuWPzGpaZpsMOgnBkyoArGKDoHoJuQm18aQ2MF2uk1V/jt3Trp6BTT4CpMmLblX+57nLtcNd2Jl+XjOHVR1KRxYfjngOdjMyNpJrfiYT0uRARNMwRXTJgfDpGKuAGadNsAHXNdgBBlPcjSvyfyM7FBl4HsD1r3Q+Q0fb3imlQPl6FHUdSkz7xZ/tZRow21WQCXoyd3UgLH04itkDuPUhpI4iedDrcwDG4khVz7ZUptKuE705AgFcC3wVmiUjFqMAW7y147Pnh4fp+j8vRHKSXdzr/9hGvofo6stZP0KSxu4WmekWoWeORpETlbAycMJ19hf2d9FxleZzTrrICsV1+g15CRUTUUAe1hIEOhyKOUaDD5fYtZMk/edcy60LkEo3qL6uipJo0TlkfEAoxiL4lN2iJNhiGzv9ADsPwdsdHV1FdEto8aUoDKdQ/4A9b8BNZkasLVWtgMrHY3o392T2ybLwNplU7LbLwAfPMz4/4MfR6PHP1NiotailDkuCHXjfMQKXKH9WqCtB1m4At/izABWY7t1oMKCwWPSLrLhOFHQpnCutuM4xssMkRnKypUqxcIO8RIolPE64e0leWaNQdhmxKyOPKj98g1CIFHyBgWD7d0+RVNhLEQnW7mk8xcgtsOO+Pp+t72cbuveMTMZ3XKto0/InuOQD9g76WGUpFF6dJ4m6DhO0uHjNPnMdxwI8doh5EwDLR1sqf1FtiBgKWZYCnYynTAswT5hzgtpGf6ROtdZU2Ez+hZkSES2580WwkLOdLfQkZLkh8OE2Royuey7d8gu1IWa6QpYY4E6vpTqmx1fqIjNz5ZoJkXJPsLCSgeXj7bI4SfiJ+QOvM9r6YpmwQzUeme+8kIPb+h1+3KAd3VgKnu2nCFbZAY9S36TKvbGcT+TROZnEg4fSezqRc/3nYjvOLRQCEErnLyevsWyjDDWjpx/cOT47eTl6bvZKUUlencQJcMRhqJxhU1RCRUk6pdt1W/aBJlgyLR9mINd+v4Fve8BB9cuxn5Dqrf9PTZ9Q875XkNiXxXUsajZbIgkH0zZtiTGljBI8jk+roWRYkGsnNNw6buHOtg3H3/ZHTE6p/xkXjb95Lpnj2gH2xAn+I2p3W+c/TeFRsDtlJmezc7ReNH/3qgwGkqDyIPwhY7dtj8ACuxm9g==
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Place an order for a pet
</h1>
<MethodEndpoint
method={"post"}
path={"/createtemplate"}
>
</MethodEndpoint>
Place a new order in the store
## Request
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"request"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"application/xml"}
value={"application/xml"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"application/x-www-form-urlencoded"}
value={"application/x-www-form-urlencoded"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<TabItem
label={"200"}
value={"200"}
>
<div>
successful operation
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"petId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64","example":198772}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"quantity"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":7}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"shipDate"}
required={false}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"status"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"complete"}
required={false}
schemaName={"boolean"}
qualifierMessage={undefined}
schema={{"type":"boolean"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": 10,\n \"petId\": 198772,\n \"quantity\": 7,\n \"shipDate\": \"2023-12-24T21:10:12.539Z\",\n \"status\": \"approved\",\n \"complete\": true\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem><TabItem
label={"405"}
value={"405"}
>
<div>
Invalid input
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+14 -8
View File
@@ -11,26 +11,32 @@ const sidebar: SidebarConfig = [
"items": [
{
"type": "doc",
"id": "API-docs/place-order",
"label": "Place an order for a pet",
"id": "API-docs/createtemplate",
"label": "Template Creation API",
"className": "api-method post"
},
{
"type": "doc",
"id": "API-docs/get-order-by-id",
"label": "Find purchase order by ID",
"id": "API-docs/get-template",
"label": "Get template by ID",
"className": "api-method get"
},
{
"type": "doc",
"id": "API-docs/delete-order",
"label": "Delete purchase order by ID",
"id": "API-docs/update-template",
"label": "update template by ID",
"className": "api-method put"
},
{
"type": "doc",
"id": "API-docs/delete-template",
"label": "Delete template by ID",
"className": "api-method delete"
},
{
"type": "doc",
"id": "API-docs/create-user",
"label": "Create user",
"id": "API-docs/template-list",
"label": "Get template list",
"className": "api-method post"
}
]
+297
View File
@@ -0,0 +1,297 @@
---
id: template-list
title: "Get template list"
description: "Get template list"
sidebar_label: "Get template list"
hide_title: true
hide_table_of_contents: true
api: eJytVm1P2zAQ/iuWPw2p9GWb9qGfxhhjaGiglWkfSoWc5JIYHDuzHdqq6n/fnfPSUBgwaYBQcr7nXp87Z8O9yByfzrmHolTCg+OLATclWOGl0WcJn3ZH59J5PuAWflfg/CeTrPl0wxNwsZUlaaNuac29TIBFoMySlcKKAjxY5g3LwDNdFRG+mZTt/A14bLQH7cmaKEsl4+B7dOvI5Ia7OIdC0JNfl4BOTHQLMYWC3jBSL9EKnipZSN9Tk2g1A4t6qbGF8LXo3VsUwEqge1SajLcD7u5k+Y+48RZxq0IRTGOOqKOwPBEVBU+89OqhbEsAC6402tXhJpCKSvnHNXRVHINzaaVY14j/VyWZ9HSct1Jn/Uw7SZcqX02+Rrpwby8zSu3nj/OnDOzUc+9LNx2N2g5XDuwwNgWBv4dSPYd24aGjRwAZ/wKo1Wba1JDP/YK+DkmRIfKLUQn2/llQGnQ6yExmGqzrYYS1Yo0Qiebdyy2pxWfJixz88P51Rbw1GFiPhm2WN22odHhsAUWf1q8sUEzqps36Efv7Ddt3G9iP8oc0P8V90FlX9W7BZZEb2jmlCe+l8Dm+dVxq1JBR96Hi8w2vrOqRDidjiKXVDhNVInJEPBTK0f2EbxeEjCsr/XpG01JXH09v7qBfBpR8A+pfk9vqECWH3twBzaGk4HMQRBPKigbwx24nnrSl6xbSZNyuGFo2Uqcm+GqKdIHRUlvY0eUZwyj3y3SVS8fwj44TE1cF7oAw+QyZwfbQLBIOEoaHPodwSPJ3wwlzJcQybZbGkF3raz0zBTCcTlo0Suo7N73Wh2x+kaKaFIr9gsghgxdv2uIul8tHxT0ImFPp8ypiFkqzU8+CMHSgj+peDjBXvBsKd5HOsKEybrfHX1yNgvKoWYUiDqsQd54kAjSij/sg4iPuShRCj61Hp5fnWJYx2trx5xUhj87Pjk++z07IKjGwbtFkOEZTKCLWFkL3HD1F8uTJ5eRh5Ueoh/TaNlFtGv7vbudgAWmc03igfLOhhv+0arslMZLQIpHn+HgvrBQRMWy+QHsNX2lgAtf5cX2bHF6Rd1JXVU39vZtlO2gRR3grlf5Z3UVvgi8vZleoHDWfCYVJCGPFkj4h8P+UX+Mvp48NshBGMchxboTOKpGFTRbs0s8fliv8NQ==
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
Get template list
</h1>
<MethodEndpoint
method={"post"}
path={"/templatelist"}
>
</MethodEndpoint>
Get template list
## Request
<MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
<div
style={{"marginTop":"1rem","marginBottom":"1rem"}}
>
provide below parameter to get number of templates
</div>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"limit"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":10}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"skip"}
required={false}
schemaName={"int32"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int32","example":0}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<TabItem
label={"default"}
value={"default"}
>
<div>
successful operation
</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"id"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"x1Hbnms2Pg"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"URL"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"https://templateuser.com"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"sample template"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Note"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"template note"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"template name"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Folder"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"folder name"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
Signers
</strong><span
className={"openapi-schema__name"}
>
object[]
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"objectId"}
required={false}
schemaName={"int64"}
qualifierMessage={undefined}
schema={{"type":"integer","format":"int64"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"joe"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem><SchemaItem
collapsible={false}
name={"CreateBy"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","example":"template creator name"}}
>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"id\": \"x1Hbnms2Pg\",\n \"URL\": \"https://templateuser.com\",\n \"Name\": \"sample template\",\n \"Note\": \"template note\",\n \"Description\": \"template name\",\n \"Folder\": \"folder name\",\n \"Signers\": [\n {\n \"objectId\": 0,\n \"Name\": \"joe\"\n }\n ],\n \"CreateBy\": \"template creator name\"\n}"}
language={"json"}
>
</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
@@ -5,7 +5,7 @@ description: ""
sidebar_label: "Updates a pet in the store with form data"
hide_title: true
hide_table_of_contents: true
api: eJylVWFr2zAQ/StCn1ZI45Z1+2DGWNm6ElaasLR00Jqi2OdY1JZVSW4WjP/77mQ7yZK0ZAxCYp/e3T3du7vU3Im55eE9j0vlROwsjwY8ARsbqZ0sFQ85H/BSgxH0OkrQUOlEOJiAu5Mu+16aAhFaGFGAA0PBaq7wBZFd0EeZIERSMC1cxrczjL6xMmUaHHOZcEwBJJa5ks2AtbnI3cBzJQ0+hs5UMOA2zqAQPKy5W2pKJpWDORiEpshJuNb08Yw3zWDFyP90XJ4rMMsdMteIOIDOTnrrjFTzv5JZJ1xl30439Zj/ShhRcawulQVL52cnH+hnq8bqReQyYVLpyhFLbiGujHRLL5jQ8vEJ6DmieChlVpLWurTOy4uyhTzoBA3qtbINcQPz0ktfmRyRmXPahkEgtB5i9ygr5yoXMzuMywKNMng55ZSoJzGl27X0V1RWN0XLD6DSdXX9dTwRxsLxeW/39c1AJCg/XU2qtPT+0uXkMEYGU2TAzicjhpm3RbjJpGX4oeOkjKsC8HZ0xrCV2JY3mwkLCcNDl4E/JPv74SmzGmKZyti7DtmDelDTErupspBWOculerLhgzpm9+MUYVLk7A5mVjqI3vUFWywWOwU78j6XOG3VjBnQ5Ro+90Zf1U2v1csR3hWnsrDjdIoiyRg6cV5JFXhwgF6dwlRG7DuZr8f5y7YTx5LnGBobkOCdSueXkyssywnGWvfEAZSDq9HXi+vpBUWlrmolOh2eYCg0UUcWQm0kuvUzYpnwIyRbXawrDbAF5iINC4YQsa177W+EWrdbrus2B79doHOBTdV01OtuAFZrEtHhxnLDRs5oUBBQ19QetyZvGjK3Q09zkUgrZjntr1TkFt6gcuAG2kvXD06/5XDiK4Jw2kmH5z94Jb3BYLX61hwiejGSSPxjQd797Hb/ETvor2Ivr36XqOUmq57vhphN1GwswMl4eoMoUZH+mxvpyW+e7oHuszfBzqpq09E3ibLX5xPtE0R/XsHbk1cdus3Xo+m+UdM0fwBW06xT
api: eJy9VU1v2zAM/SuCTiuQxi32cQiGYcXWFcWGNVha7LAGhWLTsRBb0iS6aRD4v4+U7SRN2yG7DAgSm3okH8knZi1RzYMc/ZKpNahSDHI6kBmE1GuH2ho5knIgrQOv+PUyI0PtMoUwBvypsfhifUUIp7yqAMFzsLU09ELILuidzgiiOZhTWMj9DJefhc2FAxRYKBQGIAsCrZiBaHOxu4fftfb0OEJfw0AGXJWcI+jK0cNAwoMrbUamXJWBAWkBlZKjtcSVY6Q2CHPwBM2JtMLW9O6NbJrBhnL86cj+rsGvnrD9Toh/4tvz6Qjnbcc2dLty9tkG9NrMH3ELqLAOf2c3iZj/yW/KsYKzJkDg8zcnb/lnb8TmXpU6E9q4GrkoGSCtvcZV1Ity+m4B/DzleKSkwrLUnA0Y1UWqGcmk01Oy3gqrkRzK3/fKq31JyALRhVGSKOeGJF4T9NyUahaGqa3IqJP7U8mJehITrq6lv6GyqZQsX4E73Y3h4Zgsx2gXYPpZFKAyUhbXpU1uo7PG2M4rSj+h9OJsfCko7f7ArgsdBH34OLNpXQGVxmeCBiH2vMVMBcgEHWIB8ZDtr4enIjhIda7T6DoUt+bWTCwJtQ6Q16UotVmE0a05Fr+ucoJpVYqfMAsaYfqq79ZyuXzSraPoc0E3vZ4JD85u4fNojC3d9dq8HFGttBGqcJVPaEI6hW4yL6RKIjghr2683EYSnS63q+TjvpOklpcUmtTH8G5EZxfjb9SWE4q1FcQBlJNvl5/Ov0/OOSpLqh3R6fCEQpGJ5Vgps5PoJt6nIFS8brqdS0DrQSwpF8+wEgRR+3Nfx4po1u2G7aSG8ICJKxWJqumorzv1b1Y0oUc7i5VUXPAtIcB6zfK48WXTsLldEHwpMh3UrNy56y9SOXC5PUs33pp+gdJ1rxkieX8dnv/g9fUXBps1ueUw5RevmcQ/NuTVj25PHomD/qae5dUvErPaZdXz3RlmM212tt/4anJNKFXz/HfX0SKuo+6B63k2weM91ebib57Isw7veZnQqvuwgbcnLzp0a69Hc7HTpmn+AJTE1qQ=
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
@@ -59,7 +59,7 @@ import TabItem from "@theme/TabItem";
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"contact_id","in":"path","description":"ID of pet that needs to be updated","required":true,"schema":{"type":"integer","format":"int64"}}}
param={{"name":"contact_id","in":"path","description":"ID of pet that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
@@ -83,12 +83,12 @@ import TabItem from "@theme/TabItem";
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"name","in":"query","description":"Name of pet that needs to be updated","schema":{"type":"string"}}}
param={{"name":"name","in":"query","description":"Name of pet that needs to be updated","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}
>
</ParamsItem><ParamsItem
className={"paramsItem"}
param={{"name":"status","in":"query","description":"Status of pet that needs to be updated","schema":{"type":"string"}}}
param={{"name":"status","in":"query","description":"Status of pet that needs to be updated","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}
>
</ParamsItem>
+1 -1
View File
@@ -5,7 +5,7 @@ description: "Update an existing pet by Id"
sidebar_label: "Update an existing pet"
hide_title: true
hide_table_of_contents: true
api: eJztWNtu4zYQ/RWCT13A1zbtg1EsmmaDhdFFY9RJt4BjFLQ0triRSJWkEhuG/r0zpGTJl+wuennTiyENzwxnhueQtPbciY3lkwUvLBjLlz0eg42MzJ3Uik/4Qx4LB0woBltpnVQbloNjqx2bxrzHdQ5GEBTfJrzw4Bk4HDHwVwHW/azjHZ/sPx8VlPNRpWIuAWadNoAhIq1oiNxFnqcy8jMNP1mKsec2SiAT9ERzSQMx1aFERr55op1+MKkvye1ywFn16hNElFtuKG8nwZK3jOm3wkiccgMGQWttMuGC6YcrNMBWZHmKoPGo7IV5Gj/rDPamjeKx3mwkcMRi4rDRZtfC/2e5fFUq7zQuconQbZYSMng0eeGIk85Db1q2polNdGGM2PFDpBeDS0Odd6YAdJEOMnspmeOZ68iYFM3tOfhPp/hXrXy1fefdwizbjboXAWSdcMXFko85TwQP2FOegyoyoq54FjIVq9TzF1Qcolidxnx5ng7Ga6dDqiNQWymVQyeUTiidUD4rlP7Ly0ufKu4XJgUV6RjiTjqddDrpnEun7LXEUPXLgM21sqEr345G51e+eRFFYO26SNnh0tjd8Tr9dfrr7nidUDqh/B8HFVquLp1FU/UsUhmz6TtmC9ISNtRjr86xGIop7dhaF6pCfX+O+p3ieUEy2EYQzL4hEBVGOmT7gk44+ecT0POyRCVm4BJN303ywq+YcAm+DDfg6GMMVQvmmb7KkC/eS3EwcS63k+EQSTDA9VVWbhR2yQ4inaFRDp/HnELX085pWwgUOEzeUCuXvwBxq2riH/2ZMBb617VdUmkJiBizoWLoVP6t+a5zW0sq8Gs8OkSq1H4sdo85QIIKj2S1qNmyrFWwCF5N4JqPy4ZqLaaQHtRa+xIrJtxhk+bYJHY9mzJszikR7xOJFLR+ONZRkeFlJKwjaoOdeLOVsBAzHRhLg2T/bjBmNodIrqs9ecAe1aOa6wwYLiTdeFKpnuzkUfXZ4m6NMClS9hFWFtW7/KZeU/wLcramb7zPe+mSYsUM5LqBb7zRL3zb6/DyBmt1YDJ7t54jj2QEFX9emWrowcPqTiYifyfDM0US7yrTT6dO1HI8itAILTVev599wLaMMFZD269IefhhenP76/yWohLxwxKNByMMRVTR1mVCtSa6/HXydJH3zS3zS98zK2U42LphngoUQFnVsK/0ueC1PpGDCWZEpv2emIEsLksyo0KMVzmWIYz03CTN92oxEbG9FvlNyKx/TxMTPC2CNL/057Ts1SGuI9pwXnH2F+mjzWb2cI/YVfVdNsNgaGwF7rVfQtaioMrb+8aT3x+qB6qmHlK7ViJnG0pImH4p/Ys+P5KkEP32AA8jrzpULa3RtGR4QJR/A59xt8M=
api: eJztWN9v2zYQ/lcIPq2AbdlbtgejKJqlQWGsWII62R4cY6Cls8VGIjWSSmwY/t97R0qW/CNtsbVvejGk43fHu+P3kbS23ImV5eMZLy0Yy+c9noCNjSyc1IqP+X2RCAdMKAZraZ1UK1aAY4sNmyS8x3UBRhAU38a89OBbcDhi4N8SrPtdJxs+3n45Kijno0rFXArMOm0AQ8Ra0RC5i6LIZOxnij5ZirHlNk4hF/REc0kDCdWhRE6+RaqdvjeZL8ltCsBZ9eITxJRbYShvJ8GSt0zot8JInHIFBkFLbXLhgum3CzTAWuRFhqDRcNcL8zR+1hnsTRvFE71aSeCIxcRhpc2mhf9uuXxTKu80LvIOoes8I2TwaPLCESedh161bE0Tm+jCGLHh+0jPBpeGOu9MCegiHeT2XDKHM9eRMSma23Pwv07xv1r5YvtOu4VZtht1JwLIOuHKsyUfcp4IHrDHPAdV5kRd8SRkJhaZ5y+oJESxOkv4/DQdjNdOh1RHoLZSKodOKJ1QOqF8USj95+fnPlXcL00GKtYJJJ10Oul00jmVzq7XEkPVLwO20MqGrvw8HJ5e+aZlHIO1yzJj+0tjd8fr9Nfpr7vjdULphPIjDiq0XJw7iybqSWQyYZN3zJakJWyox16cYjEUU9qxpS5Vhfr1FPUXxfOCZLCOIZh9QyAujXTI9hmdcPKfR6Dn+Q6VmINLNX03KUq/YsKl+BKtwNHHGKoWzBN9lSFfvJfiYOpcYcdRhCQY4PoqK1cKu2QHsc7RKKOnEafQ9bRT2hYCBfaTN9Qq5B9A3KqauO6jpe/0I9DJLKmuFESCqVAldCR/bD7qXNd6CuQaDfdhKqkfKt1j9pAgwQNNzWqqzGsJzIJXE7gm47zhWYsmJAa11L6+igY32KEpdohd3k4YduaYhXepRP5ZP5zouMzxJhIWEYXBjrzZQlhImA50pUGy/zIYMVtALJfVhjxgD+pBTXUODFeRrjuZVI92/KD6bHazRJgUGfsbFhalO/+pXlD8/3GyoK+8z3vp0nLBDBS6ga+80a9622v/8gprdWBye7OcIolkDBV5Xpgq8uCoupCJ2F/I8ECRRLrK9PbYiVqO5xAaoSXFy/e3H7AtQ4zVcPYbUo4+TK6u/5xeU1RifVii0WCIoYgq2rpcqNZE5z9NHi/ytrlifu1jZiULB2sXFZlAAeyqGraVOGe8FidyMMWMyLTdEjOQxbsdmVEhxkscyxBGem6S4Hu1mIjYXoj8KmTWv6OJCZ6VQZdf+2e669UhLmPabV5w9rfog53m9v4OsYvqo2yOwdDYCtxrv4SsRUmVtzeNR79pVA9UTT2kNq1EDneTkC39Uu5nHV6TnnBDerOHh5EXHap+1mhaLzwadp8BoKa2PQ==
sidebar_class_name: "put api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
+178
View File
@@ -0,0 +1,178 @@
---
id: update-template
title: "update template by ID"
description: "update template by ID"
sidebar_label: "update template by ID"
hide_title: true
hide_table_of_contents: true
api: eJyVVttu2zgQ/RWCTyngWA422Ac9bbfNBsYWiVGn2IckCCiJsplIpJakfIHgf+8ZSrJlOwUaxzCo0eFcz8yk4V4sHI8fuZdlVQgvHX8ecVNJK7wyeprxmNdVhhcPHYCPeCWsKKWXlm42XOMBsF7Di8qAURqiSvglzpl0qVUVKYRw+pWZnPmlZMZm0uIkPNNSZo55wxLJWnukxMr/a2VxjL2t5Yg7vy3IlFMwRZ7ITVWYDKJcFI4A6VKWgscN99uKkEp7uZAW0NzYUvhW9Oc13+2eW/3S+b9NtqU7x35W1qxUJuFRYdZsHzM52XrI9jljFwihkMJ5ZrQcYPsAPsGB1MAX7cmQqKpCpSHD0asja8256yZ5lamndFuqh1eoDd7ehWzvUc5bpRfD+PYSuREhTRCFw95fvhvxO+M/rGZGIUoEtVJyzYTOmFMLjQIqxzKT1iWFB91fh3n8mIneRTasBVT+Ywpwhej4MX2bV5eIq1uxmaHiI+6VPzLzMiDtS0I02O0IZ6WrjHZtxq8nk3N2TPVKFCpjYLOrqZxgKS5eT67PsfeB59p4lptaZ8GTY8QJoViyhWIEAhYtDfVgVQcmUD/FPOpxUTPwfweAk3bVt2VtC2CX3lcujiJQbgwaaapYIRI3Tk0JoYpWV5xawcm0tspv50TDNm68fXmT20HKIfkXglHf8ptLSC69eZO6b/mlFAg2hEjM/n7osJu+KD2Hz2jZs/L3iHbCs/epM2TOERnI3dyE2DpO3CM7czLzeTZlyMppjR7IOr70uncitDCqatnJbZYggAzTIAw6eknyP8ZXzFUyVXnX/WP2pJ/03JSYek7mdcEKpd9c/KQv2eN9DpgSBftPJk55+XzRF3O9Xp8V81O4c6v8sk6Qucoc4IsgDBUf3to/0HTCtCrdfT4HgVQqO+L8wlQUwFE300QaZhqGlyLCdaK/Ti9RyjH0IAwU6Bj0+Xb2DWmZQNeBr7/hcvRt+uXmbn5DWonxbYmuxhOogqgyzpdCDwz9qsOyd2eVlxsfAajC8AmeNV33HVYlbsfDpYcuWsIuQZqG6v/DFrsdidEDFn30iONKWCUSIhxaNFOOztl+f514s18Z/OJ7v0nYB/bnu9H0vaypkTHEanrCMbT60RbfPQPeNTS52yK+tE5dPpCeg4aznUZTZT+/Zj8egE26RVuGnc2tWNOSx2/Mn/DH6T8PUhDGT5A3vBB6UYsF4Vu19PkJodUD3g==
sidebar_class_name: "put api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
<h1
className={"openapi__heading"}
>
update template by ID
</h1>
<MethodEndpoint
method={"put"}
path={"/template/{template_id}"}
>
</MethodEndpoint>
update template by ID
## Request
<details
style={{"marginBottom":"1rem"}}
className={"openapi-markdown__details"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
>
<h3
className={"openapi-markdown__details-summary-header-params"}
>
Path Parameters
</h3>
</summary><div>
<ul>
<ParamsItem
className={"paramsItem"}
param={{"name":"template_id","in":"path","description":"ID of the order that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
>
</ParamsItem>
</ul>
</div>
</details><MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
<div
style={{"marginTop":"1rem","marginBottom":"1rem"}}
>
provide below parameter to update templates (at least one parameter required)
</div>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"Name"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"sample template"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Note"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"Description"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"template description"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"FolderId"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><div>
<div>
<ApiTabs>
<TabItem
label={"400"}
value={"400"}
>
<div>
Invalid ID supplied
</div><div>
</div>
</TabItem><TabItem
label={"404"}
value={"404"}
>
<div>
Order not found
</div><div>
</div>
</TabItem>
</ApiTabs>
</div>
</div>
+1 -1
View File
@@ -5,7 +5,7 @@ description: ""
sidebar_label: "uploads an image"
hide_title: true
hide_table_of_contents: true
api: eJyNVG1P2zAQ/iuW+TKktinwrZqmdYghNLRWK9MmQTU5zqUxJLZnO0BV9b/vzklKKFRaVbXJvT5399xteBArzye3XBodhAyeLwc8Ay+dskEZzSecD7ix4AS9XmUoqG1pRPZVlYAqB39r8OGLydZ8solhQAd6FNaWSka3xMgAYeiDA1GRzssCKkFPYW0BY6JK6RXGy42rBPrzVGnh1nyLH8rirdEePLmcjsf09xqlr6UE7/O6ZDu0GO4AnntPTu/gMOk9yICO1lGYoJqU0mTQs1IYdAWuDxdFZ6ccoTYm+4WhokJ4YvWeDpXPVUkKLSpSHB1lkIu6DDGgCiUJp1b9aNsQu4IqD7J2KmDnb6k+9ecB6Hm5XVK6UBgalzU+FiRCgW9JO+hSRakH9wjOxwC1Qwy8CMH6SZJgu0bYAu3VSpci9SNpKhSq5PGEU/wu94Ja2HRph2BXIUq+oWDQFfZ7OBfOw3DayRXNrgCRYTepIqVzE/3bomeIYIEI2HR+xTDzPjlvCuUZfkmdGVlXOOw4YoaTYXveLBUeMobKUEBUkvxsdMK8Banylh0jdqfv9MJUwGoPxKhS6Qc/udNDdjvL0UyJkv2C1KsAyw9dw56ent407Dj6XKpQ1ClzYM2L+SoKY1f7XruXY6w1gKv8LF/gkJSEdjgHUiXROGk5jxOmNiK5FQ21FX3edyJ+4VIAceqFftPL+TW2ZYyxXjjxH5CT66vzi++LC4pKrGpGdDIaYygUEREroXuJmkvimdBMVbQbe+Pt3RM6Qy2pAjyHxJYCubNtEW5aeu/uWKQ3srQg8qN4s6HZ/3TldktivFkubgoCFU6JlMiGezPouEj7EKnMzxsEwxtKTuZl3TD7wHXbDjrPKV4kGw74xAv0ak/ns8UNGqftJa3iyeE5nVnEJWqqr79YD3GB2gfC26n0upfzzcY12OiXkL7r85HWAq0/7cwbzUGHtmmdNQ1miQfqH+T/LPc=
api: eJyNVG1v2jAQ/iuW+2WVgND2G5qmsaqrqlWjGkz70KLJcS7EJbE922mLEP99d05CU1akIQTJvT5399xteRArzyf3XBodhAyeLwc8Ay+dskEZzSecD7ix4AS93mQoqG1pRPZVlYAqB39q8OGLyTZ8so1hQAd6FNaWSka3xMgAYeiDA1GRzssCKkFPYWMBY6JK6RXGy42rBPrzVGnhNnyHH8rirdEePLmcj8f09xalr6UE7/O6ZHu0GO4InkdPTu/gMOkjyICO1lGYoJqU0mTQs1IYdAWuDxdFF+ccoTYmh4WhokJ4YvWeDpUvVUkKLSpSnJxkkIu6DDGgCiUJp1b9aNsQu4IqD7J2KmDn76k+9XsN9LzcLSldKAyNyxofCxKhwLekHXSpotSDewLnY4DaIQZehGD9JEmwXSNsgfZqpUuR+pE0FQpV8nTGKX6Xe04tbLq0R7CvECXfUDDoCnsZomQYzBpoOIoGV4DIsJVUjtK5ic5txTNMP8f0bHp3wzDtITMXhfIMv6TOjKwrnHScL8OxsANvlgoPGUNlKCAqSX4xOmPeglR5S40Re9APem4qYLUHolOp9NpPHvSQ3c9yNFOiZL8g9SrA8kPXrefn53+6dRp9rlUo6pQ5sObVfBWFsaV9r/3LKdYawFV+ls9xQkpCO5kjqZJonLSEx/FSG5HZiibaij4fOhG5cCOACPXKven13S22ZYyxXgnxH5CT25vLq+/zK4pKlGpGdDYaYygUEQsroXuJmjPimdBMVbQYB+PtHRO6QS2jAryExJYCubNrEW5bbu+PWOQ2UrQg5qN4u6XZ/3TlbkdiPFgurgkCFU6JlMiGSzPouEjLEHnMLxsEwwUlJ/Oybmh95LTtBp3nFM+RDUd84vl5s6R3s/kCjdP2jFbx3vCcbiziEjXV19+qddyq9oHwdiq96eV8u24NMPolmO86fKSdwI39tDdvNEcd2o511jSVJZ6mv+5WK3E=
sidebar_class_name: "post api-method"
info_path: docs/API-docs/opensign-api-v-1
custom_edit_url: null