API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Mar 22nd, 2022
141
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 378.14 KB | None | 0 0
raw download clone embed print report
  1. swagger: '2.0'
  2. info: {version: 1.0.0, title: Smartsheet API Reference, description: Smartsheet API
  3. Reference}
  4. host: api.smartsheet.com
  5. basePath: /2.0
  6. schemes: [https]
  7. consumes: []
  8. produces: [application/json]
  9. paths:
  10. /contacts:
  11. get:
  12. summary: List Contacts
  13. description: List Contacts
  14. operationId: ListContacts
  15. parameters:
  16. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  17. - {name: modifiedSince, default: '1985-09-11T17:58:59.315Z', in: query, type: string,
  18. required: true}
  19. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  20. - {name: page, default: '1', in: query, type: string, required: true}
  21. - {name: pageSize, default: '100', in: query, type: string, required: true}
  22. - {name: Accept, in: header, required: true, type: string, default: application/json,
  23. description: Accept}
  24. responses:
  25. '200':
  26. description: '200'
  27. schema:
  28. type: object
  29. properties:
  30. pageNumber: {type: integer, format: int32, description: pageNumber}
  31. pageSize: {type: integer, format: int32, description: pageSize}
  32. totalPages: {type: integer, format: int32, description: totalPages}
  33. totalCount: {type: integer, format: int32, description: totalCount}
  34. data:
  35. type: array
  36. items:
  37. type: object
  38. properties:
  39. id: {type: string, description: id}
  40. name: {type: string, description: name}
  41. email: {type: string, description: email}
  42. description: data
  43. '401':
  44. description: '401'
  45. schema:
  46. type: object
  47. properties:
  48. errorCode: {type: integer, format: int32, description: errorCode}
  49. message: {type: string, description: message}
  50. refId: {type: string, description: refId}
  51. '404':
  52. description: '404'
  53. schema:
  54. type: object
  55. properties:
  56. errorCode: {type: integer, format: int32, description: errorCode}
  57. message: {type: string, description: message}
  58. refId: {type: string, description: refId}
  59. '500':
  60. description: '500'
  61. schema:
  62. type: object
  63. properties:
  64. errorCode: {type: integer, format: int32, description: errorCode}
  65. message: {type: string, description: message}
  66. refId: {type: string, description: refId}
  67. /contacts/{contactId}:
  68. get:
  69. summary: Get Contact
  70. description: Get Contact
  71. operationId: GetContact
  72. parameters:
  73. - {name: include, default: profileImage, in: query, type: string, required: true}
  74. - {name: contactId, default: '-4847524.674802229', in: path, type: string, required: true}
  75. - {name: Accept, in: header, required: true, type: string, default: application/json,
  76. description: Accept}
  77. responses:
  78. '200':
  79. description: '200'
  80. schema:
  81. type: object
  82. properties:
  83. id: {type: string, description: id}
  84. name: {type: string, description: name}
  85. email: {type: string, description: email}
  86. '500':
  87. description: '500'
  88. schema:
  89. type: object
  90. properties:
  91. refId: {type: string, description: refId}
  92. errorCode: {type: number, format: float, description: errorCode}
  93. message: {type: string, description: message}
  94. /favorites/{favoriteType}:
  95. delete:
  96. summary: Remove Multiple Favorites
  97. description: Remove Multiple Favorites
  98. operationId: RemoveMultipleFavorites
  99. parameters:
  100. - {name: favoriteType, default: folder, in: path, type: string, required: true}
  101. - {name: Accept, in: header, required: true, type: string, default: application/json,
  102. description: Accept}
  103. responses:
  104. '200':
  105. description: '200'
  106. schema:
  107. type: object
  108. properties:
  109. message: {type: string, description: message}
  110. resultCode: {type: integer, format: int32, description: resultCode}
  111. '500':
  112. description: '500'
  113. schema:
  114. type: object
  115. properties:
  116. refId: {type: string, description: refId}
  117. errorCode: {type: number, format: float, description: errorCode}
  118. message: {type: string, description: message}
  119. /favorites/{favoriteType}/{favoriteId}:
  120. delete:
  121. summary: Remove Favorite
  122. description: Remove Favorite
  123. operationId: RemoveFavorite
  124. parameters:
  125. - {name: favoriteType, default: folder, in: path, type: string, required: true}
  126. - {name: favoriteId, default: '-4847524.674802229', in: path, type: string,
  127. required: true}
  128. - {name: Accept, in: header, required: true, type: string, default: application/json,
  129. description: Accept}
  130. responses:
  131. '200':
  132. description: '200'
  133. schema:
  134. type: object
  135. properties:
  136. message: {type: string, description: message}
  137. resultCode: {type: integer, format: int32, description: resultCode}
  138. '500':
  139. description: '500'
  140. schema:
  141. type: object
  142. properties:
  143. refId: {type: string, description: refId}
  144. errorCode: {type: number, format: float, description: errorCode}
  145. message: {type: string, description: message}
  146. /favorites:
  147. get:
  148. summary: List Favorites
  149. description: List Favorites
  150. operationId: ListFavorites
  151. parameters:
  152. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  153. - {name: page, default: '1', in: query, type: string, required: true}
  154. - {name: pageSize, default: '100', in: query, type: string, required: true}
  155. - {name: Accept, in: header, required: true, type: string, default: application/json,
  156. description: Accept}
  157. responses:
  158. '200':
  159. description: '200'
  160. schema:
  161. type: object
  162. properties:
  163. pageNumber: {type: integer, format: int32, description: pageNumber}
  164. pageSize: {type: integer, format: int32, description: pageSize}
  165. totalPages: {type: integer, format: int32, description: totalPages}
  166. totalCount: {type: integer, format: int32, description: totalCount}
  167. data:
  168. type: array
  169. items:
  170. type: object
  171. properties:
  172. objectId: {type: number, format: float, description: objectId}
  173. type: {type: string, description: type}
  174. description: data
  175. '500':
  176. description: '500'
  177. schema:
  178. type: object
  179. properties:
  180. refId: {type: string, description: refId}
  181. errorCode: {type: number, format: float, description: errorCode}
  182. message: {type: string, description: message}
  183. post:
  184. summary: Add Favorites
  185. description: Add Favorites
  186. operationId: AddFavorites
  187. parameters:
  188. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  189. description: Content-Type}
  190. - {name: Accept, in: header, required: true, type: string, default: application/json,
  191. description: Accept}
  192. - name: body
  193. in: body
  194. schema:
  195. type: object
  196. properties:
  197. objectId: {type: number, format: float, description: objectId}
  198. type: {type: string, description: type}
  199. default: {objectId: -10339464.119341418, type: template}
  200. required: true
  201. responses:
  202. '200':
  203. description: '200'
  204. schema:
  205. type: object
  206. properties:
  207. message: {type: string, description: message}
  208. resultCode: {type: integer, format: int32, description: resultCode}
  209. result:
  210. type: object
  211. properties:
  212. objectId: {type: number, format: float, description: objectId}
  213. type: {type: string, description: type}
  214. description: result
  215. '500':
  216. description: '500'
  217. schema:
  218. type: object
  219. properties:
  220. refId: {type: string, description: refId}
  221. errorCode: {type: number, format: float, description: errorCode}
  222. message: {type: string, description: message}
  223. /folders/{folderId}/folders:
  224. get:
  225. summary: List Folders
  226. description: List Folders
  227. operationId: ListFolders
  228. parameters:
  229. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  230. - {name: page, default: '1', in: query, type: string, required: true}
  231. - {name: pageSize, default: '100', in: query, type: string, required: true}
  232. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  233. - {name: Accept, in: header, required: true, type: string, default: application/json,
  234. description: Accept}
  235. responses:
  236. '200':
  237. description: '200'
  238. schema:
  239. type: object
  240. properties:
  241. pageNumber: {type: integer, format: int32, description: pageNumber}
  242. pageSize: {type: integer, format: int32, description: pageSize}
  243. totalPages: {type: integer, format: int32, description: totalPages}
  244. totalCount: {type: integer, format: int32, description: totalCount}
  245. result:
  246. type: array
  247. items:
  248. type: object
  249. properties:
  250. value: {type: string, description: value}
  251. description: result
  252. '500':
  253. description: '500'
  254. schema:
  255. type: object
  256. properties:
  257. refId: {type: string, description: refId}
  258. errorCode: {type: number, format: float, description: errorCode}
  259. message: {type: string, description: message}
  260. post:
  261. summary: Create Folder
  262. description: Create Folder
  263. operationId: CreateFolder
  264. parameters:
  265. - {name: include, default: filters, in: query, type: string, required: true}
  266. - {name: exclude, default: sheetHyperlinks, in: query, type: string, required: true}
  267. - {name: skipRemap, default: sights, in: query, type: string, required: true}
  268. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  269. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  270. description: Content-Type}
  271. - {name: Accept, in: header, required: true, type: string, default: application/json,
  272. description: Accept}
  273. - name: body
  274. in: body
  275. schema:
  276. type: object
  277. properties:
  278. value: {type: string, description: value}
  279. default: {value: 'reference #/components/schemas/Folder/properties/folders/items
  280. not found in the OpenAPI spec'}
  281. required: true
  282. responses:
  283. '200':
  284. description: '200'
  285. schema:
  286. type: object
  287. properties:
  288. message: {type: string, description: message}
  289. resultCode: {type: integer, format: int32, description: resultCode}
  290. result:
  291. type: object
  292. properties:
  293. value: {type: string, description: value}
  294. description: result
  295. '500':
  296. description: '500'
  297. schema:
  298. type: object
  299. properties:
  300. refId: {type: string, description: refId}
  301. errorCode: {type: number, format: float, description: errorCode}
  302. message: {type: string, description: message}
  303. /folders/{folderId}/sheets:
  304. post:
  305. summary: Create Sheet in Folder
  306. description: Create Sheet in Folder
  307. operationId: CreateSheetInFolder
  308. parameters:
  309. - {name: include, default: rules, in: query, type: string, required: true}
  310. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  311. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  312. description: Content-Type}
  313. - {name: Accept, in: header, required: true, type: string, default: application/json,
  314. description: Accept}
  315. - name: body
  316. in: body
  317. schema:
  318. type: object
  319. properties:
  320. columns:
  321. type: array
  322. items:
  323. type: object
  324. properties:
  325. autoNumberFormat:
  326. type: object
  327. properties:
  328. fill:
  329. type: object
  330. properties:
  331. value: {type: string, description: value}
  332. description: fill
  333. prefix:
  334. type: object
  335. properties:
  336. value: {type: string, description: value}
  337. description: prefix
  338. startingNumber:
  339. type: object
  340. properties:
  341. value: {type: string, description: value}
  342. description: startingNumber
  343. suffix:
  344. type: object
  345. properties:
  346. value: {type: string, description: value}
  347. description: suffix
  348. description: autoNumberFormat
  349. contactOptions:
  350. type: array
  351. items:
  352. type: object
  353. properties:
  354. value: {type: string, description: value}
  355. description: contactOptions
  356. options:
  357. type: array
  358. items: {type: string}
  359. description: options
  360. primary: {type: boolean, description: primary}
  361. symbol: {type: string, description: symbol}
  362. systemColumnType: {type: string, description: systemColumnType}
  363. title: {type: string, description: title}
  364. type: {type: string, description: type}
  365. width: {type: number, format: float, description: width}
  366. description: columns
  367. name:
  368. type: object
  369. properties:
  370. value: {type: string, description: value}
  371. description: name
  372. default:
  373. columns:
  374. - autoNumberFormat:
  375. fill: {value: '<Error: Too many levels of nesting to fake this schema>'}
  376. prefix: {value: '<Error: Too many levels of nesting to fake this schema>'}
  377. startingNumber: {value: '<Error: Too many levels of nesting to fake
  378. this schema>'}
  379. suffix: {value: '<Error: Too many levels of nesting to fake this schema>'}
  380. contactOptions:
  381. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  382. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  383. options: ['Lorem in labore ', commodo nostrud dolore]
  384. primary: true
  385. symbol: officia laboris eu amet
  386. systemColumnType: CREATED_DATE
  387. title: minim culpa
  388. type: PICKLIST
  389. width: -98498771.72943535
  390. - autoNumberFormat:
  391. fill: {value: '<Error: Too many levels of nesting to fake this schema>'}
  392. prefix: {value: '<Error: Too many levels of nesting to fake this schema>'}
  393. startingNumber: {value: '<Error: Too many levels of nesting to fake
  394. this schema>'}
  395. suffix: {value: '<Error: Too many levels of nesting to fake this schema>'}
  396. contactOptions:
  397. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  398. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  399. options: ['Lorem in labore ', commodo nostrud dolore]
  400. primary: true
  401. symbol: officia laboris eu amet
  402. systemColumnType: CREATED_DATE
  403. title: minim culpa
  404. type: PICKLIST
  405. width: -98498771.72943535
  406. name: {value: 'reference #/components/schemas/Folder/properties/sheets/items/properties/name
  407. not found in the OpenAPI spec'}
  408. required: true
  409. responses:
  410. '200':
  411. description: '200'
  412. schema:
  413. type: object
  414. properties:
  415. message: {type: string, description: message}
  416. resultCode: {type: integer, format: int32, description: resultCode}
  417. result:
  418. type: object
  419. properties:
  420. accessLevel:
  421. type: object
  422. properties:
  423. value: {type: string, description: value}
  424. description: accessLevel
  425. columns:
  426. type: object
  427. properties:
  428. value: {type: string, description: value}
  429. description: columns
  430. id:
  431. type: object
  432. properties:
  433. value: {type: string, description: value}
  434. description: id
  435. name:
  436. type: object
  437. properties:
  438. value: {type: string, description: value}
  439. description: name
  440. permalink:
  441. type: object
  442. properties:
  443. value: {type: string, description: value}
  444. description: permalink
  445. description: result
  446. '500':
  447. description: '500'
  448. schema:
  449. type: object
  450. properties:
  451. refId: {type: string, description: refId}
  452. errorCode: {type: number, format: float, description: errorCode}
  453. message: {type: string, description: message}
  454. /folders/{folderId}/sheets/import:
  455. post:
  456. summary: Import Sheet into Folder
  457. description: Import Sheet into Folder
  458. operationId: ImportSheetIntoFolder
  459. parameters:
  460. - {name: sheetName, default: ex Excepteur laboris, in: query, type: string,
  461. required: true}
  462. - {name: headerRowIndex, default: '-4847524.674802229', in: query, type: string,
  463. required: true}
  464. - {name: primaryColumnIndex, default: '0', in: query, type: string, required: true}
  465. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  466. - {name: Content-Disposition, in: header, required: true, type: string, default: attachment;
  467. filename="ProgressReport.docx", description: Content-Disposition}
  468. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  469. description: Content-Type}
  470. - {name: Accept, in: header, required: true, type: string, default: application/json,
  471. description: Accept}
  472. responses:
  473. '200':
  474. description: '200'
  475. schema:
  476. type: object
  477. properties:
  478. message: {type: string, description: message}
  479. resultCode: {type: integer, format: int32, description: resultCode}
  480. result:
  481. type: object
  482. properties:
  483. accessLevel:
  484. type: object
  485. properties:
  486. value: {type: string, description: value}
  487. description: accessLevel
  488. id:
  489. type: object
  490. properties:
  491. value: {type: string, description: value}
  492. description: id
  493. name:
  494. type: object
  495. properties:
  496. value: {type: string, description: value}
  497. description: name
  498. type: {type: string, description: type}
  499. permalink:
  500. type: object
  501. properties:
  502. value: {type: string, description: value}
  503. description: permalink
  504. description: result
  505. '500':
  506. description: '500'
  507. schema:
  508. type: object
  509. properties:
  510. refId: {type: string, description: refId}
  511. errorCode: {type: number, format: float, description: errorCode}
  512. message: {type: string, description: message}
  513. /folders/{folderId}:
  514. get:
  515. summary: Get Folder
  516. description: Get Folder
  517. operationId: GetFolder
  518. parameters:
  519. - {name: include, default: ownerInfo, in: query, type: string, required: true}
  520. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  521. - {name: Accept, in: header, required: true, type: string, default: application/json,
  522. description: Accept}
  523. responses:
  524. '200':
  525. description: '200'
  526. schema:
  527. type: object
  528. properties:
  529. value: {type: string, description: value}
  530. '500':
  531. description: '500'
  532. schema:
  533. type: object
  534. properties:
  535. refId: {type: string, description: refId}
  536. errorCode: {type: number, format: float, description: errorCode}
  537. message: {type: string, description: message}
  538. delete:
  539. summary: Delete Folder
  540. description: Delete Folder
  541. operationId: DeleteFolder
  542. parameters:
  543. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  544. - {name: Accept, in: header, required: true, type: string, default: application/json,
  545. description: Accept}
  546. responses:
  547. '200':
  548. description: '200'
  549. schema:
  550. type: object
  551. properties:
  552. message: {type: string, description: message}
  553. resultCode: {type: integer, format: int32, description: resultCode}
  554. '500':
  555. description: '500'
  556. schema:
  557. type: object
  558. properties:
  559. refId: {type: string, description: refId}
  560. errorCode: {type: number, format: float, description: errorCode}
  561. message: {type: string, description: message}
  562. put:
  563. summary: Update Folder
  564. description: Update Folder
  565. operationId: UpdateFolder
  566. parameters:
  567. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  568. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  569. description: Content-Type}
  570. - {name: Accept, in: header, required: true, type: string, default: application/json,
  571. description: Accept}
  572. - name: body
  573. in: body
  574. schema:
  575. type: object
  576. properties:
  577. value: {type: string, description: value}
  578. default: {value: 'reference #/components/schemas/Folder/properties/folders/items
  579. not found in the OpenAPI spec'}
  580. required: true
  581. responses:
  582. '200':
  583. description: '200'
  584. schema:
  585. type: object
  586. properties:
  587. message: {type: string, description: message}
  588. resultCode: {type: integer, format: int32, description: resultCode}
  589. result:
  590. type: object
  591. properties:
  592. value: {type: string, description: value}
  593. description: result
  594. '500':
  595. description: '500'
  596. schema:
  597. type: object
  598. properties:
  599. refId: {type: string, description: refId}
  600. errorCode: {type: number, format: float, description: errorCode}
  601. message: {type: string, description: message}
  602. /folders/{folderId}/copy:
  603. post:
  604. summary: Copy Folder
  605. description: Copy Folder
  606. operationId: CopyFolder
  607. parameters:
  608. - {name: include, default: filters, in: query, type: string, required: true}
  609. - {name: exclude, default: sheetHyperlinks, in: query, type: string, required: true}
  610. - {name: skipRemap, default: sights, in: query, type: string, required: true}
  611. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  612. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  613. description: Content-Type}
  614. - {name: Accept, in: header, required: true, type: string, default: application/json,
  615. description: Accept}
  616. - name: body
  617. in: body
  618. schema:
  619. type: object
  620. properties:
  621. destinationId: {type: number, format: float, description: destinationId}
  622. destinationType: {type: string, description: destinationType}
  623. newName: {type: string, description: newName}
  624. default: {destinationId: 80073746.07746986, destinationType: workspace,
  625. newName: in eu}
  626. required: true
  627. responses:
  628. '200':
  629. description: '200'
  630. schema:
  631. type: object
  632. properties:
  633. destinationId: {type: number, format: float, description: destinationId}
  634. destinationType: {type: string, description: destinationType}
  635. newName: {type: string, description: newName}
  636. '500':
  637. description: '500'
  638. schema:
  639. type: object
  640. properties:
  641. refId: {type: string, description: refId}
  642. errorCode: {type: number, format: float, description: errorCode}
  643. message: {type: string, description: message}
  644. /folders/{folderId}/move:
  645. post:
  646. summary: Move Folder
  647. description: Move Folder
  648. operationId: MoveFolder
  649. parameters:
  650. - {name: folderId, default: '-4847524.674802229', in: path, type: string, required: true}
  651. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  652. description: Content-Type}
  653. - {name: Accept, in: header, required: true, type: string, default: application/json,
  654. description: Accept}
  655. - name: body
  656. in: body
  657. schema:
  658. type: object
  659. properties:
  660. destinationId: {type: number, format: float, description: destinationId}
  661. destinationType: {type: string, description: destinationType}
  662. newName: {type: string, description: newName}
  663. default: {destinationId: 80073746.07746986, destinationType: workspace,
  664. newName: in eu}
  665. required: true
  666. responses:
  667. '200':
  668. description: '200'
  669. schema:
  670. type: object
  671. properties:
  672. destinationId: {type: number, format: float, description: destinationId}
  673. destinationType: {type: string, description: destinationType}
  674. newName: {type: string, description: newName}
  675. '500':
  676. description: '500'
  677. schema:
  678. type: object
  679. properties:
  680. refId: {type: string, description: refId}
  681. errorCode: {type: number, format: float, description: errorCode}
  682. message: {type: string, description: message}
  683. /groups/{groupId}/members:
  684. post:
  685. summary: Add Group Members
  686. description: Add Group Members
  687. operationId: AddGroupMembers
  688. parameters:
  689. - {name: groupId, default: '-4847524.674802229', in: path, type: string, required: true}
  690. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  691. description: Content-Type}
  692. - {name: Accept, in: header, required: true, type: string, default: application/json,
  693. description: Accept}
  694. - name: body
  695. in: body
  696. schema:
  697. type: object
  698. properties:
  699. id: {type: integer, format: int32, description: id}
  700. email: {type: string, description: email}
  701. firstName: {type: string, description: firstName}
  702. lastName: {type: string, description: lastName}
  703. name: {type: string, description: name}
  704. default: {id: 2331373580117892, email: [email protected], firstName: John,
  705. lastName: Doe, name: John Doe}
  706. required: true
  707. responses:
  708. '200':
  709. description: '200'
  710. schema:
  711. type: object
  712. properties:
  713. message: {type: string, description: message}
  714. resultCode: {type: integer, format: int32, description: resultCode}
  715. result:
  716. type: object
  717. properties:
  718. id:
  719. type: object
  720. properties:
  721. value: {type: string, description: value}
  722. description: id
  723. email:
  724. type: object
  725. properties:
  726. value: {type: string, description: value}
  727. description: email
  728. firstName:
  729. type: object
  730. properties:
  731. value: {type: string, description: value}
  732. description: firstName
  733. lastName:
  734. type: object
  735. properties:
  736. value: {type: string, description: value}
  737. description: lastName
  738. name:
  739. type: object
  740. properties:
  741. value: {type: string, description: value}
  742. description: name
  743. description: result
  744. '500':
  745. description: '500'
  746. schema:
  747. type: object
  748. properties:
  749. refId: {type: string, description: refId}
  750. errorCode: {type: number, format: float, description: errorCode}
  751. message: {type: string, description: message}
  752. /groups/{groupId}/members/{userId}:
  753. delete:
  754. summary: Delete Group Members
  755. description: Delete Group Members
  756. operationId: DeleteGroupMembers
  757. parameters:
  758. - {name: groupId, default: '-4847524.674802229', in: path, type: string, required: true}
  759. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  760. - {name: Accept, in: header, required: true, type: string, default: application/json,
  761. description: Accept}
  762. responses:
  763. '200':
  764. description: '200'
  765. schema:
  766. type: object
  767. properties:
  768. message: {type: string, description: message}
  769. resultCode: {type: integer, format: int32, description: resultCode}
  770. '500':
  771. description: '500'
  772. schema:
  773. type: object
  774. properties:
  775. refId: {type: string, description: refId}
  776. errorCode: {type: number, format: float, description: errorCode}
  777. message: {type: string, description: message}
  778. /groups/{groupId}:
  779. get:
  780. summary: Get Group
  781. description: Get Group
  782. operationId: GetGroup
  783. parameters:
  784. - {name: groupId, default: '-4847524.674802229', in: path, type: string, required: true}
  785. - {name: Accept, in: header, required: true, type: string, default: application/json,
  786. description: Accept}
  787. responses:
  788. '200':
  789. description: '200'
  790. schema:
  791. type: object
  792. properties:
  793. id: {type: integer, format: int32, description: id}
  794. name: {type: string, description: name}
  795. description: {type: string, description: description}
  796. owner: {type: string, description: owner}
  797. ownerId: {type: integer, format: int32, description: ownerId}
  798. createdAt: {type: string, description: createdAt}
  799. modifiedAt: {type: string, description: modifiedAt}
  800. data:
  801. type: array
  802. items:
  803. type: object
  804. properties:
  805. id: {type: integer, format: int32, description: id}
  806. email: {type: string, description: email}
  807. firstName: {type: string, description: firstName}
  808. lastName: {type: string, description: lastName}
  809. name: {type: string, description: name}
  810. description: data
  811. '500':
  812. description: '500'
  813. schema:
  814. type: object
  815. properties:
  816. refId: {type: string, description: refId}
  817. errorCode: {type: number, format: float, description: errorCode}
  818. message: {type: string, description: message}
  819. delete:
  820. summary: Delete Group
  821. description: Delete Group
  822. operationId: DeleteGroup
  823. parameters:
  824. - {name: groupId, default: '-4847524.674802229', in: path, type: string, required: true}
  825. - {name: Accept, in: header, required: true, type: string, default: application/json,
  826. description: Accept}
  827. responses:
  828. '200':
  829. description: '200'
  830. schema:
  831. type: object
  832. properties:
  833. message: {type: string, description: message}
  834. resultCode: {type: integer, format: int32, description: resultCode}
  835. '401':
  836. description: '401'
  837. schema:
  838. type: object
  839. properties:
  840. errorCode: {type: integer, format: int32, description: errorCode}
  841. message: {type: string, description: message}
  842. refId: {type: string, description: refId}
  843. '404':
  844. description: '404'
  845. schema:
  846. type: object
  847. properties:
  848. errorCode: {type: integer, format: int32, description: errorCode}
  849. message: {type: string, description: message}
  850. refId: {type: string, description: refId}
  851. put:
  852. summary: Update Group
  853. description: Update Group
  854. operationId: UpdateGroup
  855. parameters:
  856. - {name: groupId, default: '-4847524.674802229', in: path, type: string, required: true}
  857. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  858. description: Content-Type}
  859. - {name: Accept, in: header, required: true, type: string, default: application/json,
  860. description: Accept}
  861. - name: body
  862. in: body
  863. schema:
  864. type: object
  865. properties:
  866. name: {type: string, description: name}
  867. description: {type: string, description: description}
  868. ownerId: {type: integer, format: int32, description: ownerId}
  869. default: {name: Renamed group, description: Some new description, ownerId: 94094820842}
  870. required: true
  871. responses:
  872. '200':
  873. description: '200'
  874. schema:
  875. type: object
  876. properties:
  877. message: {type: string, description: message}
  878. resultCode: {type: integer, format: int32, description: resultCode}
  879. result:
  880. type: object
  881. properties:
  882. id: {type: integer, format: int32, description: id}
  883. name: {type: string, description: name}
  884. description: {type: string, description: description}
  885. owner: {type: string, description: owner}
  886. ownerId: {type: integer, format: int32, description: ownerId}
  887. createdAt:
  888. type: object
  889. properties:
  890. value: {type: string, description: value}
  891. description: createdAt
  892. modifiedAt:
  893. type: object
  894. properties:
  895. value: {type: string, description: value}
  896. description: modifiedAt
  897. description: result
  898. '400':
  899. description: '400'
  900. schema:
  901. type: object
  902. properties:
  903. refId: {type: string, description: refId}
  904. errorCode: {type: number, format: float, description: errorCode}
  905. message: {type: string, description: message}
  906. '500':
  907. description: '500'
  908. schema:
  909. type: object
  910. properties:
  911. errorCode: {type: integer, format: int32, description: errorCode}
  912. message: {type: string, description: message}
  913. refId: {type: string, description: refId}
  914. /groups:
  915. get:
  916. summary: List Org Groups
  917. description: List Org Groups
  918. operationId: ListOrgGroups
  919. parameters:
  920. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  921. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  922. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  923. - {name: page, default: '1', in: query, type: string, required: true}
  924. - {name: pageSize, default: '100', in: query, type: string, required: true}
  925. - {name: Accept, in: header, required: true, type: string, default: application/json,
  926. description: Accept}
  927. responses:
  928. '200':
  929. description: '200'
  930. schema:
  931. type: object
  932. properties:
  933. pageNumber: {type: integer, format: int32, description: pageNumber}
  934. pageSize: {type: integer, format: int32, description: pageSize}
  935. totalPages: {type: integer, format: int32, description: totalPages}
  936. totalCount: {type: integer, format: int32, description: totalCount}
  937. data:
  938. type: array
  939. items:
  940. type: object
  941. properties:
  942. id: {type: integer, format: int32, description: id}
  943. name: {type: string, description: name}
  944. description: {type: string, description: description}
  945. owner: {type: string, description: owner}
  946. ownerId: {type: integer, format: int32, description: ownerId}
  947. createdAt:
  948. type: object
  949. properties:
  950. value: {type: string, description: value}
  951. description: createdAt
  952. modifiedAt:
  953. type: object
  954. properties:
  955. value: {type: string, description: value}
  956. description: modifiedAt
  957. description: data
  958. '500':
  959. description: '500'
  960. schema:
  961. type: object
  962. properties:
  963. refId: {type: string, description: refId}
  964. errorCode: {type: number, format: float, description: errorCode}
  965. message: {type: string, description: message}
  966. post:
  967. summary: Add Group
  968. description: Add Group
  969. operationId: AddGroup
  970. parameters:
  971. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  972. description: Content-Type}
  973. - {name: Accept, in: header, required: true, type: string, default: application/json,
  974. description: Accept}
  975. - name: body
  976. in: body
  977. schema:
  978. type: object
  979. properties:
  980. name: {type: string, description: name}
  981. description: {type: string, description: description}
  982. members:
  983. type: array
  984. items:
  985. type: object
  986. properties:
  987. email: {type: string, description: email}
  988. description: members
  989. default:
  990. name: API-created group
  991. description: Group created via API
  992. members:
  993. - {email: [email protected]}
  994. - {email: [email protected]}
  995. required: true
  996. responses:
  997. '200':
  998. description: '200'
  999. schema:
  1000. type: object
  1001. properties:
  1002. message: {type: string, description: message}
  1003. resultCode: {type: integer, format: int32, description: resultCode}
  1004. result:
  1005. type: object
  1006. properties:
  1007. id: {type: integer, format: int32, description: id}
  1008. name: {type: string, description: name}
  1009. description: {type: string, description: description}
  1010. owner: {type: string, description: owner}
  1011. ownerId: {type: integer, format: int32, description: ownerId}
  1012. createdAt:
  1013. type: object
  1014. properties:
  1015. value: {type: string, description: value}
  1016. description: createdAt
  1017. modifiedAt:
  1018. type: object
  1019. properties:
  1020. value: {type: string, description: value}
  1021. description: modifiedAt
  1022. description: result
  1023. '400':
  1024. description: '400'
  1025. schema:
  1026. type: object
  1027. properties:
  1028. refId: {type: string, description: refId}
  1029. errorCode: {type: number, format: float, description: errorCode}
  1030. message: {type: string, description: message}
  1031. '401':
  1032. description: '401'
  1033. schema:
  1034. type: object
  1035. properties:
  1036. errorCode: {type: integer, format: int32, description: errorCode}
  1037. message: {type: string, description: message}
  1038. refId: {type: string, description: refId}
  1039. '500':
  1040. description: '500'
  1041. schema:
  1042. type: object
  1043. properties:
  1044. errorCode: {type: integer, format: int32, description: errorCode}
  1045. message: {type: string, description: message}
  1046. refId: {type: string, description: refId}
  1047. /home/folders:
  1048. get:
  1049. summary: List Folders in Home
  1050. description: List Folders in Home
  1051. operationId: ListFoldersInHome
  1052. parameters:
  1053. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  1054. - {name: page, default: '1', in: query, type: string, required: true}
  1055. - {name: pageSize, default: '100', in: query, type: string, required: true}
  1056. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1057. description: Accept}
  1058. responses:
  1059. '200':
  1060. description: '200'
  1061. schema:
  1062. type: object
  1063. properties:
  1064. pageNumber: {type: integer, format: int32, description: pageNumber}
  1065. pageSize: {type: integer, format: int32, description: pageSize}
  1066. totalPages: {type: integer, format: int32, description: totalPages}
  1067. totalCount: {type: integer, format: int32, description: totalCount}
  1068. result:
  1069. type: array
  1070. items:
  1071. type: object
  1072. properties:
  1073. value: {type: string, description: value}
  1074. description: result
  1075. '500':
  1076. description: '500'
  1077. schema:
  1078. type: object
  1079. properties:
  1080. refId: {type: string, description: refId}
  1081. errorCode: {type: number, format: float, description: errorCode}
  1082. message: {type: string, description: message}
  1083. post:
  1084. summary: Create Folder
  1085. description: Create Folder
  1086. operationId: CreateFolder23
  1087. parameters:
  1088. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  1089. description: Content-Type}
  1090. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1091. description: Accept}
  1092. - name: body
  1093. in: body
  1094. schema:
  1095. type: object
  1096. properties:
  1097. value: {type: string, description: value}
  1098. default: {value: 'reference #/components/schemas/Folder/properties/folders/items
  1099. not found in the OpenAPI spec'}
  1100. required: true
  1101. responses:
  1102. '200':
  1103. description: '200'
  1104. schema:
  1105. type: object
  1106. properties:
  1107. message: {type: string, description: message}
  1108. resultCode: {type: integer, format: int32, description: resultCode}
  1109. result:
  1110. type: object
  1111. properties:
  1112. value: {type: string, description: value}
  1113. description: result
  1114. '500':
  1115. description: '500'
  1116. schema:
  1117. type: object
  1118. properties:
  1119. refId: {type: string, description: refId}
  1120. errorCode: {type: number, format: float, description: errorCode}
  1121. message: {type: string, description: message}
  1122. /home:
  1123. get:
  1124. summary: List Contents
  1125. description: List Contents
  1126. operationId: ListContents
  1127. parameters:
  1128. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1129. description: Accept}
  1130. responses:
  1131. '200':
  1132. description: '200'
  1133. schema:
  1134. type: object
  1135. properties:
  1136. folders:
  1137. type: array
  1138. items:
  1139. type: object
  1140. properties:
  1141. value: {type: string, description: value}
  1142. description: folders
  1143. reports:
  1144. type: array
  1145. items:
  1146. type: object
  1147. properties:
  1148. value: {type: string, description: value}
  1149. description: reports
  1150. sheets:
  1151. type: array
  1152. items:
  1153. type: object
  1154. properties:
  1155. value: {type: string, description: value}
  1156. description: sheets
  1157. sights:
  1158. type: array
  1159. items:
  1160. type: object
  1161. properties:
  1162. value: {type: string, description: value}
  1163. description: sights
  1164. templates:
  1165. type: array
  1166. items:
  1167. type: object
  1168. properties:
  1169. value: {type: string, description: value}
  1170. description: templates
  1171. workspaces:
  1172. type: array
  1173. items:
  1174. type: object
  1175. properties:
  1176. value: {type: string, description: value}
  1177. description: workspaces
  1178. '500':
  1179. description: '500'
  1180. schema:
  1181. type: object
  1182. properties:
  1183. refId: {type: string, description: refId}
  1184. errorCode: {type: number, format: float, description: errorCode}
  1185. message: {type: string, description: message}
  1186. /reports/{reportId}/publish:
  1187. get:
  1188. summary: Gets a Report's publish settings
  1189. description: Gets a Report's publish settings
  1190. operationId: GetsAReportsPublishSettings
  1191. parameters:
  1192. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1193. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1194. description: Accept}
  1195. responses:
  1196. '200':
  1197. description: '200'
  1198. schema:
  1199. type: object
  1200. properties:
  1201. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  1202. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  1203. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  1204. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  1205. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  1206. '500':
  1207. description: '500'
  1208. schema:
  1209. type: object
  1210. properties:
  1211. refId: {type: string, description: refId}
  1212. errorCode: {type: number, format: float, description: errorCode}
  1213. message: {type: string, description: message}
  1214. put:
  1215. summary: Set a Report's publish status
  1216. description: Set a Report's publish status
  1217. operationId: SetAReportsPublishStatus
  1218. parameters:
  1219. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1220. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  1221. description: Content-Type}
  1222. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1223. description: Accept}
  1224. - name: body
  1225. in: body
  1226. schema:
  1227. type: object
  1228. properties:
  1229. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  1230. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  1231. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  1232. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  1233. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  1234. default: {readOnlyFullAccessibleBy: sint Excepteur sunt nisi, readOnlyFullDefaultView: voluptate
  1235. Duis, readOnlyFullEnabled: false, readOnlyFullShowToolbar: false, readOnlyFullUrl: sunt
  1236. deserunt aliqua sit}
  1237. required: true
  1238. responses:
  1239. '200':
  1240. description: '200'
  1241. schema:
  1242. type: object
  1243. properties:
  1244. message: {type: string, description: message}
  1245. resultCode: {type: integer, format: int32, description: resultCode}
  1246. result:
  1247. type: object
  1248. properties:
  1249. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  1250. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  1251. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  1252. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  1253. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  1254. description: result
  1255. '500':
  1256. description: '500'
  1257. schema:
  1258. type: object
  1259. properties:
  1260. refId: {type: string, description: refId}
  1261. errorCode: {type: number, format: float, description: errorCode}
  1262. message: {type: string, description: message}
  1263. /reports/{reportId}/shares/{shareId}:
  1264. get:
  1265. summary: Get Report Share.
  1266. description: Get Report Share.
  1267. operationId: GetReportShare
  1268. parameters:
  1269. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1270. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  1271. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1272. description: Accept}
  1273. responses:
  1274. '200':
  1275. description: '200'
  1276. schema:
  1277. type: object
  1278. properties:
  1279. id: {type: string, description: id}
  1280. groupId: {type: number, format: float, description: groupId}
  1281. userId: {type: number, format: float, description: userId}
  1282. type: {type: string, description: type}
  1283. accessLevel:
  1284. type: object
  1285. properties:
  1286. value: {type: string, description: value}
  1287. description: accessLevel
  1288. ccMe: {type: boolean, description: ccMe}
  1289. createdAt: {type: string, description: createdAt}
  1290. email: {type: string, description: email}
  1291. message: {type: string, description: message}
  1292. modifiedAt: {type: string, description: modifiedAt}
  1293. name: {type: string, description: name}
  1294. scope: {type: string, description: scope}
  1295. subject: {type: string, description: subject}
  1296. '500':
  1297. description: '500'
  1298. schema:
  1299. type: object
  1300. properties:
  1301. refId: {type: string, description: refId}
  1302. errorCode: {type: number, format: float, description: errorCode}
  1303. message: {type: string, description: message}
  1304. delete:
  1305. summary: Delete Report Share
  1306. description: Delete Report Share
  1307. operationId: DeleteReportShare
  1308. parameters:
  1309. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1310. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  1311. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1312. description: Accept}
  1313. responses:
  1314. '200':
  1315. description: '200'
  1316. schema:
  1317. type: object
  1318. properties:
  1319. message: {type: string, description: message}
  1320. resultCode: {type: integer, format: int32, description: resultCode}
  1321. '500':
  1322. description: '500'
  1323. schema:
  1324. type: object
  1325. properties:
  1326. refId: {type: string, description: refId}
  1327. errorCode: {type: number, format: float, description: errorCode}
  1328. message: {type: string, description: message}
  1329. put:
  1330. summary: Update Report Share.
  1331. description: Update Report Share.
  1332. operationId: UpdateReportShare
  1333. parameters:
  1334. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1335. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  1336. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  1337. description: Content-Type}
  1338. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1339. description: Accept}
  1340. - name: body
  1341. in: body
  1342. schema:
  1343. type: object
  1344. properties:
  1345. id: {type: string, description: id}
  1346. groupId: {type: number, format: float, description: groupId}
  1347. userId: {type: number, format: float, description: userId}
  1348. type: {type: string, description: type}
  1349. accessLevel:
  1350. type: object
  1351. properties:
  1352. value: {type: string, description: value}
  1353. description: accessLevel
  1354. ccMe: {type: boolean, description: ccMe}
  1355. createdAt: {type: string, description: createdAt}
  1356. email: {type: string, description: email}
  1357. message: {type: string, description: message}
  1358. modifiedAt: {type: string, description: modifiedAt}
  1359. name: {type: string, description: name}
  1360. scope: {type: string, description: scope}
  1361. subject: {type: string, description: subject}
  1362. default:
  1363. id: mollit
  1364. groupId: 6458197.992068276
  1365. userId: 55638615.369980216
  1366. type: proident ex
  1367. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  1368. not found in the OpenAPI spec'}
  1369. ccMe: false
  1370. createdAt: <dateTime>
  1371. email: voluptate Duis minim Lorem
  1372. message: voluptate officia eiusmod qui
  1373. modifiedAt: <dateTime>
  1374. name: do in
  1375. scope: occaecat labore
  1376. subject: deserunt ut
  1377. required: true
  1378. responses:
  1379. '200':
  1380. description: '200'
  1381. schema:
  1382. type: object
  1383. properties:
  1384. message:
  1385. type: object
  1386. properties:
  1387. value: {type: string, description: value}
  1388. description: message
  1389. resultCode:
  1390. type: object
  1391. properties:
  1392. value: {type: string, description: value}
  1393. description: resultCode
  1394. result:
  1395. type: object
  1396. properties: {}
  1397. description: result
  1398. '500':
  1399. description: '500'
  1400. schema:
  1401. type: object
  1402. properties:
  1403. refId: {type: string, description: refId}
  1404. errorCode: {type: number, format: float, description: errorCode}
  1405. message: {type: string, description: message}
  1406. /reports/{reportId}/shares:
  1407. get:
  1408. summary: List Report Shares
  1409. description: List Report Shares
  1410. operationId: ListReportShares
  1411. parameters:
  1412. - {name: sharingInclude, default: ITEM, in: query, type: string, required: true}
  1413. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  1414. - {name: page, default: '1', in: query, type: string, required: true}
  1415. - {name: pageSize, default: '100', in: query, type: string, required: true}
  1416. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1417. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1418. description: Accept}
  1419. responses:
  1420. '200':
  1421. description: '200'
  1422. schema:
  1423. type: object
  1424. properties:
  1425. pageNumber: {type: integer, format: int32, description: pageNumber}
  1426. pageSize: {type: integer, format: int32, description: pageSize}
  1427. totalPages: {type: integer, format: int32, description: totalPages}
  1428. totalCount: {type: integer, format: int32, description: totalCount}
  1429. result:
  1430. type: array
  1431. items:
  1432. type: object
  1433. properties:
  1434. id: {type: string, description: id}
  1435. groupId: {type: number, format: float, description: groupId}
  1436. userId: {type: number, format: float, description: userId}
  1437. type: {type: string, description: type}
  1438. accessLevel:
  1439. type: object
  1440. properties:
  1441. value: {type: string, description: value}
  1442. description: accessLevel
  1443. ccMe: {type: boolean, description: ccMe}
  1444. createdAt:
  1445. type: object
  1446. properties:
  1447. value: {type: string, description: value}
  1448. description: createdAt
  1449. email: {type: string, description: email}
  1450. message: {type: string, description: message}
  1451. modifiedAt:
  1452. type: object
  1453. properties:
  1454. value: {type: string, description: value}
  1455. description: modifiedAt
  1456. name: {type: string, description: name}
  1457. scope: {type: string, description: scope}
  1458. subject: {type: string, description: subject}
  1459. description: result
  1460. '500':
  1461. description: '500'
  1462. schema:
  1463. type: object
  1464. properties:
  1465. refId: {type: string, description: refId}
  1466. errorCode: {type: number, format: float, description: errorCode}
  1467. message: {type: string, description: message}
  1468. post:
  1469. summary: Share Report
  1470. description: Share Report
  1471. operationId: ShareReport
  1472. parameters:
  1473. - {name: sendEmail, default: 'false', in: query, type: string, required: true}
  1474. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1475. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  1476. description: Content-Type}
  1477. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1478. description: Accept}
  1479. - name: body
  1480. in: body
  1481. schema:
  1482. type: object
  1483. properties:
  1484. id: {type: string, description: id}
  1485. groupId: {type: number, format: float, description: groupId}
  1486. userId: {type: number, format: float, description: userId}
  1487. type: {type: string, description: type}
  1488. accessLevel:
  1489. type: object
  1490. properties:
  1491. value: {type: string, description: value}
  1492. description: accessLevel
  1493. ccMe: {type: boolean, description: ccMe}
  1494. createdAt: {type: string, description: createdAt}
  1495. email: {type: string, description: email}
  1496. message: {type: string, description: message}
  1497. modifiedAt: {type: string, description: modifiedAt}
  1498. name: {type: string, description: name}
  1499. scope: {type: string, description: scope}
  1500. subject: {type: string, description: subject}
  1501. default:
  1502. id: mollit
  1503. groupId: 6458197.992068276
  1504. userId: 55638615.369980216
  1505. type: proident ex
  1506. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  1507. not found in the OpenAPI spec'}
  1508. ccMe: false
  1509. createdAt: <dateTime>
  1510. email: voluptate Duis minim Lorem
  1511. message: voluptate officia eiusmod qui
  1512. modifiedAt: <dateTime>
  1513. name: do in
  1514. scope: occaecat labore
  1515. subject: deserunt ut
  1516. required: true
  1517. responses:
  1518. '200':
  1519. description: '200'
  1520. schema:
  1521. type: object
  1522. properties:
  1523. message: {type: string, description: message}
  1524. resultCode: {type: integer, format: int32, description: resultCode}
  1525. result:
  1526. type: object
  1527. properties:
  1528. id: {type: string, description: id}
  1529. groupId: {type: number, format: float, description: groupId}
  1530. userId: {type: number, format: float, description: userId}
  1531. type: {type: string, description: type}
  1532. accessLevel:
  1533. type: object
  1534. properties:
  1535. value: {type: string, description: value}
  1536. description: accessLevel
  1537. ccMe: {type: boolean, description: ccMe}
  1538. createdAt:
  1539. type: object
  1540. properties:
  1541. value: {type: string, description: value}
  1542. description: createdAt
  1543. email: {type: string, description: email}
  1544. message: {type: string, description: message}
  1545. modifiedAt:
  1546. type: object
  1547. properties:
  1548. value: {type: string, description: value}
  1549. description: modifiedAt
  1550. name: {type: string, description: name}
  1551. scope: {type: string, description: scope}
  1552. subject: {type: string, description: subject}
  1553. description: result
  1554. '400':
  1555. description: '400'
  1556. schema:
  1557. type: object
  1558. properties:
  1559. refId: {type: string, description: refId}
  1560. errorCode: {type: number, format: float, description: errorCode}
  1561. message: {type: string, description: message}
  1562. '500':
  1563. description: '500'
  1564. schema:
  1565. type: object
  1566. properties:
  1567. refId: {type: string, description: refId}
  1568. errorCode: {type: number, format: float, description: errorCode}
  1569. message: {type: string, description: message}
  1570. /reports/{reportId}:
  1571. get:
  1572. summary: Get Report
  1573. description: Get Report
  1574. operationId: GetReport
  1575. parameters:
  1576. - {name: include, default: format, in: query, type: string, required: true}
  1577. - {name: exclude, default: linksOutToCellsDetails, in: query, type: string,
  1578. required: true}
  1579. - {name: pageSize, default: '100', in: query, type: string, required: true}
  1580. - {name: page, default: '1', in: query, type: string, required: true}
  1581. - {name: level, default: '0', in: query, type: string, required: true}
  1582. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1583. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1584. description: Accept}
  1585. responses:
  1586. '200':
  1587. description: '200'
  1588. schema:
  1589. type: object
  1590. properties:
  1591. value: {type: string, description: value}
  1592. '500':
  1593. description: '500'
  1594. schema:
  1595. type: object
  1596. properties:
  1597. refId: {type: string, description: refId}
  1598. errorCode: {type: number, format: float, description: errorCode}
  1599. message: {type: string, description: message}
  1600. /reports/{reportId}/emails:
  1601. post:
  1602. summary: Send report via email
  1603. description: Send report via email
  1604. operationId: SendReportViaEmail
  1605. parameters:
  1606. - {name: reportId, default: '-4847524.674802229', in: path, type: string, required: true}
  1607. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  1608. description: Content-Type}
  1609. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1610. description: Accept}
  1611. - name: body
  1612. in: body
  1613. schema:
  1614. type: object
  1615. properties:
  1616. value: {type: string, description: value}
  1617. default: {value: 'reference #/components/schemas/ProofRequestBody/allOf/0
  1618. not found in the OpenAPI spec'}
  1619. required: true
  1620. responses:
  1621. '200':
  1622. description: '200'
  1623. schema:
  1624. type: object
  1625. properties:
  1626. message: {type: string, description: message}
  1627. resultCode: {type: integer, format: int32, description: resultCode}
  1628. '500':
  1629. description: '500'
  1630. schema:
  1631. type: object
  1632. properties:
  1633. refId: {type: string, description: refId}
  1634. errorCode: {type: number, format: float, description: errorCode}
  1635. message: {type: string, description: message}
  1636. /reports:
  1637. get:
  1638. summary: Get Reports
  1639. description: Get Reports
  1640. operationId: GetReports
  1641. parameters:
  1642. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  1643. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1644. description: Accept}
  1645. responses:
  1646. '200':
  1647. description: '200'
  1648. schema:
  1649. type: object
  1650. properties:
  1651. pageNumber: {type: integer, format: int32, description: pageNumber}
  1652. pageSize: {type: integer, format: int32, description: pageSize}
  1653. totalPages: {type: integer, format: int32, description: totalPages}
  1654. totalCount: {type: integer, format: int32, description: totalCount}
  1655. data:
  1656. type: array
  1657. items:
  1658. type: object
  1659. properties:
  1660. value: {type: string, description: value}
  1661. description: data
  1662. '500':
  1663. description: '500'
  1664. schema:
  1665. type: object
  1666. properties:
  1667. refId: {type: string, description: refId}
  1668. errorCode: {type: number, format: float, description: errorCode}
  1669. message: {type: string, description: message}
  1670. /search:
  1671. get:
  1672. summary: Search Everything
  1673. description: Search Everything
  1674. operationId: SearchEverything
  1675. parameters:
  1676. - {name: query, default: ex Excepteur laboris, in: query, type: string, required: true}
  1677. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1678. description: Accept}
  1679. responses:
  1680. '200':
  1681. description: '200'
  1682. schema:
  1683. type: object
  1684. properties:
  1685. pageNumber: {type: integer, format: int32, description: pageNumber}
  1686. pageSize: {type: integer, format: int32, description: pageSize}
  1687. totalPages: {type: integer, format: int32, description: totalPages}
  1688. totalCount: {type: integer, format: int32, description: totalCount}
  1689. result:
  1690. type: array
  1691. items:
  1692. type: object
  1693. properties:
  1694. results:
  1695. type: array
  1696. items:
  1697. type: object
  1698. properties:
  1699. value: {type: string, description: value}
  1700. description: results
  1701. totalCount: {type: number, format: float, description: totalCount}
  1702. description: result
  1703. '500':
  1704. description: '500'
  1705. schema:
  1706. type: object
  1707. properties:
  1708. refId: {type: string, description: refId}
  1709. errorCode: {type: number, format: float, description: errorCode}
  1710. message: {type: string, description: message}
  1711. /search/sheets/{sheetId}:
  1712. get:
  1713. summary: Search Sheet
  1714. description: Search Sheet
  1715. operationId: SearchSheet
  1716. parameters:
  1717. - {name: query, default: ex Excepteur laboris, in: query, type: string, required: true}
  1718. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1719. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1720. description: Accept}
  1721. responses:
  1722. '200':
  1723. description: '200'
  1724. schema:
  1725. type: object
  1726. properties:
  1727. pageNumber: {type: integer, format: int32, description: pageNumber}
  1728. pageSize: {type: integer, format: int32, description: pageSize}
  1729. totalPages: {type: integer, format: int32, description: totalPages}
  1730. totalCount: {type: integer, format: int32, description: totalCount}
  1731. result:
  1732. type: array
  1733. items:
  1734. type: object
  1735. properties:
  1736. value: {type: string, description: value}
  1737. description: result
  1738. '500':
  1739. description: '500'
  1740. schema:
  1741. type: object
  1742. properties:
  1743. refId: {type: string, description: refId}
  1744. errorCode: {type: number, format: float, description: errorCode}
  1745. message: {type: string, description: message}
  1746. /sheets/{sheetId}/attachments/{attachmentId}/versions:
  1747. get:
  1748. summary: List Versions
  1749. description: List Versions
  1750. operationId: ListVersions
  1751. parameters:
  1752. - {name: page, default: '1', in: query, type: string, required: true}
  1753. - {name: pageSize, default: '100', in: query, type: string, required: true}
  1754. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  1755. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1756. - {name: attachmentId, default: ex Excepteur laboris, in: path, type: string,
  1757. required: true}
  1758. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1759. description: Accept}
  1760. responses:
  1761. '200':
  1762. description: '200'
  1763. schema:
  1764. type: object
  1765. properties:
  1766. pageNumber: {type: integer, format: int32, description: pageNumber}
  1767. pageSize: {type: integer, format: int32, description: pageSize}
  1768. totalPages: {type: integer, format: int32, description: totalPages}
  1769. totalCount: {type: integer, format: int32, description: totalCount}
  1770. data:
  1771. type: array
  1772. items:
  1773. type: object
  1774. properties:
  1775. id: {type: number, format: float, description: id}
  1776. parentId: {type: number, format: float, description: parentId}
  1777. attachmentType: {type: string, description: attachmentType}
  1778. attachmentSubType: {type: string, description: attachmentSubType}
  1779. mimeType: {type: string, description: mimeType}
  1780. parentType: {type: string, description: parentType}
  1781. createdAt:
  1782. type: object
  1783. properties:
  1784. value: {type: string, description: value}
  1785. description: createdAt
  1786. createdBy:
  1787. type: object
  1788. properties:
  1789. value: {type: string, description: value}
  1790. description: createdBy
  1791. name: {type: string, description: name}
  1792. sizeInKb: {type: number, format: float, description: sizeInKb}
  1793. url: {type: string, description: url}
  1794. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  1795. description: data
  1796. delete:
  1797. summary: Delete All Versions
  1798. description: Delete All Versions
  1799. operationId: DeleteAllVersions
  1800. parameters:
  1801. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1802. - {name: attachmentId, default: ex Excepteur laboris, in: path, type: string,
  1803. required: true}
  1804. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1805. description: Accept}
  1806. responses:
  1807. '200':
  1808. description: '200'
  1809. schema:
  1810. type: object
  1811. properties:
  1812. message: {type: string, description: message}
  1813. resultCode: {type: integer, format: int32, description: resultCode}
  1814. post:
  1815. summary: Attach New version
  1816. description: Attach New version
  1817. operationId: AttachNewVersion
  1818. parameters:
  1819. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1820. - {name: attachmentId, default: ex Excepteur laboris, in: path, type: string,
  1821. required: true}
  1822. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  1823. description: Content-Type}
  1824. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1825. description: Accept}
  1826. responses:
  1827. '200':
  1828. description: '200'
  1829. schema:
  1830. type: object
  1831. properties:
  1832. message: {type: string, description: message}
  1833. resultCode: {type: integer, format: int32, description: resultCode}
  1834. result:
  1835. type: object
  1836. properties:
  1837. id: {type: number, format: float, description: id}
  1838. parentId: {type: number, format: float, description: parentId}
  1839. attachmentType: {type: string, description: attachmentType}
  1840. attachmentSubType: {type: string, description: attachmentSubType}
  1841. mimeType: {type: string, description: mimeType}
  1842. parentType: {type: string, description: parentType}
  1843. createdAt:
  1844. type: object
  1845. properties:
  1846. value: {type: string, description: value}
  1847. description: createdAt
  1848. createdBy:
  1849. type: object
  1850. properties:
  1851. value: {type: string, description: value}
  1852. description: createdBy
  1853. name: {type: string, description: name}
  1854. sizeInKb: {type: number, format: float, description: sizeInKb}
  1855. url: {type: string, description: url}
  1856. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  1857. description: result
  1858. /sheets/{sheetId}/attachments/{attachmentId}:
  1859. get:
  1860. summary: Get Attachment
  1861. description: Get Attachment
  1862. operationId: GetAttachment
  1863. parameters:
  1864. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1865. - {name: attachmentId, default: ex Excepteur laboris, in: path, type: string,
  1866. required: true}
  1867. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1868. description: Accept}
  1869. responses:
  1870. '200':
  1871. description: '200'
  1872. schema:
  1873. type: object
  1874. properties:
  1875. id: {type: number, format: float, description: id}
  1876. parentId: {type: number, format: float, description: parentId}
  1877. attachmentType: {type: string, description: attachmentType}
  1878. attachmentSubType: {type: string, description: attachmentSubType}
  1879. mimeType: {type: string, description: mimeType}
  1880. parentType: {type: string, description: parentType}
  1881. createdAt: {type: string, description: createdAt}
  1882. createdBy:
  1883. type: object
  1884. properties:
  1885. email:
  1886. type: object
  1887. properties:
  1888. value: {type: string, description: value}
  1889. description: email
  1890. name:
  1891. type: object
  1892. properties:
  1893. value: {type: string, description: value}
  1894. description: name
  1895. description: createdBy
  1896. name: {type: string, description: name}
  1897. sizeInKb: {type: number, format: float, description: sizeInKb}
  1898. url: {type: string, description: url}
  1899. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  1900. delete:
  1901. summary: Delete Attachment
  1902. description: Delete Attachment
  1903. operationId: DeleteAttachment
  1904. parameters:
  1905. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1906. - {name: attachmentId, default: ex Excepteur laboris, in: path, type: string,
  1907. required: true}
  1908. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1909. description: Accept}
  1910. responses:
  1911. '200':
  1912. description: '200'
  1913. schema:
  1914. type: object
  1915. properties:
  1916. message: {type: string, description: message}
  1917. resultCode: {type: integer, format: int32, description: resultCode}
  1918. /sheets/{sheetId}/attachments:
  1919. get:
  1920. summary: List Attachments
  1921. description: List Attachments
  1922. operationId: ListAttachments
  1923. parameters:
  1924. - {name: page, default: '1', in: query, type: string, required: true}
  1925. - {name: pageSize, default: '100', in: query, type: string, required: true}
  1926. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  1927. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1928. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1929. description: Accept}
  1930. responses:
  1931. '200':
  1932. description: '200'
  1933. schema:
  1934. type: object
  1935. properties:
  1936. pageNumber: {type: integer, format: int32, description: pageNumber}
  1937. pageSize: {type: integer, format: int32, description: pageSize}
  1938. totalPages: {type: integer, format: int32, description: totalPages}
  1939. totalCount: {type: integer, format: int32, description: totalCount}
  1940. data:
  1941. type: array
  1942. items:
  1943. type: object
  1944. properties:
  1945. id: {type: number, format: float, description: id}
  1946. parentId: {type: number, format: float, description: parentId}
  1947. attachmentType: {type: string, description: attachmentType}
  1948. attachmentSubType: {type: string, description: attachmentSubType}
  1949. mimeType: {type: string, description: mimeType}
  1950. parentType: {type: string, description: parentType}
  1951. createdAt:
  1952. type: object
  1953. properties:
  1954. value: {type: string, description: value}
  1955. description: createdAt
  1956. createdBy:
  1957. type: object
  1958. properties:
  1959. value: {type: string, description: value}
  1960. description: createdBy
  1961. name: {type: string, description: name}
  1962. sizeInKb: {type: number, format: float, description: sizeInKb}
  1963. url: {type: string, description: url}
  1964. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  1965. description: data
  1966. post:
  1967. summary: Attach File or URL to Sheet
  1968. description: Attach File or URL to Sheet
  1969. operationId: AttachFileOrUrlToSheet
  1970. parameters:
  1971. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  1972. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  1973. description: Content-Type}
  1974. - {name: Accept, in: header, required: true, type: string, default: application/json,
  1975. description: Accept}
  1976. responses:
  1977. '200':
  1978. description: '200'
  1979. schema:
  1980. type: object
  1981. properties:
  1982. message: {type: string, description: message}
  1983. resultCode: {type: integer, format: int32, description: resultCode}
  1984. result:
  1985. type: object
  1986. properties:
  1987. id: {type: number, format: float, description: id}
  1988. parentId: {type: number, format: float, description: parentId}
  1989. attachmentType: {type: string, description: attachmentType}
  1990. attachmentSubType: {type: string, description: attachmentSubType}
  1991. mimeType: {type: string, description: mimeType}
  1992. parentType: {type: string, description: parentType}
  1993. createdAt:
  1994. type: object
  1995. properties:
  1996. value: {type: string, description: value}
  1997. description: createdAt
  1998. createdBy:
  1999. type: object
  2000. properties:
  2001. value: {type: string, description: value}
  2002. description: createdBy
  2003. name: {type: string, description: name}
  2004. sizeInKb: {type: number, format: float, description: sizeInKb}
  2005. url: {type: string, description: url}
  2006. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  2007. description: result
  2008. /sheets/{sheetId}/automationrules/{automationRuleId}:
  2009. get:
  2010. summary: Get an Automation Rule
  2011. description: Get an Automation Rule
  2012. operationId: GetAnAutomationRule
  2013. parameters:
  2014. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2015. - {name: automationRuleId, default: ex Excepteur laboris, in: path, type: string,
  2016. required: true}
  2017. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2018. description: Accept}
  2019. responses:
  2020. '200':
  2021. description: '200'
  2022. schema:
  2023. type: object
  2024. properties:
  2025. id: {type: number, format: float, description: id}
  2026. action:
  2027. type: object
  2028. properties:
  2029. value: {type: string, description: value}
  2030. description: action
  2031. createdAt:
  2032. type: object
  2033. properties:
  2034. value: {type: string, description: value}
  2035. description: createdAt
  2036. createdBy:
  2037. type: object
  2038. properties:
  2039. email:
  2040. type: object
  2041. properties:
  2042. value: {type: string, description: value}
  2043. description: email
  2044. name:
  2045. type: object
  2046. properties:
  2047. value: {type: string, description: value}
  2048. description: name
  2049. description: createdBy
  2050. disabledReason: {type: string, description: disabledReason}
  2051. disabledReasonText: {type: string, description: disabledReasonText}
  2052. enabled: {type: boolean, description: enabled}
  2053. modifiedAt:
  2054. type: object
  2055. properties:
  2056. value: {type: string, description: value}
  2057. description: modifiedAt
  2058. modifiedBy:
  2059. type: object
  2060. properties:
  2061. email:
  2062. type: object
  2063. properties:
  2064. value: {type: string, description: value}
  2065. description: email
  2066. name:
  2067. type: object
  2068. properties:
  2069. value: {type: string, description: value}
  2070. description: name
  2071. description: modifiedBy
  2072. name: {type: string, description: name}
  2073. userCanModify: {type: boolean, description: userCanModify}
  2074. delete:
  2075. summary: Delete an Automation Rule
  2076. description: Delete an Automation Rule
  2077. operationId: DeleteAnAutomationRule
  2078. parameters:
  2079. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2080. - {name: automationRuleId, default: ex Excepteur laboris, in: path, type: string,
  2081. required: true}
  2082. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2083. description: Accept}
  2084. responses:
  2085. '200':
  2086. description: '200'
  2087. schema:
  2088. type: object
  2089. properties:
  2090. message: {type: string, description: message}
  2091. resultCode: {type: integer, format: int32, description: resultCode}
  2092. put:
  2093. summary: Update an Automation Rule
  2094. description: Update an Automation Rule
  2095. operationId: UpdateAnAutomationRule
  2096. parameters:
  2097. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2098. - {name: automationRuleId, default: ex Excepteur laboris, in: path, type: string,
  2099. required: true}
  2100. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  2101. description: Content-Type}
  2102. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2103. description: Accept}
  2104. - name: body
  2105. in: body
  2106. schema:
  2107. type: object
  2108. properties:
  2109. id: {type: number, format: float, description: id}
  2110. action:
  2111. type: object
  2112. properties:
  2113. value: {type: string, description: value}
  2114. description: action
  2115. createdAt:
  2116. type: object
  2117. properties:
  2118. value: {type: string, description: value}
  2119. description: createdAt
  2120. createdBy:
  2121. type: object
  2122. properties:
  2123. email:
  2124. type: object
  2125. properties:
  2126. value: {type: string, description: value}
  2127. description: email
  2128. description: createdBy
  2129. disabledReason: {type: string, description: disabledReason}
  2130. disabledReasonText: {type: string, description: disabledReasonText}
  2131. enabled: {type: boolean, description: enabled}
  2132. modifiedAt:
  2133. type: object
  2134. properties:
  2135. value: {type: string, description: value}
  2136. description: modifiedAt
  2137. modifiedBy:
  2138. type: object
  2139. properties:
  2140. email:
  2141. type: object
  2142. properties:
  2143. value: {type: string, description: value}
  2144. description: email
  2145. description: modifiedBy
  2146. name: {type: string, description: name}
  2147. userCanModify: {type: boolean, description: userCanModify}
  2148. default:
  2149. id: 46295564.545469224
  2150. action: {value: '<Error: Too many levels of nesting to fake this schema>'}
  2151. createdAt: {value: '<Error: Too many levels of nesting to fake this schema>'}
  2152. createdBy:
  2153. email: {value: '<Error: Too many levels of nesting to fake this schema>'}
  2154. disabledReason: NO_POTENTIAL_RECIPIENTS
  2155. disabledReasonText: Lorem incididunt ullamco
  2156. enabled: false
  2157. modifiedAt: {value: '<Error: Too many levels of nesting to fake this schema>'}
  2158. modifiedBy:
  2159. email: {value: '<Error: Too many levels of nesting to fake this schema>'}
  2160. name: consectetur Lorem adipisicing amet
  2161. userCanModify: true
  2162. required: true
  2163. responses:
  2164. '200':
  2165. description: '200'
  2166. schema:
  2167. type: object
  2168. properties:
  2169. message: {type: string, description: message}
  2170. resultCode: {type: integer, format: int32, description: resultCode}
  2171. result:
  2172. type: object
  2173. properties:
  2174. id: {type: number, format: float, description: id}
  2175. action:
  2176. type: object
  2177. properties:
  2178. value: {type: string, description: value}
  2179. description: action
  2180. createdAt:
  2181. type: object
  2182. properties:
  2183. value: {type: string, description: value}
  2184. description: createdAt
  2185. createdBy:
  2186. type: object
  2187. properties:
  2188. value: {type: string, description: value}
  2189. description: createdBy
  2190. disabledReason: {type: string, description: disabledReason}
  2191. disabledReasonText: {type: string, description: disabledReasonText}
  2192. enabled: {type: boolean, description: enabled}
  2193. modifiedAt:
  2194. type: object
  2195. properties:
  2196. value: {type: string, description: value}
  2197. description: modifiedAt
  2198. modifiedBy:
  2199. type: object
  2200. properties:
  2201. value: {type: string, description: value}
  2202. description: modifiedBy
  2203. name: {type: string, description: name}
  2204. userCanModify: {type: boolean, description: userCanModify}
  2205. description: result
  2206. /sheets/{sheetId}/automationrules:
  2207. get:
  2208. summary: List All Automation Rules
  2209. description: List All Automation Rules
  2210. operationId: ListAllAutomationRules
  2211. parameters:
  2212. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2213. - {name: page, default: '1', in: query, type: string, required: true}
  2214. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2215. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2216. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2217. description: Accept}
  2218. responses:
  2219. '200':
  2220. description: '200'
  2221. schema:
  2222. type: object
  2223. properties:
  2224. pageNumber: {type: integer, format: int32, description: pageNumber}
  2225. pageSize: {type: integer, format: int32, description: pageSize}
  2226. totalPages: {type: integer, format: int32, description: totalPages}
  2227. totalCount: {type: integer, format: int32, description: totalCount}
  2228. data:
  2229. type: array
  2230. items:
  2231. type: object
  2232. properties:
  2233. id: {type: number, format: float, description: id}
  2234. action:
  2235. type: object
  2236. properties:
  2237. value: {type: string, description: value}
  2238. description: action
  2239. createdAt:
  2240. type: object
  2241. properties:
  2242. value: {type: string, description: value}
  2243. description: createdAt
  2244. createdBy:
  2245. type: object
  2246. properties:
  2247. value: {type: string, description: value}
  2248. description: createdBy
  2249. disabledReason: {type: string, description: disabledReason}
  2250. disabledReasonText: {type: string, description: disabledReasonText}
  2251. enabled: {type: boolean, description: enabled}
  2252. modifiedAt:
  2253. type: object
  2254. properties:
  2255. value: {type: string, description: value}
  2256. description: modifiedAt
  2257. modifiedBy:
  2258. type: object
  2259. properties:
  2260. value: {type: string, description: value}
  2261. description: modifiedBy
  2262. name: {type: string, description: name}
  2263. userCanModify: {type: boolean, description: userCanModify}
  2264. description: data
  2265. /sheets/{sheetId}/columns/{columnId}:
  2266. get:
  2267. summary: Get Column
  2268. description: Get Column
  2269. operationId: GetColumn
  2270. parameters:
  2271. - {name: level, default: '1', in: query, type: string, required: true}
  2272. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2273. - {name: columnId, default: '-4847524.674802229', in: path, type: string, required: true}
  2274. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2275. description: Accept}
  2276. responses:
  2277. '200':
  2278. description: '200'
  2279. schema:
  2280. type: object
  2281. properties:
  2282. id: {type: number, format: float, description: id}
  2283. index: {type: number, format: float, description: index}
  2284. symbol: {type: string, description: symbol}
  2285. title: {type: string, description: title}
  2286. type: {type: string, description: type}
  2287. validation: {type: boolean, description: validation}
  2288. delete:
  2289. summary: Delete Column
  2290. description: Delete Column
  2291. operationId: DeleteColumn
  2292. parameters:
  2293. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2294. - {name: columnId, default: '-4847524.674802229', in: path, type: string, required: true}
  2295. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2296. description: Accept}
  2297. responses:
  2298. '200':
  2299. description: '200'
  2300. schema:
  2301. type: object
  2302. properties:
  2303. message: {type: string, description: message}
  2304. resultCode: {type: integer, format: int32, description: resultCode}
  2305. put:
  2306. summary: Update Column
  2307. description: Update Column
  2308. operationId: UpdateColumn
  2309. parameters:
  2310. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2311. - {name: columnId, default: '-4847524.674802229', in: path, type: string, required: true}
  2312. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  2313. description: Content-Type}
  2314. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2315. description: Accept}
  2316. - name: body
  2317. in: body
  2318. schema:
  2319. type: object
  2320. properties:
  2321. title: {type: string, description: title}
  2322. type: {type: string, description: type}
  2323. formula: {type: string, description: formula}
  2324. hidden: {type: boolean, description: hidden}
  2325. index: {type: number, format: float, description: index}
  2326. autoNumberFormat:
  2327. type: object
  2328. properties:
  2329. fill: {type: string, description: fill}
  2330. prefix: {type: string, description: prefix}
  2331. startingNumber: {type: number, format: float, description: startingNumber}
  2332. suffix: {type: string, description: suffix}
  2333. description: autoNumberFormat
  2334. contactOptions:
  2335. type: object
  2336. properties:
  2337. email: {type: string, description: email}
  2338. name: {type: string, description: name}
  2339. description: contactOptions
  2340. description: {type: string, description: description}
  2341. format: {type: string, description: format}
  2342. locked: {type: boolean, description: locked}
  2343. lockedForUser: {type: boolean, description: lockedForUser}
  2344. options:
  2345. type: array
  2346. items: {type: string}
  2347. description: options
  2348. symbol: {type: string, description: symbol}
  2349. systemColumnType: {type: string, description: systemColumnType}
  2350. validation: {type: boolean, description: validation}
  2351. version: {type: number, format: float, description: version}
  2352. width: {type: number, format: float, description: width}
  2353. default:
  2354. title: reprehenderi
  2355. type: MULTI_CONTACT_LIST
  2356. formula: dolore ea
  2357. hidden: false
  2358. index: -93894618.19502069
  2359. autoNumberFormat: {fill: Duis labore laborum, prefix: tempor sunt adipisicing
  2360. magna minim, startingNumber: -82450136.44230506, suffix: adipisicing
  2361. magna anim}
  2362. contactOptions: {email: dolore id nulla, name: Ut proident anim eiusmod}
  2363. description: nostrud sunt
  2364. format: enim
  2365. locked: true
  2366. lockedForUser: false
  2367. options: [aute aliq, amet pariatur irure magna]
  2368. symbol: dolore commodo quis nisi
  2369. systemColumnType: MODIFIED_DATE
  2370. validation: true
  2371. version: 9149821.630291343
  2372. width: -81247707.33269045
  2373. required: true
  2374. responses:
  2375. '200':
  2376. description: '200'
  2377. schema:
  2378. type: object
  2379. properties:
  2380. message: {type: string, description: message}
  2381. resultCode: {type: integer, format: int32, description: resultCode}
  2382. result:
  2383. type: object
  2384. properties:
  2385. id: {type: number, format: float, description: id}
  2386. index: {type: number, format: float, description: index}
  2387. options:
  2388. type: array
  2389. items: {type: string}
  2390. description: options
  2391. title: {type: string, description: title}
  2392. type: {type: string, description: type}
  2393. validation: {type: boolean, description: validation}
  2394. description: result
  2395. /sheets/{sheetId}/columns:
  2396. get:
  2397. summary: List Columns
  2398. description: List Columns
  2399. operationId: ListColumns
  2400. parameters:
  2401. - {name: level, default: '1', in: query, type: string, required: true}
  2402. - {name: page, default: '1', in: query, type: string, required: true}
  2403. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2404. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2405. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2406. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2407. description: Accept}
  2408. responses:
  2409. '200':
  2410. description: '200'
  2411. schema:
  2412. type: object
  2413. properties:
  2414. pageNumber: {type: integer, format: int32, description: pageNumber}
  2415. pageSize: {type: integer, format: int32, description: pageSize}
  2416. totalPages: {type: integer, format: int32, description: totalPages}
  2417. totalCount: {type: integer, format: int32, description: totalCount}
  2418. data:
  2419. type: array
  2420. items:
  2421. type: object
  2422. properties:
  2423. id: {type: number, format: float, description: id}
  2424. index: {type: number, format: float, description: index}
  2425. symbol: {type: string, description: symbol}
  2426. title: {type: string, description: title}
  2427. type: {type: string, description: type}
  2428. validation: {type: boolean, description: validation}
  2429. description: data
  2430. post:
  2431. summary: Add Columns
  2432. description: Add Columns
  2433. operationId: AddColumns
  2434. parameters:
  2435. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2436. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  2437. description: Content-Type}
  2438. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2439. description: Accept}
  2440. - name: body
  2441. in: body
  2442. schema:
  2443. type: object
  2444. properties:
  2445. title: {type: string, description: title}
  2446. type: {type: string, description: type}
  2447. formula: {type: string, description: formula}
  2448. hidden: {type: boolean, description: hidden}
  2449. index: {type: number, format: float, description: index}
  2450. autoNumberFormat:
  2451. type: object
  2452. properties:
  2453. fill: {type: string, description: fill}
  2454. prefix: {type: string, description: prefix}
  2455. startingNumber: {type: number, format: float, description: startingNumber}
  2456. suffix: {type: string, description: suffix}
  2457. description: autoNumberFormat
  2458. contactOptions:
  2459. type: object
  2460. properties:
  2461. email: {type: string, description: email}
  2462. name: {type: string, description: name}
  2463. description: contactOptions
  2464. description: {type: string, description: description}
  2465. format: {type: string, description: format}
  2466. locked: {type: boolean, description: locked}
  2467. lockedForUser: {type: boolean, description: lockedForUser}
  2468. options:
  2469. type: array
  2470. items: {type: string}
  2471. description: options
  2472. symbol: {type: string, description: symbol}
  2473. systemColumnType: {type: string, description: systemColumnType}
  2474. validation: {type: boolean, description: validation}
  2475. version: {type: number, format: float, description: version}
  2476. width: {type: number, format: float, description: width}
  2477. default:
  2478. title: aliquip aliqua nulla dolor eiusmod
  2479. type: MULTI_PICKLIST
  2480. formula: deserunt exercitation cillum
  2481. hidden: false
  2482. index: -24339889.160482734
  2483. autoNumberFormat: {fill: magna officia ullamco voluptate, prefix: esse,
  2484. startingNumber: 92760270.27099141, suffix: minim ea deseru}
  2485. contactOptions: {email: cillum elit dolore ad ex, name: sunt}
  2486. description: adipisicing esse mollit deserunt
  2487. format: veniam quis
  2488. locked: false
  2489. lockedForUser: true
  2490. options: [aute in, ut]
  2491. symbol: est veniam
  2492. systemColumnType: MODIFIED_BY
  2493. validation: false
  2494. version: -45163955.660274535
  2495. width: -74870217.18572184
  2496. required: true
  2497. responses:
  2498. '200':
  2499. description: '200'
  2500. schema:
  2501. type: object
  2502. properties:
  2503. message: {type: string, description: message}
  2504. resultCode: {type: integer, format: int32, description: resultCode}
  2505. result:
  2506. type: array
  2507. items:
  2508. type: object
  2509. properties:
  2510. id: {type: number, format: float, description: id}
  2511. index: {type: number, format: float, description: index}
  2512. title: {type: string, description: title}
  2513. type: {type: string, description: type}
  2514. options:
  2515. type: array
  2516. items: {type: string}
  2517. description: options
  2518. validation: {type: boolean, description: validation}
  2519. width: {type: number, format: float, description: width}
  2520. description: result
  2521. /sheets/{sheetId}/comments/{commentId}:
  2522. get:
  2523. summary: Get a comment
  2524. description: Get a comment
  2525. operationId: GetAComment
  2526. parameters:
  2527. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2528. - {name: commentId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2529. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2530. description: Accept}
  2531. responses:
  2532. '200':
  2533. description: '200'
  2534. schema:
  2535. type: object
  2536. properties:
  2537. value: {type: string, description: value}
  2538. delete:
  2539. summary: Delete a comment
  2540. description: Delete a comment
  2541. operationId: DeleteAComment
  2542. parameters:
  2543. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2544. - {name: commentId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2545. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2546. description: Accept}
  2547. responses:
  2548. '200':
  2549. description: '200'
  2550. schema:
  2551. type: object
  2552. properties:
  2553. message: {type: string, description: message}
  2554. resultCode: {type: integer, format: int32, description: resultCode}
  2555. put:
  2556. summary: Edit a comment
  2557. description: Edit a comment
  2558. operationId: EditAComment
  2559. parameters:
  2560. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2561. - {name: commentId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2562. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  2563. description: Content-Type}
  2564. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2565. description: Accept}
  2566. - name: body
  2567. in: body
  2568. schema:
  2569. type: object
  2570. properties:
  2571. text: {type: string, description: text}
  2572. default: {text: voluptate eu}
  2573. required: true
  2574. responses:
  2575. '200':
  2576. description: '200'
  2577. schema:
  2578. type: object
  2579. properties:
  2580. message: {type: string, description: message}
  2581. resultCode: {type: integer, format: int32, description: resultCode}
  2582. result:
  2583. type: object
  2584. properties:
  2585. value: {type: string, description: value}
  2586. description: result
  2587. /sheets/{sheetId}/comments/{commentId}/attachments:
  2588. post:
  2589. summary: Attach File or URL to Comment
  2590. description: Attach File or URL to Comment
  2591. operationId: AttachFileOrUrlToComment
  2592. parameters:
  2593. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2594. - {name: commentId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2595. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  2596. description: Content-Type}
  2597. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2598. description: Accept}
  2599. responses:
  2600. '200':
  2601. description: '200'
  2602. schema:
  2603. type: object
  2604. properties:
  2605. message: {type: string, description: message}
  2606. resultCode: {type: integer, format: int32, description: resultCode}
  2607. result:
  2608. type: object
  2609. properties:
  2610. id: {type: number, format: float, description: id}
  2611. parentId: {type: number, format: float, description: parentId}
  2612. attachmentType: {type: string, description: attachmentType}
  2613. attachmentSubType: {type: string, description: attachmentSubType}
  2614. mimeType: {type: string, description: mimeType}
  2615. parentType: {type: string, description: parentType}
  2616. createdAt:
  2617. type: object
  2618. properties:
  2619. value: {type: string, description: value}
  2620. description: createdAt
  2621. createdBy:
  2622. type: object
  2623. properties:
  2624. value: {type: string, description: value}
  2625. description: createdBy
  2626. name: {type: string, description: name}
  2627. sizeInKb: {type: number, format: float, description: sizeInKb}
  2628. url: {type: string, description: url}
  2629. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  2630. description: result
  2631. /sheets/{sheetId}/crosssheetreferences:
  2632. get:
  2633. summary: List Cross-sheet References
  2634. description: List Cross-sheet References
  2635. operationId: ListCross-sheetReferences
  2636. parameters:
  2637. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2638. - {name: page, default: '1', in: query, type: string, required: true}
  2639. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2640. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2641. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2642. description: Accept}
  2643. responses:
  2644. '200':
  2645. description: '200'
  2646. schema:
  2647. type: object
  2648. properties:
  2649. pageNumber: {type: integer, format: int32, description: pageNumber}
  2650. pageSize: {type: integer, format: int32, description: pageSize}
  2651. totalPages: {type: integer, format: int32, description: totalPages}
  2652. totalCount: {type: integer, format: int32, description: totalCount}
  2653. data:
  2654. type: array
  2655. items:
  2656. type: object
  2657. properties:
  2658. value: {type: string, description: value}
  2659. description: data
  2660. '500':
  2661. description: '500'
  2662. schema:
  2663. type: object
  2664. properties:
  2665. refId: {type: string, description: refId}
  2666. errorCode: {type: number, format: float, description: errorCode}
  2667. message: {type: string, description: message}
  2668. post:
  2669. summary: Create Cross-sheet References
  2670. description: Create Cross-sheet References
  2671. operationId: CreateCross-sheetReferences
  2672. parameters:
  2673. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2674. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  2675. description: Content-Type}
  2676. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2677. description: Accept}
  2678. - name: body
  2679. in: body
  2680. schema:
  2681. type: object
  2682. properties:
  2683. sourceSheetId: {type: number, format: float, description: sourceSheetId}
  2684. name: {type: string, description: name}
  2685. endColumnId: {type: number, format: float, description: endColumnId}
  2686. startColumnId: {type: number, format: float, description: startColumnId}
  2687. default: {sourceSheetId: 8472067.16221404, name: sunt nulla id ut, endColumnId: -62042327.84843988,
  2688. startColumnId: 91503084.44359049}
  2689. required: true
  2690. responses:
  2691. '200':
  2692. description: '200'
  2693. schema:
  2694. type: object
  2695. properties:
  2696. message: {type: string, description: message}
  2697. resultCode: {type: integer, format: int32, description: resultCode}
  2698. result:
  2699. type: object
  2700. properties:
  2701. value: {type: string, description: value}
  2702. description: result
  2703. '500':
  2704. description: '500'
  2705. schema:
  2706. type: object
  2707. properties:
  2708. refId: {type: string, description: refId}
  2709. errorCode: {type: number, format: float, description: errorCode}
  2710. message: {type: string, description: message}
  2711. /sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId}:
  2712. get:
  2713. summary: Get Cross-sheet Reference
  2714. description: Get Cross-sheet Reference
  2715. operationId: GetCross-sheetReference
  2716. parameters:
  2717. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2718. - {name: crossSheetReferenceId, default: '-4847524.674802229', in: path, type: string,
  2719. required: true}
  2720. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2721. description: Accept}
  2722. responses:
  2723. '200':
  2724. description: '200'
  2725. schema:
  2726. type: object
  2727. properties:
  2728. value: {type: string, description: value}
  2729. '500':
  2730. description: '500'
  2731. schema:
  2732. type: object
  2733. properties:
  2734. refId: {type: string, description: refId}
  2735. errorCode: {type: number, format: float, description: errorCode}
  2736. message: {type: string, description: message}
  2737. /sheets/{sheetId}/discussions/{discussionId}:
  2738. get:
  2739. summary: Get Discussion
  2740. description: Get Discussion
  2741. operationId: GetDiscussion
  2742. parameters:
  2743. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2744. - {name: discussionId, default: ex Excepteur laboris, in: path, type: string,
  2745. required: true}
  2746. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2747. description: Accept}
  2748. responses:
  2749. '200':
  2750. description: '200'
  2751. schema:
  2752. type: object
  2753. properties:
  2754. value: {type: string, description: value}
  2755. delete:
  2756. summary: Delete a Discussion
  2757. description: Delete a Discussion
  2758. operationId: DeleteADiscussion
  2759. parameters:
  2760. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2761. - {name: discussionId, default: ex Excepteur laboris, in: path, type: string,
  2762. required: true}
  2763. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2764. description: Accept}
  2765. responses:
  2766. '200':
  2767. description: '200'
  2768. schema:
  2769. type: object
  2770. properties:
  2771. message: {type: string, description: message}
  2772. resultCode: {type: integer, format: int32, description: resultCode}
  2773. /sheets/{sheetId}/discussions/{discussionId}/attachments:
  2774. get:
  2775. summary: List Discussion Attachments
  2776. description: List Discussion Attachments
  2777. operationId: ListDiscussionAttachments
  2778. parameters:
  2779. - {name: page, default: '1', in: query, type: string, required: true}
  2780. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2781. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2782. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2783. - {name: discussionId, default: ex Excepteur laboris, in: path, type: string,
  2784. required: true}
  2785. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2786. description: Accept}
  2787. responses:
  2788. '200':
  2789. description: '200'
  2790. schema:
  2791. type: object
  2792. properties:
  2793. pageNumber: {type: integer, format: int32, description: pageNumber}
  2794. pageSize: {type: integer, format: int32, description: pageSize}
  2795. totalPages: {type: integer, format: int32, description: totalPages}
  2796. totalCount: {type: integer, format: int32, description: totalCount}
  2797. data:
  2798. type: array
  2799. items:
  2800. type: object
  2801. properties:
  2802. id: {type: number, format: float, description: id}
  2803. parentId: {type: number, format: float, description: parentId}
  2804. attachmentType: {type: string, description: attachmentType}
  2805. attachmentSubType: {type: string, description: attachmentSubType}
  2806. mimeType: {type: string, description: mimeType}
  2807. parentType: {type: string, description: parentType}
  2808. createdAt:
  2809. type: object
  2810. properties:
  2811. value: {type: string, description: value}
  2812. description: createdAt
  2813. createdBy:
  2814. type: object
  2815. properties:
  2816. value: {type: string, description: value}
  2817. description: createdBy
  2818. name: {type: string, description: name}
  2819. sizeInKb: {type: number, format: float, description: sizeInKb}
  2820. url: {type: string, description: url}
  2821. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  2822. description: data
  2823. /sheets/{sheetId}/discussions/{discussionId}/comments:
  2824. post:
  2825. summary: Create a comment
  2826. description: Create a comment
  2827. operationId: CreateAComment
  2828. parameters:
  2829. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2830. - {name: discussionId, default: ex Excepteur laboris, in: path, type: string,
  2831. required: true}
  2832. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  2833. description: Content-Type}
  2834. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2835. description: Accept}
  2836. responses:
  2837. '200':
  2838. description: '200'
  2839. schema:
  2840. type: object
  2841. properties:
  2842. message: {type: string, description: message}
  2843. resultCode: {type: integer, format: int32, description: resultCode}
  2844. result:
  2845. type: object
  2846. properties:
  2847. value: {type: string, description: value}
  2848. description: result
  2849. /sheets/{sheetId}/discussions:
  2850. get:
  2851. summary: List Discussions
  2852. description: List Discussions
  2853. operationId: ListDiscussions
  2854. parameters:
  2855. - {name: include, default: comments, in: query, type: string, required: true}
  2856. - {name: page, default: '1', in: query, type: string, required: true}
  2857. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2858. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2859. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2860. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2861. description: Accept}
  2862. responses:
  2863. '200':
  2864. description: '200'
  2865. schema:
  2866. type: object
  2867. properties:
  2868. pageNumber: {type: integer, format: int32, description: pageNumber}
  2869. pageSize: {type: integer, format: int32, description: pageSize}
  2870. totalPages: {type: integer, format: int32, description: totalPages}
  2871. totalCount: {type: integer, format: int32, description: totalCount}
  2872. data:
  2873. type: array
  2874. items:
  2875. type: object
  2876. properties:
  2877. value: {type: string, description: value}
  2878. description: data
  2879. post:
  2880. summary: Create a Discussion
  2881. description: Create a Discussion
  2882. operationId: CreateADiscussion
  2883. parameters:
  2884. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2885. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  2886. description: Content-Type}
  2887. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2888. description: Accept}
  2889. responses:
  2890. '200':
  2891. description: '200'
  2892. schema:
  2893. type: object
  2894. properties:
  2895. message: {type: string, description: message}
  2896. resultCode: {type: integer, format: int32, description: resultCode}
  2897. result:
  2898. type: object
  2899. properties:
  2900. value: {type: string, description: value}
  2901. description: result
  2902. /sheets/{sheetId}/proofs/{proofId}/attachments:
  2903. get:
  2904. summary: List Proof Attachments
  2905. description: List Proof Attachments
  2906. operationId: ListProofAttachments
  2907. parameters:
  2908. - {name: page, default: '1', in: query, type: string, required: true}
  2909. - {name: pageSize, default: '100', in: query, type: string, required: true}
  2910. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  2911. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2912. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2913. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2914. description: Accept}
  2915. responses:
  2916. '200':
  2917. description: '200'
  2918. schema:
  2919. type: object
  2920. properties:
  2921. pageNumber: {type: integer, format: int32, description: pageNumber}
  2922. pageSize: {type: integer, format: int32, description: pageSize}
  2923. totalPages: {type: integer, format: int32, description: totalPages}
  2924. totalCount: {type: integer, format: int32, description: totalCount}
  2925. data:
  2926. type: array
  2927. items:
  2928. type: object
  2929. properties:
  2930. id: {type: number, format: float, description: id}
  2931. parentId: {type: number, format: float, description: parentId}
  2932. attachmentType: {type: string, description: attachmentType}
  2933. attachmentSubType: {type: string, description: attachmentSubType}
  2934. mimeType: {type: string, description: mimeType}
  2935. parentType: {type: string, description: parentType}
  2936. createdAt:
  2937. type: object
  2938. properties:
  2939. value: {type: string, description: value}
  2940. description: createdAt
  2941. createdBy:
  2942. type: object
  2943. properties:
  2944. value: {type: string, description: value}
  2945. description: createdBy
  2946. name: {type: string, description: name}
  2947. sizeInKb: {type: number, format: float, description: sizeInKb}
  2948. url: {type: string, description: url}
  2949. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  2950. description: data
  2951. post:
  2952. summary: Attach File to Proof
  2953. description: Attach File to Proof
  2954. operationId: AttachFileToProof
  2955. parameters:
  2956. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  2957. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  2958. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  2959. description: Content-Type}
  2960. - {name: Accept, in: header, required: true, type: string, default: application/json,
  2961. description: Accept}
  2962. responses:
  2963. '200':
  2964. description: '200'
  2965. schema:
  2966. type: object
  2967. properties:
  2968. message: {type: string, description: message}
  2969. resultCode: {type: integer, format: int32, description: resultCode}
  2970. result:
  2971. type: object
  2972. properties:
  2973. id: {type: number, format: float, description: id}
  2974. parentId: {type: number, format: float, description: parentId}
  2975. attachmentType: {type: string, description: attachmentType}
  2976. attachmentSubType: {type: string, description: attachmentSubType}
  2977. mimeType: {type: string, description: mimeType}
  2978. parentType: {type: string, description: parentType}
  2979. createdAt:
  2980. type: object
  2981. properties:
  2982. value: {type: string, description: value}
  2983. description: createdAt
  2984. createdBy:
  2985. type: object
  2986. properties:
  2987. value: {type: string, description: value}
  2988. description: createdBy
  2989. name: {type: string, description: name}
  2990. sizeInKb: {type: number, format: float, description: sizeInKb}
  2991. url: {type: string, description: url}
  2992. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  2993. description: result
  2994. /sheets/{sheetId}/proofs/{proofId}/discussions:
  2995. get:
  2996. summary: List Proof Discussions
  2997. description: List Proof Discussions
  2998. operationId: ListProofDiscussions
  2999. parameters:
  3000. - {name: include, default: comments, in: query, type: string, required: true}
  3001. - {name: page, default: '1', in: query, type: string, required: true}
  3002. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3003. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3004. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3005. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3006. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3007. description: Accept}
  3008. responses:
  3009. '200':
  3010. description: '200'
  3011. schema:
  3012. type: object
  3013. properties:
  3014. pageNumber: {type: integer, format: int32, description: pageNumber}
  3015. pageSize: {type: integer, format: int32, description: pageSize}
  3016. totalPages: {type: integer, format: int32, description: totalPages}
  3017. totalCount: {type: integer, format: int32, description: totalCount}
  3018. data:
  3019. type: array
  3020. items:
  3021. type: object
  3022. properties:
  3023. value: {type: string, description: value}
  3024. description: data
  3025. post:
  3026. summary: Create Proof Discussion
  3027. description: Create Proof Discussion
  3028. operationId: CreateProofDiscussion
  3029. parameters:
  3030. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3031. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3032. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  3033. description: Content-Type}
  3034. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3035. description: Accept}
  3036. responses:
  3037. '200':
  3038. description: '200'
  3039. schema:
  3040. type: object
  3041. properties:
  3042. message: {type: string, description: message}
  3043. resultCode: {type: integer, format: int32, description: resultCode}
  3044. result:
  3045. type: object
  3046. properties:
  3047. value: {type: string, description: value}
  3048. description: result
  3049. /sheets/{sheetId}/proofs/{proofId}/requests:
  3050. delete:
  3051. summary: Delete Proof Requests
  3052. description: Delete Proof Requests
  3053. operationId: DeleteProofRequests
  3054. parameters:
  3055. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3056. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3057. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3058. description: Accept}
  3059. responses:
  3060. '200':
  3061. description: '200'
  3062. schema:
  3063. type: object
  3064. properties:
  3065. message: {type: string, description: message}
  3066. resultCode: {type: integer, format: int32, description: resultCode}
  3067. post:
  3068. summary: Create Proof Request
  3069. description: Create Proof Request
  3070. operationId: CreateProofRequest
  3071. parameters:
  3072. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3073. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3074. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3075. description: Content-Type}
  3076. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3077. description: Accept}
  3078. - name: body
  3079. in: body
  3080. schema:
  3081. type: object
  3082. properties:
  3083. value: {type: string, description: value}
  3084. default: {value: 'reference #/components/schemas/ProofRequest/allOf/0 not
  3085. found in the OpenAPI spec'}
  3086. required: true
  3087. responses:
  3088. '200':
  3089. description: '200'
  3090. schema:
  3091. type: object
  3092. properties:
  3093. message: {type: string, description: message}
  3094. resultCode: {type: integer, format: int32, description: resultCode}
  3095. result:
  3096. type: object
  3097. properties:
  3098. value: {type: string, description: value}
  3099. description: result
  3100. /sheets/{sheetId}/proofs/{proofId}/versions:
  3101. get:
  3102. summary: List Proof Versions
  3103. description: List Proof Versions
  3104. operationId: ListProofVersions
  3105. parameters:
  3106. - {name: page, default: '1', in: query, type: string, required: true}
  3107. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3108. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3109. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3110. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3111. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3112. description: Accept}
  3113. responses:
  3114. '200':
  3115. description: '200'
  3116. schema:
  3117. type: object
  3118. properties:
  3119. pageNumber: {type: integer, format: int32, description: pageNumber}
  3120. pageSize: {type: integer, format: int32, description: pageSize}
  3121. totalPages: {type: integer, format: int32, description: totalPages}
  3122. totalCount: {type: integer, format: int32, description: totalCount}
  3123. data:
  3124. type: array
  3125. items:
  3126. type: object
  3127. properties:
  3128. value: {type: string, description: value}
  3129. description: data
  3130. delete:
  3131. summary: Delete Proof Version
  3132. description: Delete Proof Version
  3133. operationId: DeleteProofVersion
  3134. parameters:
  3135. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3136. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3137. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3138. description: Accept}
  3139. responses:
  3140. '200':
  3141. description: '200'
  3142. schema:
  3143. type: object
  3144. properties:
  3145. message: {type: string, description: message}
  3146. resultCode: {type: integer, format: int32, description: resultCode}
  3147. post:
  3148. summary: Create Proof Version
  3149. description: Create Proof Version
  3150. operationId: CreateProofVersion
  3151. parameters:
  3152. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3153. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3154. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  3155. description: Content-Type}
  3156. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3157. description: Accept}
  3158. responses:
  3159. '200':
  3160. description: '200'
  3161. schema:
  3162. type: object
  3163. properties:
  3164. message: {type: string, description: message}
  3165. resultCode: {type: integer, format: int32, description: resultCode}
  3166. result:
  3167. type: object
  3168. properties:
  3169. value: {type: string, description: value}
  3170. description: result
  3171. /sheets/{sheetId}/proofs/{proofId}:
  3172. get:
  3173. summary: Get Proof
  3174. description: Get Proof
  3175. operationId: GetProof
  3176. parameters:
  3177. - {name: include, default: discussions, in: query, type: string, required: true}
  3178. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3179. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3180. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3181. description: Accept}
  3182. responses:
  3183. '200':
  3184. description: '200'
  3185. schema:
  3186. type: object
  3187. properties:
  3188. value: {type: string, description: value}
  3189. delete:
  3190. summary: Delete Proof
  3191. description: Delete Proof
  3192. operationId: DeleteProof
  3193. parameters:
  3194. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3195. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3196. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3197. description: Accept}
  3198. responses:
  3199. '200':
  3200. description: '200'
  3201. schema:
  3202. type: object
  3203. properties:
  3204. message: {type: string, description: message}
  3205. resultCode: {type: integer, format: int32, description: resultCode}
  3206. put:
  3207. summary: Update Proof Status
  3208. description: Update Proof Status
  3209. operationId: UpdateProofStatus
  3210. parameters:
  3211. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3212. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3213. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3214. description: Content-Type}
  3215. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3216. description: Accept}
  3217. - name: body
  3218. in: body
  3219. schema:
  3220. type: object
  3221. properties:
  3222. isCompleted: {type: boolean, description: isCompleted}
  3223. default: {isCompleted: false}
  3224. required: true
  3225. responses:
  3226. '200':
  3227. description: '200'
  3228. schema:
  3229. type: object
  3230. properties:
  3231. value: {type: string, description: value}
  3232. /sheets/{sheetId}/proofs/{proofId}/requestactions:
  3233. get:
  3234. summary: List Proof Request Actions
  3235. description: List Proof Request Actions
  3236. operationId: ListProofRequestActions
  3237. parameters:
  3238. - {name: page, default: '1', in: query, type: string, required: true}
  3239. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3240. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3241. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3242. - {name: proofId, default: ex Excepteur laboris, in: path, type: string, required: true}
  3243. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3244. description: Accept}
  3245. responses:
  3246. '200':
  3247. description: '200'
  3248. schema:
  3249. type: object
  3250. properties:
  3251. pageNumber: {type: integer, format: int32, description: pageNumber}
  3252. pageSize: {type: integer, format: int32, description: pageSize}
  3253. totalPages: {type: integer, format: int32, description: totalPages}
  3254. totalCount: {type: integer, format: int32, description: totalCount}
  3255. data:
  3256. type: array
  3257. items:
  3258. type: object
  3259. properties:
  3260. user:
  3261. type: object
  3262. properties:
  3263. value: {type: string, description: value}
  3264. description: user
  3265. actionStatus: {type: string, description: actionStatus}
  3266. description: data
  3267. /sheets/{sheetId}/proofs:
  3268. get:
  3269. summary: List Proofs
  3270. description: List Proofs
  3271. operationId: ListProofs
  3272. parameters:
  3273. - {name: page, default: '1', in: query, type: string, required: true}
  3274. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3275. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3276. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3277. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3278. description: Accept}
  3279. responses:
  3280. '200':
  3281. description: '200'
  3282. schema:
  3283. type: object
  3284. properties:
  3285. pageNumber: {type: integer, format: int32, description: pageNumber}
  3286. pageSize: {type: integer, format: int32, description: pageSize}
  3287. totalPages: {type: integer, format: int32, description: totalPages}
  3288. totalCount: {type: integer, format: int32, description: totalCount}
  3289. data:
  3290. type: array
  3291. items:
  3292. type: object
  3293. properties:
  3294. value: {type: string, description: value}
  3295. description: data
  3296. /sheets/{sheetId}/publish:
  3297. get:
  3298. summary: Get Sheet Publish Status
  3299. description: Get Sheet Publish Status
  3300. operationId: GetSheetPublishStatus
  3301. parameters:
  3302. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3303. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3304. description: Accept}
  3305. responses:
  3306. '200':
  3307. description: '200'
  3308. schema:
  3309. type: object
  3310. properties:
  3311. icalEnabled: {type: boolean, description: icalEnabled}
  3312. icalUrl:
  3313. type: object
  3314. properties: {}
  3315. description: icalUrl
  3316. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  3317. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  3318. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  3319. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  3320. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  3321. readOnlyLiteEnabled: {type: boolean, description: readOnlyLiteEnabled}
  3322. readOnlyLiteSslUrl: {type: string, description: readOnlyLiteSslUrl}
  3323. readOnlyLiteUrl: {type: string, description: readOnlyLiteUrl}
  3324. readWriteAccessibleBy: {type: string, description: readWriteAccessibleBy}
  3325. readWriteDefaultView: {type: string, description: readWriteDefaultView}
  3326. readWriteEnabled: {type: boolean, description: readWriteEnabled}
  3327. readWriteShowToolbar: {type: boolean, description: readWriteShowToolbar}
  3328. readWriteUrl: {type: string, description: readWriteUrl}
  3329. '500':
  3330. description: '500'
  3331. schema:
  3332. type: object
  3333. properties:
  3334. refId: {type: string, description: refId}
  3335. errorCode: {type: number, format: float, description: errorCode}
  3336. message: {type: string, description: message}
  3337. put:
  3338. summary: Set Sheet Publish Status
  3339. description: Set Sheet Publish Status
  3340. operationId: SetSheetPublishStatus
  3341. parameters:
  3342. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3343. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3344. description: Content-Type}
  3345. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3346. description: Accept}
  3347. - name: body
  3348. in: body
  3349. schema:
  3350. type: object
  3351. properties:
  3352. icalEnabled: {type: boolean, description: icalEnabled}
  3353. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  3354. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  3355. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  3356. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  3357. readOnlyLiteEnabled: {type: boolean, description: readOnlyLiteEnabled}
  3358. readWriteAccessibleBy: {type: string, description: readWriteAccessibleBy}
  3359. readWriteDefaultView: {type: string, description: readWriteDefaultView}
  3360. readWriteEnabled: {type: boolean, description: readWriteEnabled}
  3361. readWriteShowToolbar: {type: boolean, description: readWriteShowToolbar}
  3362. default: {icalEnabled: true, readOnlyFullAccessibleBy: SHARED, readOnlyFullDefaultView: GRID,
  3363. readOnlyFullEnabled: false, readOnlyFullShowToolbar: false, readOnlyLiteEnabled: true,
  3364. readWriteAccessibleBy: ORG, readWriteDefaultView: CARD, readWriteEnabled: false,
  3365. readWriteShowToolbar: true}
  3366. required: true
  3367. responses:
  3368. '200':
  3369. description: '200'
  3370. schema:
  3371. type: object
  3372. properties:
  3373. message: {type: string, description: message}
  3374. resultCode: {type: integer, format: int32, description: resultCode}
  3375. result:
  3376. type: object
  3377. properties:
  3378. icalEnabled: {type: boolean, description: icalEnabled}
  3379. icalUrl:
  3380. type: object
  3381. properties: {}
  3382. description: icalUrl
  3383. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  3384. readOnlyFullDefaultView: {type: string, description: readOnlyFullDefaultView}
  3385. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  3386. readOnlyFullShowToolbar: {type: boolean, description: readOnlyFullShowToolbar}
  3387. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  3388. readOnlyLiteEnabled: {type: boolean, description: readOnlyLiteEnabled}
  3389. readOnlyLiteSslUrl: {type: string, description: readOnlyLiteSslUrl}
  3390. readOnlyLiteUrl: {type: string, description: readOnlyLiteUrl}
  3391. readWriteAccessibleBy: {type: string, description: readWriteAccessibleBy}
  3392. readWriteDefaultView: {type: string, description: readWriteDefaultView}
  3393. readWriteEnabled: {type: boolean, description: readWriteEnabled}
  3394. readWriteShowToolbar: {type: boolean, description: readWriteShowToolbar}
  3395. readWriteUrl: {type: string, description: readWriteUrl}
  3396. description: result
  3397. '500':
  3398. description: '500'
  3399. schema:
  3400. type: object
  3401. properties:
  3402. refId: {type: string, description: refId}
  3403. errorCode: {type: number, format: float, description: errorCode}
  3404. message: {type: string, description: message}
  3405. /sheets/{sheetId}/rows/{rowId}/attachments:
  3406. get:
  3407. summary: List Row Attachments
  3408. description: List Row Attachments
  3409. operationId: ListRowAttachments
  3410. parameters:
  3411. - {name: page, default: '1', in: query, type: string, required: true}
  3412. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3413. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3414. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3415. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3416. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3417. description: Accept}
  3418. responses:
  3419. '200':
  3420. description: '200'
  3421. schema:
  3422. type: object
  3423. properties:
  3424. pageNumber: {type: integer, format: int32, description: pageNumber}
  3425. pageSize: {type: integer, format: int32, description: pageSize}
  3426. totalPages: {type: integer, format: int32, description: totalPages}
  3427. totalCount: {type: integer, format: int32, description: totalCount}
  3428. data:
  3429. type: array
  3430. items:
  3431. type: object
  3432. properties:
  3433. id: {type: number, format: float, description: id}
  3434. parentId: {type: number, format: float, description: parentId}
  3435. attachmentType: {type: string, description: attachmentType}
  3436. attachmentSubType: {type: string, description: attachmentSubType}
  3437. mimeType: {type: string, description: mimeType}
  3438. parentType: {type: string, description: parentType}
  3439. createdAt:
  3440. type: object
  3441. properties:
  3442. value: {type: string, description: value}
  3443. description: createdAt
  3444. createdBy:
  3445. type: object
  3446. properties:
  3447. value: {type: string, description: value}
  3448. description: createdBy
  3449. name: {type: string, description: name}
  3450. sizeInKb: {type: number, format: float, description: sizeInKb}
  3451. url: {type: string, description: url}
  3452. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  3453. description: data
  3454. post:
  3455. summary: Attach File or URL to Row
  3456. description: Attach File or URL to Row
  3457. operationId: AttachFileOrUrlToRow
  3458. parameters:
  3459. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3460. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3461. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  3462. description: Content-Type}
  3463. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3464. description: Accept}
  3465. responses:
  3466. '200':
  3467. description: '200'
  3468. schema:
  3469. type: object
  3470. properties:
  3471. message: {type: string, description: message}
  3472. resultCode: {type: integer, format: int32, description: resultCode}
  3473. result:
  3474. type: object
  3475. properties:
  3476. id: {type: number, format: float, description: id}
  3477. parentId: {type: number, format: float, description: parentId}
  3478. attachmentType: {type: string, description: attachmentType}
  3479. attachmentSubType: {type: string, description: attachmentSubType}
  3480. mimeType: {type: string, description: mimeType}
  3481. parentType: {type: string, description: parentType}
  3482. createdAt:
  3483. type: object
  3484. properties:
  3485. value: {type: string, description: value}
  3486. description: createdAt
  3487. createdBy:
  3488. type: object
  3489. properties:
  3490. value: {type: string, description: value}
  3491. description: createdBy
  3492. name: {type: string, description: name}
  3493. sizeInKb: {type: number, format: float, description: sizeInKb}
  3494. url: {type: string, description: url}
  3495. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  3496. description: result
  3497. /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/cellimages:
  3498. post:
  3499. summary: Add Image to Cell
  3500. description: Add Image to Cell
  3501. operationId: AddImageToCell
  3502. parameters:
  3503. - {name: altText, default: ex Excepteur laboris, in: query, type: string, required: true}
  3504. - {name: overrideValidation, default: 'false', in: query, type: string, required: true}
  3505. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3506. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3507. - {name: columnId, default: '-4847524.674802229', in: path, type: string, required: true}
  3508. - {name: Content-Disposition, in: header, required: true, type: string, default: attachment;
  3509. filename="ProgressReport.docx", description: Content-Disposition}
  3510. - {name: Content-Length, in: header, required: true, type: string, default: '5463',
  3511. description: Content-Length}
  3512. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  3513. description: Content-Type}
  3514. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3515. description: Accept}
  3516. responses:
  3517. '200':
  3518. description: '200'
  3519. schema:
  3520. type: object
  3521. properties:
  3522. message: {type: string, description: message}
  3523. resultCode: {type: integer, format: int32, description: resultCode}
  3524. result:
  3525. type: object
  3526. properties:
  3527. value: {type: string, description: value}
  3528. description: result
  3529. /sheets/{sheetId}/rows/{rowId}/columns/{columnId}/history:
  3530. get:
  3531. summary: List Cell History
  3532. description: List Cell History
  3533. operationId: ListCellHistory
  3534. parameters:
  3535. - {name: include, default: objectValue, in: query, type: string, required: true}
  3536. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3537. - {name: page, default: '1', in: query, type: string, required: true}
  3538. - {name: level, default: '1', in: query, type: string, required: true}
  3539. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3540. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3541. - {name: columnId, default: '-4847524.674802229', in: path, type: string, required: true}
  3542. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3543. description: Accept}
  3544. responses:
  3545. '200':
  3546. description: '200'
  3547. schema:
  3548. type: object
  3549. properties:
  3550. pageNumber: {type: integer, format: int32, description: pageNumber}
  3551. pageSize: {type: integer, format: int32, description: pageSize}
  3552. totalPages: {type: integer, format: int32, description: totalPages}
  3553. totalCount: {type: integer, format: int32, description: totalCount}
  3554. data:
  3555. type: array
  3556. items:
  3557. type: object
  3558. properties:
  3559. columnId:
  3560. type: object
  3561. properties:
  3562. value: {type: string, description: value}
  3563. description: columnId
  3564. columnType:
  3565. type: object
  3566. properties:
  3567. value: {type: string, description: value}
  3568. description: columnType
  3569. conditionalFormat:
  3570. type: object
  3571. properties:
  3572. value: {type: string, description: value}
  3573. description: conditionalFormat
  3574. displayValue:
  3575. type: object
  3576. properties:
  3577. value: {type: string, description: value}
  3578. description: displayValue
  3579. format:
  3580. type: object
  3581. properties:
  3582. value: {type: string, description: value}
  3583. description: format
  3584. formula:
  3585. type: object
  3586. properties:
  3587. value: {type: string, description: value}
  3588. description: formula
  3589. hyperlink:
  3590. type: object
  3591. properties:
  3592. value: {type: string, description: value}
  3593. description: hyperlink
  3594. image:
  3595. type: object
  3596. properties:
  3597. value: {type: string, description: value}
  3598. description: image
  3599. linkInFromCell:
  3600. type: object
  3601. properties:
  3602. value: {type: string, description: value}
  3603. description: linkInFromCell
  3604. linksOutToCells:
  3605. type: object
  3606. properties:
  3607. value: {type: string, description: value}
  3608. description: linksOutToCells
  3609. objectValue:
  3610. type: object
  3611. properties:
  3612. value: {type: string, description: value}
  3613. description: objectValue
  3614. overrideValidation:
  3615. type: object
  3616. properties:
  3617. value: {type: string, description: value}
  3618. description: overrideValidation
  3619. strict:
  3620. type: object
  3621. properties:
  3622. value: {type: string, description: value}
  3623. description: strict
  3624. value:
  3625. type: object
  3626. properties:
  3627. value: {type: string, description: value}
  3628. description: value
  3629. description: data
  3630. '500':
  3631. description: '500'
  3632. schema:
  3633. type: object
  3634. properties:
  3635. refId: {type: string, description: refId}
  3636. errorCode: {type: number, format: float, description: errorCode}
  3637. message: {type: string, description: message}
  3638. /sheets/{sheetId}/rows/{rowId}/discussions:
  3639. get:
  3640. summary: List Discussions with a Row
  3641. description: List Discussions with a Row
  3642. operationId: ListDiscussionsWithARow
  3643. parameters:
  3644. - {name: include, default: comments, in: query, type: string, required: true}
  3645. - {name: page, default: '1', in: query, type: string, required: true}
  3646. - {name: pageSize, default: '100', in: query, type: string, required: true}
  3647. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  3648. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3649. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3650. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3651. description: Accept}
  3652. responses:
  3653. '200':
  3654. description: '200'
  3655. schema:
  3656. type: object
  3657. properties:
  3658. pageNumber: {type: integer, format: int32, description: pageNumber}
  3659. pageSize: {type: integer, format: int32, description: pageSize}
  3660. totalPages: {type: integer, format: int32, description: totalPages}
  3661. totalCount: {type: integer, format: int32, description: totalCount}
  3662. data:
  3663. type: array
  3664. items:
  3665. type: object
  3666. properties:
  3667. value: {type: string, description: value}
  3668. description: data
  3669. post:
  3670. summary: Create a Discussion on a Row
  3671. description: Create a Discussion on a Row
  3672. operationId: CreateADiscussionOnARow
  3673. parameters:
  3674. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3675. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3676. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  3677. description: Content-Type}
  3678. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3679. description: Accept}
  3680. responses:
  3681. '200':
  3682. description: '200'
  3683. schema:
  3684. type: object
  3685. properties:
  3686. message: {type: string, description: message}
  3687. resultCode: {type: integer, format: int32, description: resultCode}
  3688. result:
  3689. type: object
  3690. properties:
  3691. value: {type: string, description: value}
  3692. description: result
  3693. /sheets/{sheetId}/rows/{rowId}:
  3694. get:
  3695. summary: Get Row
  3696. description: Get Row
  3697. operationId: GetRow
  3698. parameters:
  3699. - {name: include, default: columns, in: query, type: string, required: true}
  3700. - {name: exclude, default: filteredOutRows, in: query, type: string, required: true}
  3701. - {name: level, default: '1', in: query, type: string, required: true}
  3702. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3703. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3704. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3705. description: Accept}
  3706. responses:
  3707. '200':
  3708. description: '200'
  3709. schema:
  3710. type: object
  3711. properties:
  3712. id: {type: number, format: float, description: id}
  3713. sheetId: {type: number, format: float, description: sheetId}
  3714. rowNumber: {type: number, format: float, description: rowNumber}
  3715. expanded: {type: boolean, description: expanded}
  3716. cells:
  3717. type: array
  3718. items:
  3719. type: object
  3720. properties:
  3721. columnId: {type: number, format: float, description: columnId}
  3722. columnType: {type: string, description: columnType}
  3723. value:
  3724. type: object
  3725. properties:
  3726. value: {type: string, description: value}
  3727. description: value
  3728. displayValue: {type: string, description: displayValue}
  3729. description: cells
  3730. createdAt: {type: string, description: createdAt}
  3731. modifiedAt: {type: string, description: modifiedAt}
  3732. /sheets/{sheetId}/rows/{rowId}/proofs:
  3733. post:
  3734. summary: Create Proof
  3735. description: Create Proof
  3736. operationId: CreateProof
  3737. parameters:
  3738. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3739. - {name: rowId, default: '-4847524.674802229', in: path, type: string, required: true}
  3740. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  3741. description: Content-Type}
  3742. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3743. description: Accept}
  3744. responses:
  3745. '200':
  3746. description: '200'
  3747. schema:
  3748. type: object
  3749. properties:
  3750. message: {type: string, description: message}
  3751. resultCode: {type: integer, format: int32, description: resultCode}
  3752. result:
  3753. type: object
  3754. properties:
  3755. value: {type: string, description: value}
  3756. description: result
  3757. /sheets/{sheetId}/rows:
  3758. delete:
  3759. summary: Delete Rows
  3760. description: Delete Rows
  3761. operationId: DeleteRows
  3762. parameters:
  3763. - {name: ids, default: ex Excepteur laboris, in: query, type: string, required: true}
  3764. - {name: ignoreRowsNotFound, default: 'false', in: query, type: string, required: true}
  3765. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3766. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3767. description: Accept}
  3768. responses:
  3769. '200':
  3770. description: '200'
  3771. schema:
  3772. type: object
  3773. properties:
  3774. message: {type: string, description: message}
  3775. resultCode: {type: integer, format: int32, description: resultCode}
  3776. result:
  3777. type: array
  3778. items: {type: number, format: float}
  3779. description: result
  3780. '404':
  3781. description: '404'
  3782. schema:
  3783. type: object
  3784. properties:
  3785. errorCode: {type: integer, format: int32, description: errorCode}
  3786. message: {type: string, description: message}
  3787. refId: {type: string, description: refId}
  3788. post:
  3789. summary: Add Rows
  3790. description: Add Rows
  3791. operationId: AddRows
  3792. parameters:
  3793. - {name: allowPartialSuccess, default: 'false', in: query, type: string, required: true}
  3794. - {name: overrideValidation, default: 'false', in: query, type: string, required: true}
  3795. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3796. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3797. description: Content-Type}
  3798. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3799. description: Accept}
  3800. - name: body
  3801. in: body
  3802. schema:
  3803. type: object
  3804. properties:
  3805. value: {type: string, description: value}
  3806. default: {value: 'reference #/components/schemas/ReportRow/allOf/0 not found
  3807. in the OpenAPI spec'}
  3808. required: true
  3809. responses:
  3810. '200':
  3811. description: '200'
  3812. schema:
  3813. type: object
  3814. properties:
  3815. message: {type: string, description: message}
  3816. resultCode: {type: integer, format: int32, description: resultCode}
  3817. result:
  3818. type: array
  3819. items:
  3820. type: object
  3821. properties:
  3822. id: {type: number, format: float, description: id}
  3823. sheetId: {type: number, format: float, description: sheetId}
  3824. rowNumber: {type: number, format: float, description: rowNumber}
  3825. expanded: {type: boolean, description: expanded}
  3826. createdAt:
  3827. type: object
  3828. properties:
  3829. value: {type: string, description: value}
  3830. description: createdAt
  3831. modifiedAt:
  3832. type: object
  3833. properties:
  3834. value: {type: string, description: value}
  3835. description: modifiedAt
  3836. cells:
  3837. type: array
  3838. items:
  3839. type: object
  3840. properties:
  3841. columnId:
  3842. type: object
  3843. properties:
  3844. value: {type: string, description: value}
  3845. description: columnId
  3846. columnType:
  3847. type: object
  3848. properties:
  3849. value: {type: string, description: value}
  3850. description: columnType
  3851. value:
  3852. type: object
  3853. properties:
  3854. value: {type: string, description: value}
  3855. description: value
  3856. displayValue:
  3857. type: object
  3858. properties:
  3859. value: {type: string, description: value}
  3860. description: displayValue
  3861. description: cells
  3862. version: {type: number, format: float, description: version}
  3863. description: result
  3864. '500':
  3865. description: '500'
  3866. schema:
  3867. type: object
  3868. properties:
  3869. refId: {type: string, description: refId}
  3870. errorCode: {type: number, format: float, description: errorCode}
  3871. message: {type: string, description: message}
  3872. put:
  3873. summary: Update Rows
  3874. description: Update Rows
  3875. operationId: UpdateRows
  3876. parameters:
  3877. - {name: allowPartialSuccess, default: 'false', in: query, type: string, required: true}
  3878. - {name: overrideValidation, default: 'false', in: query, type: string, required: true}
  3879. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3880. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3881. description: Content-Type}
  3882. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3883. description: Accept}
  3884. - name: body
  3885. in: body
  3886. schema:
  3887. type: object
  3888. properties:
  3889. value: {type: string, description: value}
  3890. default: {value: 'reference #/components/schemas/ReportRow/allOf/0 not found
  3891. in the OpenAPI spec'}
  3892. required: true
  3893. responses:
  3894. '200':
  3895. description: '200'
  3896. schema:
  3897. type: object
  3898. properties:
  3899. message: {type: string, description: message}
  3900. resultCode: {type: integer, format: int32, description: resultCode}
  3901. result:
  3902. type: array
  3903. items:
  3904. type: object
  3905. properties:
  3906. id: {type: number, format: float, description: id}
  3907. rowNumber: {type: number, format: float, description: rowNumber}
  3908. parentRowNumber: {type: number, format: float, description: parentRowNumber}
  3909. parentId: {type: number, format: float, description: parentId}
  3910. expanded: {type: boolean, description: expanded}
  3911. createdAt:
  3912. type: object
  3913. properties:
  3914. value: {type: string, description: value}
  3915. description: createdAt
  3916. modifiedAt:
  3917. type: object
  3918. properties:
  3919. value: {type: string, description: value}
  3920. description: modifiedAt
  3921. cells:
  3922. type: array
  3923. items:
  3924. type: object
  3925. properties:
  3926. value: {type: string, description: value}
  3927. description: cells
  3928. version: {type: number, format: float, description: version}
  3929. description: result
  3930. '500':
  3931. description: '500'
  3932. schema:
  3933. type: object
  3934. properties:
  3935. refId: {type: string, description: refId}
  3936. errorCode: {type: number, format: float, description: errorCode}
  3937. message: {type: string, description: message}
  3938. /sheets/{sheetId}/rows/emails:
  3939. post:
  3940. summary: Send Rows via Email
  3941. description: Send Rows via Email
  3942. operationId: SendRowsViaEmail
  3943. parameters:
  3944. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3945. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3946. description: Content-Type}
  3947. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3948. description: Accept}
  3949. - name: body
  3950. in: body
  3951. schema:
  3952. type: object
  3953. properties:
  3954. value: {type: string, description: value}
  3955. default: {value: 'reference #/components/schemas/UpdateRequest/allOf/0 not
  3956. found in the OpenAPI spec'}
  3957. required: true
  3958. responses:
  3959. '200':
  3960. description: '200'
  3961. schema:
  3962. type: object
  3963. properties:
  3964. message: {type: string, description: message}
  3965. resultCode: {type: integer, format: int32, description: resultCode}
  3966. /sheets/{sheetId}/rows/copy:
  3967. post:
  3968. summary: Copy Rows to Another Sheet
  3969. description: Copy Rows to Another Sheet
  3970. operationId: CopyRowsToAnotherSheet
  3971. parameters:
  3972. - {name: include, default: discussions, in: query, type: string, required: true}
  3973. - {name: ignoreRowsNotFound, default: 'false', in: query, type: string, required: true}
  3974. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  3975. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  3976. description: Content-Type}
  3977. - {name: Accept, in: header, required: true, type: string, default: application/json,
  3978. description: Accept}
  3979. - name: body
  3980. in: body
  3981. schema:
  3982. type: object
  3983. properties:
  3984. rowIds:
  3985. type: array
  3986. items: {type: number, format: float}
  3987. description: rowIds
  3988. to:
  3989. type: object
  3990. properties:
  3991. value: {type: string, description: value}
  3992. description: to
  3993. default:
  3994. rowIds: [-42241667.224452905, 73529746.99541873]
  3995. to: {value: 'reference #/components/schemas/CopyOrMoveRowDirective/properties/to
  3996. not found in the OpenAPI spec'}
  3997. required: true
  3998. responses:
  3999. '200':
  4000. description: '200'
  4001. schema:
  4002. type: object
  4003. properties:
  4004. destinationSheetId: {type: number, format: float, description: destinationSheetId}
  4005. rowMappings:
  4006. type: array
  4007. items:
  4008. type: object
  4009. properties:
  4010. value: {type: string, description: value}
  4011. description: rowMappings
  4012. /sheets/{sheetId}/rows/move:
  4013. post:
  4014. summary: Move Rows to Another Sheet
  4015. description: Move Rows to Another Sheet
  4016. operationId: MoveRowsToAnotherSheet
  4017. parameters:
  4018. - {name: include, default: discussions, in: query, type: string, required: true}
  4019. - {name: ignoreRowsNotFound, default: 'false', in: query, type: string, required: true}
  4020. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4021. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  4022. description: Content-Type}
  4023. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4024. description: Accept}
  4025. - name: body
  4026. in: body
  4027. schema:
  4028. type: object
  4029. properties:
  4030. rowIds:
  4031. type: array
  4032. items: {type: number, format: float}
  4033. description: rowIds
  4034. to:
  4035. type: object
  4036. properties:
  4037. value: {type: string, description: value}
  4038. description: to
  4039. default:
  4040. rowIds: [-90382242.1263381, 60295872.545592785]
  4041. to: {value: 'reference #/components/schemas/CopyOrMoveRowDirective/properties/to
  4042. not found in the OpenAPI spec'}
  4043. required: true
  4044. responses:
  4045. '200':
  4046. description: '200'
  4047. schema:
  4048. type: object
  4049. properties:
  4050. destinationSheetId: {type: number, format: float, description: destinationSheetId}
  4051. rowMappings:
  4052. type: array
  4053. items:
  4054. type: object
  4055. properties:
  4056. value: {type: string, description: value}
  4057. description: rowMappings
  4058. /sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}:
  4059. get:
  4060. summary: Get Sent Update Request
  4061. description: Get Sent Update Request
  4062. operationId: GetSentUpdateRequest
  4063. parameters:
  4064. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4065. - {name: sentUpdateRequestId, default: ex Excepteur laboris, in: path, type: string,
  4066. required: true}
  4067. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4068. description: Accept}
  4069. responses:
  4070. '200':
  4071. description: '200'
  4072. schema:
  4073. type: object
  4074. properties:
  4075. id: {type: number, format: float, description: id}
  4076. columnIds:
  4077. type: array
  4078. items: {type: number, format: float}
  4079. description: columnIds
  4080. rowIds:
  4081. type: array
  4082. items: {type: number, format: float}
  4083. description: rowIds
  4084. updateRequestId: {type: number, format: float, description: updateRequestId}
  4085. includeAttachments: {type: boolean, description: includeAttachments}
  4086. includeDiscussions: {type: boolean, description: includeDiscussions}
  4087. message: {type: string, description: message}
  4088. sentAt: {type: string, description: sentAt}
  4089. sentBy:
  4090. type: object
  4091. properties:
  4092. email: {type: string, description: email}
  4093. name: {type: string, description: name}
  4094. description: sentBy
  4095. sentTo:
  4096. type: object
  4097. properties:
  4098. email:
  4099. type: object
  4100. properties:
  4101. value: {type: string, description: value}
  4102. description: email
  4103. description: sentTo
  4104. status: {type: string, description: status}
  4105. subject: {type: string, description: subject}
  4106. delete:
  4107. summary: Delete Sent Update Request
  4108. description: Delete Sent Update Request
  4109. operationId: DeleteSentUpdateRequest
  4110. parameters:
  4111. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4112. - {name: sentUpdateRequestId, default: ex Excepteur laboris, in: path, type: string,
  4113. required: true}
  4114. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4115. description: Accept}
  4116. responses:
  4117. '200':
  4118. description: '200'
  4119. schema:
  4120. type: object
  4121. properties:
  4122. message: {type: string, description: message}
  4123. resultCode: {type: integer, format: int32, description: resultCode}
  4124. /sheets/{sheetId}/sentupdaterequests:
  4125. get:
  4126. summary: List Sent Update Requests
  4127. description: List Sent Update Requests
  4128. operationId: ListSentUpdateRequests
  4129. parameters:
  4130. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  4131. - {name: page, default: '1', in: query, type: string, required: true}
  4132. - {name: pageSize, default: '100', in: query, type: string, required: true}
  4133. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4134. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4135. description: Accept}
  4136. responses:
  4137. '200':
  4138. description: '200'
  4139. schema:
  4140. type: object
  4141. properties:
  4142. pageNumber: {type: integer, format: int32, description: pageNumber}
  4143. pageSize: {type: integer, format: int32, description: pageSize}
  4144. totalPages: {type: integer, format: int32, description: totalPages}
  4145. totalCount: {type: integer, format: int32, description: totalCount}
  4146. data:
  4147. type: array
  4148. items:
  4149. type: object
  4150. properties:
  4151. id: {type: integer, format: int32, description: id}
  4152. updateRequestId: {type: integer, format: int32, description: updateRequestId}
  4153. message: {type: string, description: message}
  4154. sentAt: {type: string, description: sentAt}
  4155. sentBy:
  4156. type: object
  4157. properties:
  4158. email: {type: string, description: email}
  4159. name: {type: string, description: name}
  4160. description: sentBy
  4161. sentTo:
  4162. type: object
  4163. properties:
  4164. email: {type: string, description: email}
  4165. description: sentTo
  4166. status: {type: string, description: status}
  4167. subject: {type: string, description: subject}
  4168. description: data
  4169. /sheets/{sheetId}/summary/fields:
  4170. get:
  4171. summary: Get Summary Fields
  4172. description: Get Summary Fields
  4173. operationId: GetSummaryFields
  4174. parameters:
  4175. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  4176. - {name: page, default: '1', in: query, type: string, required: true}
  4177. - {name: pageSize, default: '100', in: query, type: string, required: true}
  4178. - {name: include, default: writerInfo, in: query, type: string, required: true}
  4179. - {name: exclude, default: imageAltText, in: query, type: string, required: true}
  4180. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4181. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4182. description: Accept}
  4183. responses:
  4184. '200':
  4185. description: '200'
  4186. schema:
  4187. type: object
  4188. properties:
  4189. pageNumber: {type: integer, format: int32, description: pageNumber}
  4190. pageSize: {type: integer, format: int32, description: pageSize}
  4191. totalPages: {type: integer, format: int32, description: totalPages}
  4192. totalCount: {type: integer, format: int32, description: totalCount}
  4193. data:
  4194. type: array
  4195. items:
  4196. type: object
  4197. properties:
  4198. id: {type: number, format: float, description: id}
  4199. contactOptions:
  4200. type: array
  4201. items:
  4202. type: object
  4203. properties:
  4204. value: {type: string, description: value}
  4205. description: contactOptions
  4206. createdAt:
  4207. type: object
  4208. properties:
  4209. value: {type: string, description: value}
  4210. description: createdAt
  4211. createdBy:
  4212. type: object
  4213. properties:
  4214. value: {type: string, description: value}
  4215. description: createdBy
  4216. displayValue: {type: string, description: displayValue}
  4217. format: {type: string, description: format}
  4218. formula: {type: string, description: formula}
  4219. hyperlink:
  4220. type: object
  4221. properties:
  4222. value: {type: string, description: value}
  4223. description: hyperlink
  4224. image:
  4225. type: object
  4226. properties:
  4227. value: {type: string, description: value}
  4228. description: image
  4229. index: {type: number, format: float, description: index}
  4230. locked: {type: boolean, description: locked}
  4231. lockedForUser: {type: boolean, description: lockedForUser}
  4232. modifiedAt:
  4233. type: object
  4234. properties:
  4235. value: {type: string, description: value}
  4236. description: modifiedAt
  4237. modifiedBy:
  4238. type: object
  4239. properties:
  4240. value: {type: string, description: value}
  4241. description: modifiedBy
  4242. objectValue:
  4243. type: object
  4244. properties:
  4245. value: {type: string, description: value}
  4246. description: objectValue
  4247. options:
  4248. type: array
  4249. items:
  4250. type: object
  4251. properties:
  4252. value: {type: string, description: value}
  4253. description: options
  4254. symbol: {type: string, description: symbol}
  4255. title: {type: string, description: title}
  4256. type: {type: string, description: type}
  4257. validation: {type: boolean, description: validation}
  4258. description: data
  4259. '500':
  4260. description: '500'
  4261. schema:
  4262. type: object
  4263. properties:
  4264. refId: {type: string, description: refId}
  4265. errorCode: {type: number, format: float, description: errorCode}
  4266. message: {type: string, description: message}
  4267. delete:
  4268. summary: Delete Summary Fields
  4269. description: Delete Summary Fields
  4270. operationId: DeleteSummaryFields
  4271. parameters:
  4272. - {name: ids, default: ex Excepteur laboris, in: query, type: string, required: true}
  4273. - {name: ignoreSummaryFieldsNotFound, default: 'false', in: query, type: string,
  4274. required: true}
  4275. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4276. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4277. description: Accept}
  4278. responses:
  4279. '200':
  4280. description: '200'
  4281. schema:
  4282. type: object
  4283. properties:
  4284. message:
  4285. type: object
  4286. properties:
  4287. value: {type: string, description: value}
  4288. description: message
  4289. resultCode:
  4290. type: object
  4291. properties:
  4292. value: {type: string, description: value}
  4293. description: resultCode
  4294. result:
  4295. type: array
  4296. items: {type: number, format: float}
  4297. description: result
  4298. '500':
  4299. description: '500'
  4300. schema:
  4301. type: object
  4302. properties:
  4303. refId: {type: string, description: refId}
  4304. errorCode: {type: number, format: float, description: errorCode}
  4305. message: {type: string, description: message}
  4306. post:
  4307. summary: Add Summary Fields
  4308. description: Add Summary Fields
  4309. operationId: AddSummaryFields
  4310. parameters:
  4311. - {name: renameIfConflict, default: 'false', in: query, type: string, required: true}
  4312. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4313. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  4314. description: Content-Type}
  4315. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4316. description: Accept}
  4317. - name: body
  4318. in: body
  4319. schema:
  4320. type: array
  4321. items:
  4322. type: object
  4323. properties:
  4324. contactOptions:
  4325. type: array
  4326. items:
  4327. type: object
  4328. properties:
  4329. email: {type: string, description: email}
  4330. name: {type: string, description: name}
  4331. description: contactOptions
  4332. format: {type: string, description: format}
  4333. formula: {type: string, description: formula}
  4334. hyperlink:
  4335. type: object
  4336. properties:
  4337. reportId: {type: number, format: float, description: reportId}
  4338. sheetId: {type: number, format: float, description: sheetId}
  4339. sightId: {type: number, format: float, description: sightId}
  4340. url: {type: string, description: url}
  4341. description: hyperlink
  4342. image:
  4343. type: object
  4344. properties:
  4345. altText: {type: string, description: altText}
  4346. height: {type: number, format: float, description: height}
  4347. id: {type: string, description: id}
  4348. width: {type: number, format: float, description: width}
  4349. description: image
  4350. index: {type: number, format: float, description: index}
  4351. locked: {type: boolean, description: locked}
  4352. objectValue:
  4353. type: object
  4354. properties:
  4355. objectType: {type: string, description: objectType}
  4356. description: objectValue
  4357. options:
  4358. type: array
  4359. items: {type: string}
  4360. description: options
  4361. symbol: {type: string, description: symbol}
  4362. title: {type: string, description: title}
  4363. type: {type: string, description: type}
  4364. validation: {type: boolean, description: validation}
  4365. default:
  4366. contactOptions:
  4367. - {email: Duis sed ad enim, name: proident adipisicing et}
  4368. - {email: Duis sed ad enim, name: proident adipisicing et}
  4369. format: Lorem irure
  4370. formula: 'cillum '
  4371. hyperlink: {reportId: -88037082.03253117, sheetId: -83970282.44662215,
  4372. sightId: -21411939.213548064, url: est velit irure esse}
  4373. image: {altText: magna pariatur ex esse, height: 46334515.99098191,
  4374. id: aliquip cupidatat, width: -74407012.89216545}
  4375. index: -64448345.16738451
  4376. locked: true
  4377. objectValue: {objectType: ABSTRACT_DATETIME}
  4378. options: [dolore id ullamco sed, Excepteur laboris minim proident culpa]
  4379. symbol: occaecat tempor ut amet
  4380. title: ut qui culpa et
  4381. type: CONTACT_LIST
  4382. validation: true
  4383. required: true
  4384. responses:
  4385. '200':
  4386. description: '200'
  4387. schema:
  4388. type: object
  4389. properties:
  4390. message:
  4391. type: object
  4392. properties:
  4393. value: {type: string, description: value}
  4394. description: message
  4395. resultCode:
  4396. type: object
  4397. properties:
  4398. value: {type: string, description: value}
  4399. description: resultCode
  4400. result:
  4401. type: array
  4402. items:
  4403. type: object
  4404. properties:
  4405. id:
  4406. type: object
  4407. properties:
  4408. value: {type: string, description: value}
  4409. description: id
  4410. contactOptions:
  4411. type: object
  4412. properties:
  4413. value: {type: string, description: value}
  4414. description: contactOptions
  4415. createdAt:
  4416. type: object
  4417. properties:
  4418. value: {type: string, description: value}
  4419. description: createdAt
  4420. createdBy:
  4421. type: object
  4422. properties:
  4423. value: {type: string, description: value}
  4424. description: createdBy
  4425. displayValue:
  4426. type: object
  4427. properties:
  4428. value: {type: string, description: value}
  4429. description: displayValue
  4430. format:
  4431. type: object
  4432. properties:
  4433. value: {type: string, description: value}
  4434. description: format
  4435. formula:
  4436. type: object
  4437. properties:
  4438. value: {type: string, description: value}
  4439. description: formula
  4440. hyperlink:
  4441. type: object
  4442. properties:
  4443. value: {type: string, description: value}
  4444. description: hyperlink
  4445. image:
  4446. type: object
  4447. properties:
  4448. value: {type: string, description: value}
  4449. description: image
  4450. index:
  4451. type: object
  4452. properties:
  4453. value: {type: string, description: value}
  4454. description: index
  4455. locked:
  4456. type: object
  4457. properties:
  4458. value: {type: string, description: value}
  4459. description: locked
  4460. lockedForUser:
  4461. type: object
  4462. properties:
  4463. value: {type: string, description: value}
  4464. description: lockedForUser
  4465. modifiedAt:
  4466. type: object
  4467. properties:
  4468. value: {type: string, description: value}
  4469. description: modifiedAt
  4470. modifiedBy:
  4471. type: object
  4472. properties:
  4473. value: {type: string, description: value}
  4474. description: modifiedBy
  4475. objectValue:
  4476. type: object
  4477. properties:
  4478. value: {type: string, description: value}
  4479. description: objectValue
  4480. options:
  4481. type: object
  4482. properties:
  4483. value: {type: string, description: value}
  4484. description: options
  4485. symbol:
  4486. type: object
  4487. properties:
  4488. value: {type: string, description: value}
  4489. description: symbol
  4490. title:
  4491. type: object
  4492. properties:
  4493. value: {type: string, description: value}
  4494. description: title
  4495. type:
  4496. type: object
  4497. properties:
  4498. value: {type: string, description: value}
  4499. description: type
  4500. validation:
  4501. type: object
  4502. properties:
  4503. value: {type: string, description: value}
  4504. description: validation
  4505. description: result
  4506. '500':
  4507. description: '500'
  4508. schema:
  4509. type: object
  4510. properties:
  4511. refId: {type: string, description: refId}
  4512. errorCode: {type: number, format: float, description: errorCode}
  4513. message: {type: string, description: message}
  4514. put:
  4515. summary: Update Summary Fields
  4516. description: Update Summary Fields
  4517. operationId: UpdateSummaryFields
  4518. parameters:
  4519. - {name: renameIfConflict, default: 'false', in: query, type: string, required: true}
  4520. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4521. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  4522. description: Content-Type}
  4523. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4524. description: Accept}
  4525. - name: body
  4526. in: body
  4527. schema:
  4528. type: array
  4529. items:
  4530. type: object
  4531. properties:
  4532. id: {type: number, format: float, description: id}
  4533. contactOptions:
  4534. type: array
  4535. items:
  4536. type: object
  4537. properties:
  4538. email: {type: string, description: email}
  4539. name: {type: string, description: name}
  4540. description: contactOptions
  4541. format: {type: string, description: format}
  4542. formula: {type: string, description: formula}
  4543. hyperlink:
  4544. type: object
  4545. properties:
  4546. reportId: {type: number, format: float, description: reportId}
  4547. sheetId: {type: number, format: float, description: sheetId}
  4548. sightId: {type: number, format: float, description: sightId}
  4549. url: {type: string, description: url}
  4550. description: hyperlink
  4551. image:
  4552. type: object
  4553. properties:
  4554. altText: {type: string, description: altText}
  4555. height: {type: number, format: float, description: height}
  4556. id: {type: string, description: id}
  4557. width: {type: number, format: float, description: width}
  4558. description: image
  4559. index: {type: number, format: float, description: index}
  4560. locked: {type: boolean, description: locked}
  4561. objectValue:
  4562. type: object
  4563. properties:
  4564. objectType: {type: string, description: objectType}
  4565. description: objectValue
  4566. options:
  4567. type: array
  4568. items: {type: string}
  4569. description: options
  4570. symbol: {type: string, description: symbol}
  4571. title: {type: string, description: title}
  4572. type: {type: string, description: type}
  4573. validation: {type: boolean, description: validation}
  4574. default:
  4575. id: 17410921.983596906
  4576. contactOptions:
  4577. - {email: velit proident consectetur sit Excepteur, name: tempor minim
  4578. do nostrud deserunt}
  4579. - {email: velit proident consectetur sit Excepteur, name: tempor minim
  4580. do nostrud deserunt}
  4581. format: velit in et dolore
  4582. formula: dolore nostrud ullamco sit
  4583. hyperlink: {reportId: 43250522.490644395, sheetId: 67606963.51686502,
  4584. sightId: -55596661.0260787, url: ipsum exercitation}
  4585. image: {altText: ad in dolor, height: 90311448.3377203, id: nostrud
  4586. aliqua, width: -76806536.6611713}
  4587. index: 33543781.668559223
  4588. locked: false
  4589. objectValue: {objectType: MULTI_PICKLIST}
  4590. options: [dolor consectetur sunt incid, pariatur]
  4591. symbol: exercitation elit et
  4592. title: fugiat ullamco
  4593. type: CONTACT_LIST
  4594. validation: false
  4595. required: true
  4596. responses:
  4597. '200':
  4598. description: '200'
  4599. schema:
  4600. type: object
  4601. properties:
  4602. message: {type: string, description: message}
  4603. resultCode: {type: integer, format: int32, description: resultCode}
  4604. result:
  4605. type: array
  4606. items:
  4607. type: object
  4608. properties:
  4609. id:
  4610. type: object
  4611. properties:
  4612. value: {type: string, description: value}
  4613. description: id
  4614. contactOptions:
  4615. type: object
  4616. properties:
  4617. value: {type: string, description: value}
  4618. description: contactOptions
  4619. createdAt:
  4620. type: object
  4621. properties:
  4622. value: {type: string, description: value}
  4623. description: createdAt
  4624. createdBy:
  4625. type: object
  4626. properties:
  4627. value: {type: string, description: value}
  4628. description: createdBy
  4629. displayValue:
  4630. type: object
  4631. properties:
  4632. value: {type: string, description: value}
  4633. description: displayValue
  4634. format:
  4635. type: object
  4636. properties:
  4637. value: {type: string, description: value}
  4638. description: format
  4639. formula:
  4640. type: object
  4641. properties:
  4642. value: {type: string, description: value}
  4643. description: formula
  4644. hyperlink:
  4645. type: object
  4646. properties:
  4647. value: {type: string, description: value}
  4648. description: hyperlink
  4649. image:
  4650. type: object
  4651. properties:
  4652. value: {type: string, description: value}
  4653. description: image
  4654. index:
  4655. type: object
  4656. properties:
  4657. value: {type: string, description: value}
  4658. description: index
  4659. locked:
  4660. type: object
  4661. properties:
  4662. value: {type: string, description: value}
  4663. description: locked
  4664. lockedForUser:
  4665. type: object
  4666. properties:
  4667. value: {type: string, description: value}
  4668. description: lockedForUser
  4669. modifiedAt:
  4670. type: object
  4671. properties:
  4672. value: {type: string, description: value}
  4673. description: modifiedAt
  4674. modifiedBy:
  4675. type: object
  4676. properties:
  4677. value: {type: string, description: value}
  4678. description: modifiedBy
  4679. objectValue:
  4680. type: object
  4681. properties:
  4682. value: {type: string, description: value}
  4683. description: objectValue
  4684. options:
  4685. type: object
  4686. properties:
  4687. value: {type: string, description: value}
  4688. description: options
  4689. symbol:
  4690. type: object
  4691. properties:
  4692. value: {type: string, description: value}
  4693. description: symbol
  4694. title:
  4695. type: object
  4696. properties:
  4697. value: {type: string, description: value}
  4698. description: title
  4699. type:
  4700. type: object
  4701. properties:
  4702. value: {type: string, description: value}
  4703. description: type
  4704. validation:
  4705. type: object
  4706. properties:
  4707. value: {type: string, description: value}
  4708. description: validation
  4709. description: result
  4710. '500':
  4711. description: '500'
  4712. schema:
  4713. type: object
  4714. properties:
  4715. refId: {type: string, description: refId}
  4716. errorCode: {type: number, format: float, description: errorCode}
  4717. message: {type: string, description: message}
  4718. /sheets/{sheetId}/summary/fields/{fieldId}/images:
  4719. post:
  4720. summary: Add Image to Sheet Summary
  4721. description: Add Image to Sheet Summary
  4722. operationId: AddImageToSheetSummary
  4723. parameters:
  4724. - {name: altText, default: ex Excepteur laboris, in: query, type: string, required: true}
  4725. - {name: overrideValidation, default: 'false', in: query, type: string, required: true}
  4726. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4727. - {name: fieldId, default: '-4847524.674802229', in: path, type: string, required: true}
  4728. - {name: Content-Disposition, in: header, required: true, type: string, default: attachment;
  4729. filename="ProgressReport.docx", description: Content-Disposition}
  4730. - {name: Content-Length, in: header, required: true, type: string, default: '5463',
  4731. description: Content-Length}
  4732. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  4733. description: Content-Type}
  4734. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4735. description: Accept}
  4736. responses:
  4737. '200':
  4738. description: '200'
  4739. schema:
  4740. type: object
  4741. properties:
  4742. message: {type: string, description: message}
  4743. resultCode: {type: integer, format: int32, description: resultCode}
  4744. result:
  4745. type: object
  4746. properties:
  4747. id: {type: number, format: float, description: id}
  4748. index: {type: number, format: float, description: index}
  4749. title: {type: string, description: title}
  4750. type: {type: string, description: type}
  4751. locked: {type: boolean, description: locked}
  4752. lockedForUser: {type: boolean, description: lockedForUser}
  4753. objectValue:
  4754. type: object
  4755. properties:
  4756. objectType: {type: string, description: objectType}
  4757. description: objectValue
  4758. formula: {type: string, description: formula}
  4759. image:
  4760. type: object
  4761. properties:
  4762. altText: {type: string, description: altText}
  4763. height: {type: number, format: float, description: height}
  4764. id: {type: string, description: id}
  4765. width: {type: number, format: float, description: width}
  4766. description: image
  4767. createdAt: {type: string, description: createdAt}
  4768. modifiedAt: {type: string, description: modifiedAt}
  4769. version: {type: number, format: float, description: version}
  4770. description: result
  4771. '500':
  4772. description: '500'
  4773. schema:
  4774. type: object
  4775. properties:
  4776. refId: {type: string, description: refId}
  4777. errorCode: {type: number, format: float, description: errorCode}
  4778. message: {type: string, description: message}
  4779. /sheets/{sheetId}/summary:
  4780. get:
  4781. summary: Get Sheet Summary
  4782. description: Get Sheet Summary
  4783. operationId: GetSheetSummary
  4784. parameters:
  4785. - {name: include, default: writerInfo, in: query, type: string, required: true}
  4786. - {name: exclude, default: imageAltText, in: query, type: string, required: true}
  4787. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4788. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4789. description: Accept}
  4790. responses:
  4791. '200':
  4792. description: '200'
  4793. schema:
  4794. type: object
  4795. properties:
  4796. value: {type: string, description: value}
  4797. '500':
  4798. description: '500'
  4799. schema:
  4800. type: object
  4801. properties:
  4802. refId: {type: string, description: refId}
  4803. errorCode: {type: number, format: float, description: errorCode}
  4804. message: {type: string, description: message}
  4805. /sheets/{sheetId}/updaterequests/{updateRequestId}:
  4806. get:
  4807. summary: Get an Update Request
  4808. description: Get an Update Request
  4809. operationId: GetAnUpdateRequest
  4810. parameters:
  4811. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4812. - {name: updateRequestId, default: ex Excepteur laboris, in: path, type: string,
  4813. required: true}
  4814. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4815. description: Accept}
  4816. responses:
  4817. '200':
  4818. description: '200'
  4819. schema:
  4820. type: object
  4821. properties:
  4822. id: {type: number, format: float, description: id}
  4823. createdAt:
  4824. type: object
  4825. properties:
  4826. value: {type: string, description: value}
  4827. description: createdAt
  4828. modifiedAt:
  4829. type: object
  4830. properties:
  4831. value: {type: string, description: value}
  4832. description: modifiedAt
  4833. schedule:
  4834. type: object
  4835. properties:
  4836. value: {type: string, description: value}
  4837. description: schedule
  4838. sentBy:
  4839. type: object
  4840. properties:
  4841. email:
  4842. type: object
  4843. properties:
  4844. value: {type: string, description: value}
  4845. description: email
  4846. name:
  4847. type: object
  4848. properties:
  4849. value: {type: string, description: value}
  4850. description: name
  4851. description: sentBy
  4852. delete:
  4853. summary: Delete an Update Request
  4854. description: Delete an Update Request
  4855. operationId: DeleteAnUpdateRequest
  4856. parameters:
  4857. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4858. - {name: updateRequestId, default: ex Excepteur laboris, in: path, type: string,
  4859. required: true}
  4860. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4861. description: Accept}
  4862. responses:
  4863. '200':
  4864. description: '200'
  4865. schema:
  4866. type: object
  4867. properties:
  4868. message: {type: string, description: message}
  4869. resultCode: {type: integer, format: int32, description: resultCode}
  4870. put:
  4871. summary: Update an Update Request
  4872. description: Update an Update Request
  4873. operationId: UpdateAnUpdateRequest
  4874. parameters:
  4875. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4876. - {name: updateRequestId, default: ex Excepteur laboris, in: path, type: string,
  4877. required: true}
  4878. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4879. description: Accept}
  4880. responses:
  4881. '200':
  4882. description: '200'
  4883. schema:
  4884. type: object
  4885. properties:
  4886. message: {type: string, description: message}
  4887. resultCode: {type: integer, format: int32, description: resultCode}
  4888. result:
  4889. type: object
  4890. properties:
  4891. id:
  4892. type: object
  4893. properties:
  4894. value: {type: string, description: value}
  4895. description: id
  4896. createdAt:
  4897. type: object
  4898. properties:
  4899. value: {type: string, description: value}
  4900. description: createdAt
  4901. modifiedAt:
  4902. type: object
  4903. properties:
  4904. value: {type: string, description: value}
  4905. description: modifiedAt
  4906. schedule:
  4907. type: object
  4908. properties:
  4909. value: {type: string, description: value}
  4910. description: schedule
  4911. sentBy:
  4912. type: object
  4913. properties:
  4914. value: {type: string, description: value}
  4915. description: sentBy
  4916. description: result
  4917. /sheets/{sheetId}/updaterequests:
  4918. get:
  4919. summary: List Update Requests
  4920. description: List Update Requests
  4921. operationId: ListUpdateRequests
  4922. parameters:
  4923. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  4924. - {name: page, default: '1', in: query, type: string, required: true}
  4925. - {name: pageSize, default: '100', in: query, type: string, required: true}
  4926. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4927. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4928. description: Accept}
  4929. responses:
  4930. '200':
  4931. description: '200'
  4932. schema:
  4933. type: object
  4934. properties:
  4935. pageNumber: {type: integer, format: int32, description: pageNumber}
  4936. pageSize: {type: integer, format: int32, description: pageSize}
  4937. totalPages: {type: integer, format: int32, description: totalPages}
  4938. totalCount: {type: integer, format: int32, description: totalCount}
  4939. data:
  4940. type: array
  4941. items:
  4942. type: object
  4943. properties:
  4944. id: {type: number, format: float, description: id}
  4945. createdAt:
  4946. type: object
  4947. properties:
  4948. value: {type: string, description: value}
  4949. description: createdAt
  4950. modifiedAt:
  4951. type: object
  4952. properties:
  4953. value: {type: string, description: value}
  4954. description: modifiedAt
  4955. schedule:
  4956. type: object
  4957. properties:
  4958. value: {type: string, description: value}
  4959. description: schedule
  4960. sentBy:
  4961. type: object
  4962. properties:
  4963. value: {type: string, description: value}
  4964. description: sentBy
  4965. description: data
  4966. post:
  4967. summary: Create an Update Request
  4968. description: Create an Update Request
  4969. operationId: CreateAnUpdateRequest
  4970. parameters:
  4971. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  4972. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  4973. description: Content-Type}
  4974. - {name: Accept, in: header, required: true, type: string, default: application/json,
  4975. description: Accept}
  4976. - name: body
  4977. in: body
  4978. schema:
  4979. type: object
  4980. properties:
  4981. id: {type: number, format: float, description: id}
  4982. createdAt:
  4983. type: object
  4984. properties:
  4985. value: {type: string, description: value}
  4986. description: createdAt
  4987. modifiedAt:
  4988. type: object
  4989. properties:
  4990. value: {type: string, description: value}
  4991. description: modifiedAt
  4992. schedule:
  4993. type: object
  4994. properties:
  4995. value: {type: string, description: value}
  4996. description: schedule
  4997. sentBy:
  4998. type: object
  4999. properties:
  5000. email:
  5001. type: object
  5002. properties:
  5003. value: {type: string, description: value}
  5004. description: email
  5005. description: sentBy
  5006. default:
  5007. id: 66702084.7665416
  5008. createdAt: {value: '<Error: Too many levels of nesting to fake this schema>'}
  5009. modifiedAt: {value: '<Error: Too many levels of nesting to fake this schema>'}
  5010. schedule: {value: 'reference #/components/schemas/UpdateRequest/allOf/1/properties/schedule/allOf/0
  5011. not found in the OpenAPI spec'}
  5012. sentBy:
  5013. email: {value: '<Error: Too many levels of nesting to fake this schema>'}
  5014. required: true
  5015. responses:
  5016. '200':
  5017. description: '200'
  5018. schema:
  5019. type: object
  5020. properties:
  5021. message: {type: string, description: message}
  5022. resultCode: {type: integer, format: int32, description: resultCode}
  5023. result:
  5024. type: object
  5025. properties:
  5026. id: {type: number, format: float, description: id}
  5027. createdAt:
  5028. type: object
  5029. properties:
  5030. value: {type: string, description: value}
  5031. description: createdAt
  5032. modifiedAt:
  5033. type: object
  5034. properties:
  5035. value: {type: string, description: value}
  5036. description: modifiedAt
  5037. schedule:
  5038. type: object
  5039. properties:
  5040. value: {type: string, description: value}
  5041. description: schedule
  5042. sentBy:
  5043. type: object
  5044. properties:
  5045. value: {type: string, description: value}
  5046. description: sentBy
  5047. description: result
  5048. /sheets/{sheetId}/shares/{shareId}:
  5049. get:
  5050. summary: Get Sheet Share.
  5051. description: Get Sheet Share.
  5052. operationId: GetSheetShare
  5053. parameters:
  5054. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5055. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  5056. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5057. description: Accept}
  5058. responses:
  5059. '200':
  5060. description: '200'
  5061. schema:
  5062. type: object
  5063. properties:
  5064. id: {type: string, description: id}
  5065. groupId: {type: number, format: float, description: groupId}
  5066. userId: {type: number, format: float, description: userId}
  5067. type: {type: string, description: type}
  5068. accessLevel:
  5069. type: object
  5070. properties:
  5071. value: {type: string, description: value}
  5072. description: accessLevel
  5073. ccMe: {type: boolean, description: ccMe}
  5074. createdAt: {type: string, description: createdAt}
  5075. email: {type: string, description: email}
  5076. message: {type: string, description: message}
  5077. modifiedAt: {type: string, description: modifiedAt}
  5078. name: {type: string, description: name}
  5079. scope: {type: string, description: scope}
  5080. subject: {type: string, description: subject}
  5081. '500':
  5082. description: '500'
  5083. schema:
  5084. type: object
  5085. properties:
  5086. refId: {type: string, description: refId}
  5087. errorCode: {type: number, format: float, description: errorCode}
  5088. message: {type: string, description: message}
  5089. delete:
  5090. summary: Delete Sheet Share
  5091. description: Delete Sheet Share
  5092. operationId: DeleteSheetShare
  5093. parameters:
  5094. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5095. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  5096. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5097. description: Accept}
  5098. responses:
  5099. '200':
  5100. description: '200'
  5101. schema:
  5102. type: object
  5103. properties:
  5104. message: {type: string, description: message}
  5105. resultCode: {type: integer, format: int32, description: resultCode}
  5106. '500':
  5107. description: '500'
  5108. schema:
  5109. type: object
  5110. properties:
  5111. refId: {type: string, description: refId}
  5112. errorCode: {type: number, format: float, description: errorCode}
  5113. message: {type: string, description: message}
  5114. put:
  5115. summary: Update Sheet Share.
  5116. description: Update Sheet Share.
  5117. operationId: UpdateSheetShare
  5118. parameters:
  5119. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5120. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  5121. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5122. description: Content-Type}
  5123. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5124. description: Accept}
  5125. - name: body
  5126. in: body
  5127. schema:
  5128. type: object
  5129. properties:
  5130. message:
  5131. type: object
  5132. properties:
  5133. value: {type: string, description: value}
  5134. description: message
  5135. resultCode:
  5136. type: object
  5137. properties:
  5138. value: {type: string, description: value}
  5139. description: resultCode
  5140. result:
  5141. type: object
  5142. properties: {}
  5143. description: result
  5144. default:
  5145. message: {value: '<Error: Too many levels of nesting to fake this schema>'}
  5146. resultCode: {value: '<Error: Too many levels of nesting to fake this schema>'}
  5147. result: {}
  5148. required: true
  5149. responses:
  5150. '200':
  5151. description: '200'
  5152. schema:
  5153. type: object
  5154. properties:
  5155. message: {type: string, description: message}
  5156. resultCode: {type: integer, format: int32, description: resultCode}
  5157. '500':
  5158. description: '500'
  5159. schema:
  5160. type: object
  5161. properties:
  5162. refId: {type: string, description: refId}
  5163. errorCode: {type: number, format: float, description: errorCode}
  5164. message: {type: string, description: message}
  5165. /sheets/{sheetId}/shares:
  5166. get:
  5167. summary: List Sheet Shares
  5168. description: List Sheet Shares
  5169. operationId: ListSheetShares
  5170. parameters:
  5171. - {name: sharingInclude, default: ITEM, in: query, type: string, required: true}
  5172. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  5173. - {name: page, default: '1', in: query, type: string, required: true}
  5174. - {name: pageSize, default: '100', in: query, type: string, required: true}
  5175. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5176. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5177. description: Accept}
  5178. responses:
  5179. '200':
  5180. description: '200'
  5181. schema:
  5182. type: object
  5183. properties:
  5184. pageNumber: {type: integer, format: int32, description: pageNumber}
  5185. pageSize: {type: integer, format: int32, description: pageSize}
  5186. totalPages: {type: integer, format: int32, description: totalPages}
  5187. totalCount: {type: integer, format: int32, description: totalCount}
  5188. result:
  5189. type: array
  5190. items:
  5191. type: object
  5192. properties:
  5193. id:
  5194. type: object
  5195. properties:
  5196. value: {type: string, description: value}
  5197. description: id
  5198. groupId:
  5199. type: object
  5200. properties:
  5201. value: {type: string, description: value}
  5202. description: groupId
  5203. userId:
  5204. type: object
  5205. properties:
  5206. value: {type: string, description: value}
  5207. description: userId
  5208. type:
  5209. type: object
  5210. properties:
  5211. value: {type: string, description: value}
  5212. description: type
  5213. accessLevel:
  5214. type: object
  5215. properties:
  5216. value: {type: string, description: value}
  5217. description: accessLevel
  5218. ccMe:
  5219. type: object
  5220. properties:
  5221. value: {type: string, description: value}
  5222. description: ccMe
  5223. createdAt:
  5224. type: object
  5225. properties:
  5226. value: {type: string, description: value}
  5227. description: createdAt
  5228. email:
  5229. type: object
  5230. properties:
  5231. value: {type: string, description: value}
  5232. description: email
  5233. message:
  5234. type: object
  5235. properties:
  5236. value: {type: string, description: value}
  5237. description: message
  5238. modifiedAt:
  5239. type: object
  5240. properties:
  5241. value: {type: string, description: value}
  5242. description: modifiedAt
  5243. name:
  5244. type: object
  5245. properties:
  5246. value: {type: string, description: value}
  5247. description: name
  5248. scope:
  5249. type: object
  5250. properties:
  5251. value: {type: string, description: value}
  5252. description: scope
  5253. subject:
  5254. type: object
  5255. properties:
  5256. value: {type: string, description: value}
  5257. description: subject
  5258. description: result
  5259. '500':
  5260. description: '500'
  5261. schema:
  5262. type: object
  5263. properties:
  5264. refId: {type: string, description: refId}
  5265. errorCode: {type: number, format: float, description: errorCode}
  5266. message: {type: string, description: message}
  5267. post:
  5268. summary: Share Sheet
  5269. description: Share Sheet
  5270. operationId: ShareSheet
  5271. parameters:
  5272. - {name: sendEmail, default: 'false', in: query, type: string, required: true}
  5273. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5274. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5275. description: Content-Type}
  5276. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5277. description: Accept}
  5278. - name: body
  5279. in: body
  5280. schema:
  5281. type: object
  5282. properties:
  5283. id: {type: string, description: id}
  5284. groupId: {type: number, format: float, description: groupId}
  5285. userId: {type: number, format: float, description: userId}
  5286. type: {type: string, description: type}
  5287. accessLevel:
  5288. type: object
  5289. properties:
  5290. value: {type: string, description: value}
  5291. description: accessLevel
  5292. ccMe: {type: boolean, description: ccMe}
  5293. createdAt: {type: string, description: createdAt}
  5294. email: {type: string, description: email}
  5295. message: {type: string, description: message}
  5296. modifiedAt: {type: string, description: modifiedAt}
  5297. name: {type: string, description: name}
  5298. scope: {type: string, description: scope}
  5299. subject: {type: string, description: subject}
  5300. default:
  5301. id: mollit
  5302. groupId: 6458197.992068276
  5303. userId: 55638615.369980216
  5304. type: proident ex
  5305. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  5306. not found in the OpenAPI spec'}
  5307. ccMe: false
  5308. createdAt: <dateTime>
  5309. email: voluptate Duis minim Lorem
  5310. message: voluptate officia eiusmod qui
  5311. modifiedAt: <dateTime>
  5312. name: do in
  5313. scope: occaecat labore
  5314. subject: deserunt ut
  5315. required: true
  5316. responses:
  5317. '200':
  5318. description: '200'
  5319. schema:
  5320. type: object
  5321. properties:
  5322. message: {type: string, description: message}
  5323. resultCode: {type: integer, format: int32, description: resultCode}
  5324. result:
  5325. type: object
  5326. properties:
  5327. id:
  5328. type: object
  5329. properties:
  5330. value: {type: string, description: value}
  5331. description: id
  5332. groupId:
  5333. type: object
  5334. properties:
  5335. value: {type: string, description: value}
  5336. description: groupId
  5337. userId:
  5338. type: object
  5339. properties:
  5340. value: {type: string, description: value}
  5341. description: userId
  5342. type:
  5343. type: object
  5344. properties:
  5345. value: {type: string, description: value}
  5346. description: type
  5347. accessLevel:
  5348. type: object
  5349. properties:
  5350. value: {type: string, description: value}
  5351. description: accessLevel
  5352. ccMe:
  5353. type: object
  5354. properties:
  5355. value: {type: string, description: value}
  5356. description: ccMe
  5357. createdAt:
  5358. type: object
  5359. properties:
  5360. value: {type: string, description: value}
  5361. description: createdAt
  5362. email:
  5363. type: object
  5364. properties:
  5365. value: {type: string, description: value}
  5366. description: email
  5367. message:
  5368. type: object
  5369. properties:
  5370. value: {type: string, description: value}
  5371. description: message
  5372. modifiedAt:
  5373. type: object
  5374. properties:
  5375. value: {type: string, description: value}
  5376. description: modifiedAt
  5377. name:
  5378. type: object
  5379. properties:
  5380. value: {type: string, description: value}
  5381. description: name
  5382. scope:
  5383. type: object
  5384. properties:
  5385. value: {type: string, description: value}
  5386. description: scope
  5387. subject:
  5388. type: object
  5389. properties:
  5390. value: {type: string, description: value}
  5391. description: subject
  5392. description: result
  5393. '400':
  5394. description: '400'
  5395. schema:
  5396. type: object
  5397. properties:
  5398. refId: {type: string, description: refId}
  5399. errorCode: {type: number, format: float, description: errorCode}
  5400. message: {type: string, description: message}
  5401. '500':
  5402. description: '500'
  5403. schema:
  5404. type: object
  5405. properties:
  5406. refId: {type: string, description: refId}
  5407. errorCode: {type: number, format: float, description: errorCode}
  5408. message: {type: string, description: message}
  5409. /sheets/{sheetId}:
  5410. get:
  5411. summary: Get Sheet
  5412. description: Get Sheet
  5413. operationId: GetSheet
  5414. parameters:
  5415. - {name: include, default: writerInfo, in: query, type: string, required: true}
  5416. - {name: exclude, default: filteredOutRows, in: query, type: string, required: true}
  5417. - {name: columnIds, default: ex Excepteur laboris, in: query, type: string,
  5418. required: true}
  5419. - {name: filterId, default: ex Excepteur laboris, in: query, type: string, required: true}
  5420. - {name: ifVersionAfter, default: '-57155082', in: query, type: string, required: true}
  5421. - {name: level, default: '1', in: query, type: string, required: true}
  5422. - {name: pageSize, default: '100', in: query, type: string, required: true}
  5423. - {name: page, default: '1', in: query, type: string, required: true}
  5424. - {name: paperSize, default: LETTER, in: query, type: string, required: true}
  5425. - {name: rowIds, default: ex Excepteur laboris, in: query, type: string, required: true}
  5426. - {name: rowNumbers, default: ex Excepteur laboris, in: query, type: string,
  5427. required: true}
  5428. - {name: rowsModifiedSince, default: <dateTime>, in: query, type: string, required: true}
  5429. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5430. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5431. description: Accept}
  5432. responses:
  5433. '200':
  5434. description: '200'
  5435. schema:
  5436. type: object
  5437. properties:
  5438. value: {type: string, description: value}
  5439. '500':
  5440. description: '500'
  5441. schema:
  5442. type: object
  5443. properties:
  5444. refId: {type: string, description: refId}
  5445. errorCode: {type: number, format: float, description: errorCode}
  5446. message: {type: string, description: message}
  5447. delete:
  5448. summary: Delete Sheet
  5449. description: Delete Sheet
  5450. operationId: DeleteSheet
  5451. parameters:
  5452. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5453. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5454. description: Accept}
  5455. responses:
  5456. '200':
  5457. description: '200'
  5458. schema:
  5459. type: object
  5460. properties:
  5461. message: {type: string, description: message}
  5462. resultCode: {type: integer, format: int32, description: resultCode}
  5463. '500':
  5464. description: '500'
  5465. schema:
  5466. type: object
  5467. properties:
  5468. refId: {type: string, description: refId}
  5469. errorCode: {type: number, format: float, description: errorCode}
  5470. message: {type: string, description: message}
  5471. put:
  5472. summary: Update Sheet
  5473. description: Update Sheet
  5474. operationId: UpdateSheet
  5475. parameters:
  5476. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5477. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5478. description: Content-Type}
  5479. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5480. description: Accept}
  5481. - name: body
  5482. in: body
  5483. schema:
  5484. type: object
  5485. properties:
  5486. name: {type: string, description: name}
  5487. projectSettings:
  5488. type: object
  5489. properties:
  5490. value: {type: string, description: value}
  5491. description: projectSettings
  5492. userSettings:
  5493. type: object
  5494. properties:
  5495. value: {type: string, description: value}
  5496. description: userSettings
  5497. default:
  5498. name: incididunt tempor
  5499. projectSettings: {value: 'reference #/components/schemas/Sheet/properties/projectSettings
  5500. not found in the OpenAPI spec'}
  5501. userSettings: {value: 'reference #/components/schemas/Sheet/properties/userSettings
  5502. not found in the OpenAPI spec'}
  5503. required: true
  5504. responses:
  5505. '200':
  5506. description: '200'
  5507. schema:
  5508. type: object
  5509. properties:
  5510. message: {type: string, description: message}
  5511. resultCode: {type: integer, format: int32, description: resultCode}
  5512. result:
  5513. type: object
  5514. properties:
  5515. value: {type: string, description: value}
  5516. description: result
  5517. /sheets/{sheetId}/copy:
  5518. post:
  5519. summary: Copy Sheet
  5520. description: Copy Sheet
  5521. operationId: CopySheet
  5522. parameters:
  5523. - {name: include, default: filters, in: query, type: string, required: true}
  5524. - {name: exclude, default: sheetHyperlinks, in: query, type: string, required: true}
  5525. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5526. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5527. description: Content-Type}
  5528. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5529. description: Accept}
  5530. - name: body
  5531. in: body
  5532. schema:
  5533. type: object
  5534. properties:
  5535. destinationId: {type: number, format: float, description: destinationId}
  5536. destinationType: {type: string, description: destinationType}
  5537. newName: {type: string, description: newName}
  5538. default: {destinationId: 80073746.07746986, destinationType: workspace,
  5539. newName: in eu}
  5540. required: true
  5541. responses:
  5542. '200':
  5543. description: '200'
  5544. schema:
  5545. type: object
  5546. properties:
  5547. message: {type: string, description: message}
  5548. resultCode: {type: integer, format: int32, description: resultCode}
  5549. result:
  5550. type: object
  5551. properties:
  5552. id:
  5553. type: object
  5554. properties:
  5555. value: {type: string, description: value}
  5556. description: id
  5557. accessLevel:
  5558. type: object
  5559. properties:
  5560. value: {type: string, description: value}
  5561. description: accessLevel
  5562. name:
  5563. type: object
  5564. properties:
  5565. value: {type: string, description: value}
  5566. description: name
  5567. permalink:
  5568. type: object
  5569. properties:
  5570. value: {type: string, description: value}
  5571. description: permalink
  5572. description: result
  5573. '500':
  5574. description: '500'
  5575. schema:
  5576. type: object
  5577. properties:
  5578. refId: {type: string, description: refId}
  5579. errorCode: {type: number, format: float, description: errorCode}
  5580. message: {type: string, description: message}
  5581. /sheets/{sheetId}/emails:
  5582. post:
  5583. summary: Send Sheet via Email
  5584. description: Send Sheet via Email
  5585. operationId: SendSheetViaEmail
  5586. parameters:
  5587. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5588. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5589. description: Content-Type}
  5590. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5591. description: Accept}
  5592. - name: body
  5593. in: body
  5594. schema:
  5595. type: object
  5596. properties:
  5597. value: {type: string, description: value}
  5598. default: {value: 'reference #/components/schemas/ProofRequestBody/allOf/0
  5599. not found in the OpenAPI spec'}
  5600. required: true
  5601. responses:
  5602. '200':
  5603. description: '200'
  5604. schema:
  5605. type: object
  5606. properties:
  5607. message: {type: string, description: message}
  5608. resultCode: {type: integer, format: int32, description: resultCode}
  5609. /sheets/{sheetId}/move:
  5610. post:
  5611. summary: Move Sheet
  5612. description: Move Sheet
  5613. operationId: MoveSheet
  5614. parameters:
  5615. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5616. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5617. description: Content-Type}
  5618. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5619. description: Accept}
  5620. - name: body
  5621. in: body
  5622. schema:
  5623. type: object
  5624. properties:
  5625. destinationId: {type: number, format: float, description: destinationId}
  5626. destinationType: {type: string, description: destinationType}
  5627. default: {destinationId: '71768309.34875712', destinationType: home}
  5628. required: true
  5629. responses:
  5630. '200':
  5631. description: '200'
  5632. schema:
  5633. type: object
  5634. properties:
  5635. message: {type: string, description: message}
  5636. resultCode: {type: integer, format: int32, description: resultCode}
  5637. result:
  5638. type: object
  5639. properties:
  5640. id:
  5641. type: object
  5642. properties:
  5643. value: {type: string, description: value}
  5644. description: id
  5645. accessLevel:
  5646. type: object
  5647. properties:
  5648. value: {type: string, description: value}
  5649. description: accessLevel
  5650. name:
  5651. type: object
  5652. properties:
  5653. value: {type: string, description: value}
  5654. description: name
  5655. permalink:
  5656. type: object
  5657. properties:
  5658. value: {type: string, description: value}
  5659. description: permalink
  5660. description: result
  5661. '500':
  5662. description: '500'
  5663. schema:
  5664. type: object
  5665. properties:
  5666. refId: {type: string, description: refId}
  5667. errorCode: {type: number, format: float, description: errorCode}
  5668. message: {type: string, description: message}
  5669. /sheets/{sheetId}/sort:
  5670. post:
  5671. summary: Sort Rows in Sheet
  5672. description: Sort Rows in Sheet
  5673. operationId: SortRowsInSheet
  5674. parameters:
  5675. - {name: include&exclude, default: ex Excepteur laboris, in: query, type: string,
  5676. required: true}
  5677. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5678. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5679. description: Content-Type}
  5680. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5681. description: Accept}
  5682. - name: body
  5683. in: body
  5684. schema:
  5685. type: object
  5686. properties:
  5687. sortCriteria:
  5688. type: array
  5689. items:
  5690. type: object
  5691. properties:
  5692. value: {type: string, description: value}
  5693. description: sortCriteria
  5694. default:
  5695. sortCriteria:
  5696. - {value: 'reference #/components/schemas/SortSpecifier/properties/sortCriteria/items
  5697. not found in the OpenAPI spec'}
  5698. - {value: 'reference #/components/schemas/SortSpecifier/properties/sortCriteria/items
  5699. not found in the OpenAPI spec'}
  5700. required: true
  5701. responses:
  5702. '200':
  5703. description: '200'
  5704. schema:
  5705. type: object
  5706. properties:
  5707. value: {type: string, description: value}
  5708. /sheets/{sheetId}/version:
  5709. get:
  5710. summary: Get Sheet Version
  5711. description: Get Sheet Version
  5712. operationId: GetSheetVersion
  5713. parameters:
  5714. - {name: sheetId, default: '-4847524.674802229', in: path, type: string, required: true}
  5715. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5716. description: Accept}
  5717. responses:
  5718. '200':
  5719. description: '200'
  5720. schema:
  5721. type: object
  5722. properties:
  5723. version: {type: number, format: float, description: version}
  5724. '500':
  5725. description: '500'
  5726. schema:
  5727. type: object
  5728. properties:
  5729. refId: {type: string, description: refId}
  5730. errorCode: {type: number, format: float, description: errorCode}
  5731. message: {type: string, description: message}
  5732. /sheets:
  5733. get:
  5734. summary: List Sheets
  5735. description: List Sheets
  5736. operationId: ListSheets
  5737. parameters:
  5738. - {name: include, default: sheetVersion, in: query, type: string, required: true}
  5739. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  5740. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  5741. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  5742. - {name: page, default: '1', in: query, type: string, required: true}
  5743. - {name: pageSize, default: '100', in: query, type: string, required: true}
  5744. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5745. description: Accept}
  5746. responses:
  5747. '200':
  5748. description: '200'
  5749. schema:
  5750. type: object
  5751. properties:
  5752. pageNumber: {type: integer, format: int32, description: pageNumber}
  5753. pageSize: {type: integer, format: int32, description: pageSize}
  5754. totalPages: {type: integer, format: int32, description: totalPages}
  5755. totalCount: {type: integer, format: int32, description: totalCount}
  5756. data:
  5757. type: array
  5758. items:
  5759. type: object
  5760. properties:
  5761. id:
  5762. type: object
  5763. properties:
  5764. value: {type: string, description: value}
  5765. description: id
  5766. accessLevel:
  5767. type: object
  5768. properties:
  5769. value: {type: string, description: value}
  5770. description: accessLevel
  5771. createdAt:
  5772. type: object
  5773. properties:
  5774. value: {type: string, description: value}
  5775. description: createdAt
  5776. modifiedAt:
  5777. type: object
  5778. properties:
  5779. value: {type: string, description: value}
  5780. description: modifiedAt
  5781. name:
  5782. type: object
  5783. properties:
  5784. value: {type: string, description: value}
  5785. description: name
  5786. permalink:
  5787. type: object
  5788. properties:
  5789. value: {type: string, description: value}
  5790. description: permalink
  5791. version:
  5792. type: object
  5793. properties:
  5794. value: {type: string, description: value}
  5795. description: version
  5796. source:
  5797. type: object
  5798. properties:
  5799. value: {type: string, description: value}
  5800. description: source
  5801. description: data
  5802. '500':
  5803. description: '500'
  5804. schema:
  5805. type: object
  5806. properties:
  5807. refId: {type: string, description: refId}
  5808. errorCode: {type: number, format: float, description: errorCode}
  5809. message: {type: string, description: message}
  5810. post:
  5811. summary: Create Sheet in "Sheets" Folder
  5812. description: Create Sheet in "Sheets" Folder
  5813. operationId: CreateSheetInSheetsFolder
  5814. parameters:
  5815. - {name: include, default: rules, in: query, type: string, required: true}
  5816. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  5817. description: Content-Type}
  5818. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5819. description: Accept}
  5820. - name: body
  5821. in: body
  5822. schema:
  5823. type: object
  5824. properties:
  5825. columns:
  5826. type: array
  5827. items:
  5828. type: object
  5829. properties:
  5830. autoNumberFormat:
  5831. type: object
  5832. properties:
  5833. value: {type: string, description: value}
  5834. description: autoNumberFormat
  5835. contactOptions:
  5836. type: array
  5837. items:
  5838. type: object
  5839. properties:
  5840. value: {type: string, description: value}
  5841. description: contactOptions
  5842. options:
  5843. type: array
  5844. items:
  5845. type: object
  5846. properties:
  5847. value: {type: string, description: value}
  5848. description: options
  5849. primary: {type: boolean, description: primary}
  5850. symbol: {type: string, description: symbol}
  5851. systemColumnType: {type: string, description: systemColumnType}
  5852. title: {type: string, description: title}
  5853. type: {type: string, description: type}
  5854. width: {type: number, format: float, description: width}
  5855. description: columns
  5856. name:
  5857. type: object
  5858. properties:
  5859. value: {type: string, description: value}
  5860. description: name
  5861. default:
  5862. columns:
  5863. - autoNumberFormat: {value: '<Error: Too many levels of nesting to fake
  5864. this schema>'}
  5865. contactOptions:
  5866. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5867. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5868. options:
  5869. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5870. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5871. primary: false
  5872. symbol: enim
  5873. systemColumnType: MODIFIED_BY
  5874. title: consequat voluptate Ut
  5875. type: MULTI_PICKLIST
  5876. width: -7874532.725726262
  5877. - autoNumberFormat: {value: '<Error: Too many levels of nesting to fake
  5878. this schema>'}
  5879. contactOptions:
  5880. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5881. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5882. options:
  5883. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5884. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  5885. primary: false
  5886. symbol: enim
  5887. systemColumnType: MODIFIED_BY
  5888. title: consequat voluptate Ut
  5889. type: MULTI_PICKLIST
  5890. width: -7874532.725726262
  5891. name: {value: 'reference #/components/schemas/Folder/properties/sheets/items/properties/name
  5892. not found in the OpenAPI spec'}
  5893. required: true
  5894. responses:
  5895. '200':
  5896. description: '200'
  5897. schema:
  5898. type: object
  5899. properties:
  5900. message: {type: string, description: message}
  5901. resultCode: {type: integer, format: int32, description: resultCode}
  5902. result:
  5903. type: object
  5904. properties:
  5905. accessLevel:
  5906. type: object
  5907. properties:
  5908. value: {type: string, description: value}
  5909. description: accessLevel
  5910. columns:
  5911. type: object
  5912. properties:
  5913. value: {type: string, description: value}
  5914. description: columns
  5915. id:
  5916. type: object
  5917. properties:
  5918. value: {type: string, description: value}
  5919. description: id
  5920. name:
  5921. type: object
  5922. properties:
  5923. value: {type: string, description: value}
  5924. description: name
  5925. permalink:
  5926. type: object
  5927. properties:
  5928. value: {type: string, description: value}
  5929. description: permalink
  5930. description: result
  5931. '500':
  5932. description: '500'
  5933. schema:
  5934. type: object
  5935. properties:
  5936. refId: {type: string, description: refId}
  5937. errorCode: {type: number, format: float, description: errorCode}
  5938. message: {type: string, description: message}
  5939. /sheets/import:
  5940. post:
  5941. summary: Import Sheet from CSV / XLSX
  5942. description: Import Sheet from CSV / XLSX
  5943. operationId: ImportSheetFromCsv_Xlsx
  5944. parameters:
  5945. - {name: sheetName, default: ex Excepteur laboris, in: query, type: string,
  5946. required: true}
  5947. - {name: headerRowIndex, default: '-4847524.674802229', in: query, type: string,
  5948. required: true}
  5949. - {name: primaryColumnIndex, default: '0', in: query, type: string, required: true}
  5950. - {name: Content-Disposition, in: header, required: true, type: string, default: attachment;
  5951. filename="ProgressReport.docx", description: Content-Disposition}
  5952. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  5953. description: Content-Type}
  5954. - {name: Accept, in: header, required: true, type: string, default: application/json,
  5955. description: Accept}
  5956. responses:
  5957. '200':
  5958. description: '200'
  5959. schema:
  5960. type: object
  5961. properties:
  5962. message: {type: string, description: message}
  5963. resultCode: {type: integer, format: int32, description: resultCode}
  5964. result:
  5965. type: object
  5966. properties:
  5967. accessLevel:
  5968. type: object
  5969. properties:
  5970. value: {type: string, description: value}
  5971. description: accessLevel
  5972. id:
  5973. type: object
  5974. properties:
  5975. value: {type: string, description: value}
  5976. description: id
  5977. name:
  5978. type: object
  5979. properties:
  5980. value: {type: string, description: value}
  5981. description: name
  5982. type: {type: string, description: type}
  5983. permalink:
  5984. type: object
  5985. properties:
  5986. value: {type: string, description: value}
  5987. description: permalink
  5988. description: result
  5989. '500':
  5990. description: '500'
  5991. schema:
  5992. type: object
  5993. properties:
  5994. refId: {type: string, description: refId}
  5995. errorCode: {type: number, format: float, description: errorCode}
  5996. message: {type: string, description: message}
  5997. /sights/{sightId}/publish:
  5998. get:
  5999. summary: Get Dashboard Publish Status
  6000. description: Get Dashboard Publish Status
  6001. operationId: GetDashboardPublishStatus
  6002. parameters:
  6003. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6004. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6005. description: Accept}
  6006. responses:
  6007. '200':
  6008. description: '200'
  6009. schema:
  6010. type: object
  6011. properties:
  6012. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  6013. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  6014. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  6015. '500':
  6016. description: '500'
  6017. schema:
  6018. type: object
  6019. properties:
  6020. refId: {type: string, description: refId}
  6021. errorCode: {type: number, format: float, description: errorCode}
  6022. message: {type: string, description: message}
  6023. put:
  6024. summary: Set Dashboard Publish Status
  6025. description: Set Dashboard Publish Status
  6026. operationId: SetDashboardPublishStatus
  6027. parameters:
  6028. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6029. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6030. description: Content-Type}
  6031. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6032. description: Accept}
  6033. - name: body
  6034. in: body
  6035. schema:
  6036. type: object
  6037. properties:
  6038. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  6039. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  6040. default: {readOnlyFullEnabled: false, readOnlyFullAccessibleBy: ALL}
  6041. required: true
  6042. responses:
  6043. '200':
  6044. description: '200'
  6045. schema:
  6046. type: object
  6047. properties:
  6048. message: {type: string, description: message}
  6049. resultCode: {type: integer, format: int32, description: resultCode}
  6050. result:
  6051. type: object
  6052. properties:
  6053. readOnlyFullEnabled: {type: boolean, description: readOnlyFullEnabled}
  6054. readOnlyFullAccessibleBy: {type: string, description: readOnlyFullAccessibleBy}
  6055. readOnlyFullUrl: {type: string, description: readOnlyFullUrl}
  6056. description: result
  6057. '500':
  6058. description: '500'
  6059. schema:
  6060. type: object
  6061. properties:
  6062. refId: {type: string, description: refId}
  6063. errorCode: {type: number, format: float, description: errorCode}
  6064. message: {type: string, description: message}
  6065. /sights/{sightId}/shares/{shareId}:
  6066. get:
  6067. summary: Get Dashboard Share
  6068. description: Get Dashboard Share
  6069. operationId: GetDashboardShare
  6070. parameters:
  6071. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6072. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6073. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6074. description: Accept}
  6075. responses:
  6076. '200':
  6077. description: '200'
  6078. schema:
  6079. type: object
  6080. properties:
  6081. id: {type: string, description: id}
  6082. groupId: {type: number, format: float, description: groupId}
  6083. userId: {type: number, format: float, description: userId}
  6084. type: {type: string, description: type}
  6085. accessLevel:
  6086. type: object
  6087. properties:
  6088. value: {type: string, description: value}
  6089. description: accessLevel
  6090. ccMe: {type: boolean, description: ccMe}
  6091. createdAt: {type: string, description: createdAt}
  6092. email: {type: string, description: email}
  6093. message: {type: string, description: message}
  6094. modifiedAt: {type: string, description: modifiedAt}
  6095. name: {type: string, description: name}
  6096. scope: {type: string, description: scope}
  6097. subject: {type: string, description: subject}
  6098. '500':
  6099. description: '500'
  6100. schema:
  6101. type: object
  6102. properties:
  6103. refId: {type: string, description: refId}
  6104. errorCode: {type: number, format: float, description: errorCode}
  6105. message: {type: string, description: message}
  6106. delete:
  6107. summary: Delete Dashboard Share
  6108. description: Delete Dashboard Share
  6109. operationId: DeleteDashboardShare
  6110. parameters:
  6111. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6112. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6113. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6114. description: Accept}
  6115. responses:
  6116. '200':
  6117. description: '200'
  6118. schema:
  6119. type: object
  6120. properties:
  6121. message: {type: string, description: message}
  6122. resultCode: {type: integer, format: int32, description: resultCode}
  6123. '500':
  6124. description: '500'
  6125. schema:
  6126. type: object
  6127. properties:
  6128. refId: {type: string, description: refId}
  6129. errorCode: {type: number, format: float, description: errorCode}
  6130. message: {type: string, description: message}
  6131. put:
  6132. summary: Update Dashboard Share
  6133. description: Update Dashboard Share
  6134. operationId: UpdateDashboardShare
  6135. parameters:
  6136. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6137. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6138. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6139. description: Content-Type}
  6140. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6141. description: Accept}
  6142. - name: body
  6143. in: body
  6144. schema:
  6145. type: object
  6146. properties:
  6147. id: {type: string, description: id}
  6148. groupId: {type: number, format: float, description: groupId}
  6149. userId: {type: number, format: float, description: userId}
  6150. type: {type: string, description: type}
  6151. accessLevel:
  6152. type: object
  6153. properties:
  6154. value: {type: string, description: value}
  6155. description: accessLevel
  6156. ccMe: {type: boolean, description: ccMe}
  6157. createdAt: {type: string, description: createdAt}
  6158. email: {type: string, description: email}
  6159. message: {type: string, description: message}
  6160. modifiedAt: {type: string, description: modifiedAt}
  6161. name: {type: string, description: name}
  6162. scope: {type: string, description: scope}
  6163. subject: {type: string, description: subject}
  6164. default:
  6165. id: mollit
  6166. groupId: 6458197.992068276
  6167. userId: 55638615.369980216
  6168. type: proident ex
  6169. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  6170. not found in the OpenAPI spec'}
  6171. ccMe: false
  6172. createdAt: <dateTime>
  6173. email: voluptate Duis minim Lorem
  6174. message: voluptate officia eiusmod qui
  6175. modifiedAt: <dateTime>
  6176. name: do in
  6177. scope: occaecat labore
  6178. subject: deserunt ut
  6179. required: true
  6180. responses:
  6181. '200':
  6182. description: '200'
  6183. schema:
  6184. type: object
  6185. properties:
  6186. message:
  6187. type: object
  6188. properties:
  6189. value: {type: string, description: value}
  6190. description: message
  6191. resultCode:
  6192. type: object
  6193. properties:
  6194. value: {type: string, description: value}
  6195. description: resultCode
  6196. result:
  6197. type: object
  6198. properties: {}
  6199. description: result
  6200. '500':
  6201. description: '500'
  6202. schema:
  6203. type: object
  6204. properties:
  6205. refId: {type: string, description: refId}
  6206. errorCode: {type: number, format: float, description: errorCode}
  6207. message: {type: string, description: message}
  6208. /sights/{sightId}/shares:
  6209. get:
  6210. summary: List Dashboard Shares
  6211. description: List Dashboard Shares
  6212. operationId: ListDashboardShares
  6213. parameters:
  6214. - {name: sharingInclude, default: ITEM, in: query, type: string, required: true}
  6215. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  6216. - {name: page, default: '1', in: query, type: string, required: true}
  6217. - {name: pageSize, default: '100', in: query, type: string, required: true}
  6218. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6219. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6220. description: Accept}
  6221. responses:
  6222. '200':
  6223. description: '200'
  6224. schema:
  6225. type: object
  6226. properties:
  6227. pageNumber: {type: integer, format: int32, description: pageNumber}
  6228. pageSize: {type: integer, format: int32, description: pageSize}
  6229. totalPages: {type: integer, format: int32, description: totalPages}
  6230. totalCount: {type: integer, format: int32, description: totalCount}
  6231. result:
  6232. type: array
  6233. items:
  6234. type: object
  6235. properties:
  6236. id:
  6237. type: object
  6238. properties:
  6239. value: {type: string, description: value}
  6240. description: id
  6241. groupId:
  6242. type: object
  6243. properties:
  6244. value: {type: string, description: value}
  6245. description: groupId
  6246. userId:
  6247. type: object
  6248. properties:
  6249. value: {type: string, description: value}
  6250. description: userId
  6251. type:
  6252. type: object
  6253. properties:
  6254. value: {type: string, description: value}
  6255. description: type
  6256. accessLevel:
  6257. type: object
  6258. properties:
  6259. value: {type: string, description: value}
  6260. description: accessLevel
  6261. ccMe:
  6262. type: object
  6263. properties:
  6264. value: {type: string, description: value}
  6265. description: ccMe
  6266. createdAt:
  6267. type: object
  6268. properties:
  6269. value: {type: string, description: value}
  6270. description: createdAt
  6271. email:
  6272. type: object
  6273. properties:
  6274. value: {type: string, description: value}
  6275. description: email
  6276. message:
  6277. type: object
  6278. properties:
  6279. value: {type: string, description: value}
  6280. description: message
  6281. modifiedAt:
  6282. type: object
  6283. properties:
  6284. value: {type: string, description: value}
  6285. description: modifiedAt
  6286. name:
  6287. type: object
  6288. properties:
  6289. value: {type: string, description: value}
  6290. description: name
  6291. scope:
  6292. type: object
  6293. properties:
  6294. value: {type: string, description: value}
  6295. description: scope
  6296. subject:
  6297. type: object
  6298. properties:
  6299. value: {type: string, description: value}
  6300. description: subject
  6301. description: result
  6302. '500':
  6303. description: '500'
  6304. schema:
  6305. type: object
  6306. properties:
  6307. refId: {type: string, description: refId}
  6308. errorCode: {type: number, format: float, description: errorCode}
  6309. message: {type: string, description: message}
  6310. post:
  6311. summary: Share Dashboard
  6312. description: Share Dashboard
  6313. operationId: ShareDashboard
  6314. parameters:
  6315. - {name: sendEmail, default: 'false', in: query, type: string, required: true}
  6316. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6317. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6318. description: Content-Type}
  6319. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6320. description: Accept}
  6321. - name: body
  6322. in: body
  6323. schema:
  6324. type: object
  6325. properties:
  6326. id: {type: string, description: id}
  6327. groupId: {type: number, format: float, description: groupId}
  6328. userId: {type: number, format: float, description: userId}
  6329. type: {type: string, description: type}
  6330. accessLevel:
  6331. type: object
  6332. properties:
  6333. value: {type: string, description: value}
  6334. description: accessLevel
  6335. ccMe: {type: boolean, description: ccMe}
  6336. createdAt: {type: string, description: createdAt}
  6337. email: {type: string, description: email}
  6338. message: {type: string, description: message}
  6339. modifiedAt: {type: string, description: modifiedAt}
  6340. name: {type: string, description: name}
  6341. scope: {type: string, description: scope}
  6342. subject: {type: string, description: subject}
  6343. default:
  6344. id: mollit
  6345. groupId: 6458197.992068276
  6346. userId: 55638615.369980216
  6347. type: proident ex
  6348. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  6349. not found in the OpenAPI spec'}
  6350. ccMe: false
  6351. createdAt: <dateTime>
  6352. email: voluptate Duis minim Lorem
  6353. message: voluptate officia eiusmod qui
  6354. modifiedAt: <dateTime>
  6355. name: do in
  6356. scope: occaecat labore
  6357. subject: deserunt ut
  6358. required: true
  6359. responses:
  6360. '200':
  6361. description: '200'
  6362. schema:
  6363. type: object
  6364. properties:
  6365. message: {type: string, description: message}
  6366. resultCode: {type: integer, format: int32, description: resultCode}
  6367. result:
  6368. type: object
  6369. properties:
  6370. id:
  6371. type: object
  6372. properties:
  6373. value: {type: string, description: value}
  6374. description: id
  6375. groupId:
  6376. type: object
  6377. properties:
  6378. value: {type: string, description: value}
  6379. description: groupId
  6380. userId:
  6381. type: object
  6382. properties:
  6383. value: {type: string, description: value}
  6384. description: userId
  6385. type:
  6386. type: object
  6387. properties:
  6388. value: {type: string, description: value}
  6389. description: type
  6390. accessLevel:
  6391. type: object
  6392. properties:
  6393. value: {type: string, description: value}
  6394. description: accessLevel
  6395. ccMe:
  6396. type: object
  6397. properties:
  6398. value: {type: string, description: value}
  6399. description: ccMe
  6400. createdAt:
  6401. type: object
  6402. properties:
  6403. value: {type: string, description: value}
  6404. description: createdAt
  6405. email:
  6406. type: object
  6407. properties:
  6408. value: {type: string, description: value}
  6409. description: email
  6410. message:
  6411. type: object
  6412. properties:
  6413. value: {type: string, description: value}
  6414. description: message
  6415. modifiedAt:
  6416. type: object
  6417. properties:
  6418. value: {type: string, description: value}
  6419. description: modifiedAt
  6420. name:
  6421. type: object
  6422. properties:
  6423. value: {type: string, description: value}
  6424. description: name
  6425. scope:
  6426. type: object
  6427. properties:
  6428. value: {type: string, description: value}
  6429. description: scope
  6430. subject:
  6431. type: object
  6432. properties:
  6433. value: {type: string, description: value}
  6434. description: subject
  6435. description: result
  6436. '400':
  6437. description: '400'
  6438. schema:
  6439. type: object
  6440. properties:
  6441. refId: {type: string, description: refId}
  6442. errorCode: {type: number, format: float, description: errorCode}
  6443. message: {type: string, description: message}
  6444. '500':
  6445. description: '500'
  6446. schema:
  6447. type: object
  6448. properties:
  6449. refId: {type: string, description: refId}
  6450. errorCode: {type: number, format: float, description: errorCode}
  6451. message: {type: string, description: message}
  6452. /sights/{sightId}:
  6453. get:
  6454. summary: Get Dashboard
  6455. description: Get Dashboard
  6456. operationId: GetDashboard
  6457. parameters:
  6458. - {name: include, default: source, in: query, type: string, required: true}
  6459. - {name: level, default: '0', in: query, type: string, required: true}
  6460. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  6461. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6462. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6463. description: Accept}
  6464. responses:
  6465. '200':
  6466. description: '200'
  6467. schema:
  6468. type: object
  6469. properties:
  6470. value: {type: string, description: value}
  6471. '500':
  6472. description: '500'
  6473. schema:
  6474. type: object
  6475. properties: {}
  6476. delete:
  6477. summary: Delete Dashboard
  6478. description: Delete Dashboard
  6479. operationId: DeleteDashboard
  6480. parameters:
  6481. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6482. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6483. description: Accept}
  6484. responses:
  6485. '200':
  6486. description: '200'
  6487. schema:
  6488. type: object
  6489. properties:
  6490. message: {type: string, description: message}
  6491. resultCode: {type: integer, format: int32, description: resultCode}
  6492. '500':
  6493. description: '500'
  6494. schema:
  6495. type: object
  6496. properties: {}
  6497. put:
  6498. summary: Update Dashboard
  6499. description: Update Dashboard
  6500. operationId: UpdateDashboard
  6501. parameters:
  6502. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  6503. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6504. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6505. description: Content-Type}
  6506. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6507. description: Accept}
  6508. - name: body
  6509. in: body
  6510. schema:
  6511. type: object
  6512. properties:
  6513. name: {type: string, description: name}
  6514. default: {name: adipisicing dolor sunt sed fugiat}
  6515. required: true
  6516. responses:
  6517. '200':
  6518. description: '200'
  6519. schema:
  6520. type: object
  6521. properties:
  6522. message: {type: string, description: message}
  6523. resultCode: {type: integer, format: int32, description: resultCode}
  6524. result:
  6525. type: object
  6526. properties:
  6527. value: {type: string, description: value}
  6528. description: result
  6529. '500':
  6530. description: '500'
  6531. schema:
  6532. type: object
  6533. properties: {}
  6534. /sights/{sightId}/copy:
  6535. post:
  6536. summary: Copy Dashboard
  6537. description: Copy Dashboard
  6538. operationId: CopyDashboard
  6539. parameters:
  6540. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6541. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6542. description: Content-Type}
  6543. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6544. description: Accept}
  6545. - name: body
  6546. in: body
  6547. schema:
  6548. type: object
  6549. properties:
  6550. destinationId: {type: number, format: float, description: destinationId}
  6551. destinationType: {type: string, description: destinationType}
  6552. newName: {type: string, description: newName}
  6553. default: {destinationId: 80073746.07746986, destinationType: workspace,
  6554. newName: in eu}
  6555. required: true
  6556. responses:
  6557. '200':
  6558. description: '200'
  6559. schema:
  6560. type: object
  6561. properties:
  6562. message: {type: string, description: message}
  6563. resultCode: {type: integer, format: int32, description: resultCode}
  6564. result:
  6565. type: object
  6566. properties:
  6567. name: {type: string, description: name}
  6568. description: result
  6569. '500':
  6570. description: '500'
  6571. schema:
  6572. type: object
  6573. properties:
  6574. refId: {type: string, description: refId}
  6575. errorCode: {type: number, format: float, description: errorCode}
  6576. message: {type: string, description: message}
  6577. /sights/{sightId}/move:
  6578. post:
  6579. summary: Move Dashboard
  6580. description: Move Dashboard
  6581. operationId: MoveDashboard
  6582. parameters:
  6583. - {name: sightId, default: ex Excepteur laboris, in: path, type: string, required: true}
  6584. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6585. description: Content-Type}
  6586. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6587. description: Accept}
  6588. - name: body
  6589. in: body
  6590. schema:
  6591. type: object
  6592. properties:
  6593. destinationId: {type: number, format: float, description: destinationId}
  6594. destinationType: {type: string, description: destinationType}
  6595. newName: {type: string, description: newName}
  6596. default: {destinationId: 80073746.07746986, destinationType: workspace,
  6597. newName: in eu}
  6598. required: true
  6599. responses:
  6600. '200':
  6601. description: '200'
  6602. schema:
  6603. type: object
  6604. properties:
  6605. message: {type: string, description: message}
  6606. resultCode: {type: integer, format: int32, description: resultCode}
  6607. result:
  6608. type: object
  6609. properties:
  6610. name: {type: string, description: name}
  6611. description: result
  6612. '500':
  6613. description: '500'
  6614. schema:
  6615. type: object
  6616. properties:
  6617. refId: {type: string, description: refId}
  6618. errorCode: {type: number, format: float, description: errorCode}
  6619. message: {type: string, description: message}
  6620. /sights:
  6621. get:
  6622. summary: List Dashboards
  6623. description: List Dashboards
  6624. operationId: ListDashboards
  6625. parameters:
  6626. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  6627. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  6628. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  6629. - {name: page, default: '1', in: query, type: string, required: true}
  6630. - {name: pageSize, default: '100', in: query, type: string, required: true}
  6631. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6632. description: Accept}
  6633. responses:
  6634. '200':
  6635. description: '200'
  6636. schema:
  6637. type: object
  6638. properties:
  6639. pageNumber: {type: integer, format: int32, description: pageNumber}
  6640. pageSize: {type: integer, format: int32, description: pageSize}
  6641. totalPages: {type: integer, format: int32, description: totalPages}
  6642. totalCount: {type: integer, format: int32, description: totalCount}
  6643. data:
  6644. type: array
  6645. items:
  6646. type: object
  6647. properties:
  6648. name:
  6649. type: object
  6650. properties:
  6651. value: {type: string, description: value}
  6652. description: name
  6653. description: data
  6654. '500':
  6655. description: '500'
  6656. schema:
  6657. type: object
  6658. properties:
  6659. refId: {type: string, description: refId}
  6660. errorCode: {type: number, format: float, description: errorCode}
  6661. message: {type: string, description: message}
  6662. /templates:
  6663. get:
  6664. summary: List User-Created Templates
  6665. description: List User-Created Templates
  6666. operationId: ListUser-createdTemplates
  6667. parameters:
  6668. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  6669. - {name: page, default: '1', in: query, type: string, required: true}
  6670. - {name: pageSize, default: '100', in: query, type: string, required: true}
  6671. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6672. description: Accept}
  6673. responses:
  6674. '200':
  6675. description: '200'
  6676. schema:
  6677. type: object
  6678. properties:
  6679. pageNumber: {type: integer, format: int32, description: pageNumber}
  6680. pageSize: {type: integer, format: int32, description: pageSize}
  6681. totalPages: {type: integer, format: int32, description: totalPages}
  6682. totalCount: {type: integer, format: int32, description: totalCount}
  6683. data:
  6684. type: array
  6685. items:
  6686. type: object
  6687. properties:
  6688. value: {type: string, description: value}
  6689. description: data
  6690. /templates/public:
  6691. get:
  6692. summary: List Public Templates
  6693. description: List Public Templates
  6694. operationId: ListPublicTemplates
  6695. parameters:
  6696. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  6697. - {name: level, default: '0', in: query, type: string, required: true}
  6698. - {name: page, default: '1', in: query, type: string, required: true}
  6699. - {name: pageSize, default: '100', in: query, type: string, required: true}
  6700. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6701. description: Accept}
  6702. responses:
  6703. '200':
  6704. description: '200'
  6705. schema:
  6706. type: object
  6707. properties:
  6708. pageNumber: {type: integer, format: int32, description: pageNumber}
  6709. pageSize: {type: integer, format: int32, description: pageSize}
  6710. totalPages: {type: integer, format: int32, description: totalPages}
  6711. totalCount: {type: integer, format: int32, description: totalCount}
  6712. data:
  6713. type: array
  6714. items:
  6715. type: object
  6716. properties:
  6717. value: {type: string, description: value}
  6718. description: data
  6719. /token:
  6720. delete:
  6721. summary: Revoke Access Token
  6722. description: Revoke Access Token
  6723. operationId: RevokeAccessToken
  6724. parameters:
  6725. - {name: deleteAllForApiClient, default: 'false', in: query, type: string, required: true}
  6726. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6727. description: Accept}
  6728. responses:
  6729. '200':
  6730. description: '200'
  6731. schema:
  6732. type: object
  6733. properties:
  6734. message: {type: string, description: message}
  6735. resultCode: {type: integer, format: int32, description: resultCode}
  6736. '500':
  6737. description: '500'
  6738. schema:
  6739. type: object
  6740. properties:
  6741. refId: {type: string, description: refId}
  6742. errorCode: {type: number, format: float, description: errorCode}
  6743. message: {type: string, description: message}
  6744. post:
  6745. summary: Gets or Refreshes an Access Token
  6746. description: Gets or Refreshes an Access Token
  6747. operationId: GetsOrRefreshesAnAccessToken
  6748. parameters:
  6749. - {name: client_id, default: ex Excepteur laboris, in: query, type: string,
  6750. required: true}
  6751. - {name: client_secret, default: ex Excepteur laboris, in: query, type: string,
  6752. required: true}
  6753. - {name: code, default: ex Excepteur laboris, in: query, type: string, required: true}
  6754. - {name: grant_type, default: authorization_code, in: query, type: string, required: true}
  6755. - {name: hash, default: ex Excepteur laboris, in: query, type: string, required: true}
  6756. - {name: refresh_token, default: ex Excepteur laboris, in: query, type: string,
  6757. required: true}
  6758. - {name: redirect_url, default: ex Excepteur laboris, in: query, type: string,
  6759. required: true}
  6760. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6761. description: Accept}
  6762. responses:
  6763. '200':
  6764. description: '200'
  6765. schema:
  6766. type: object
  6767. properties:
  6768. access_token: {type: string, description: access_token}
  6769. token_type: {type: string, description: token_type}
  6770. expires_in: {type: integer, format: int32, description: expires_in}
  6771. refresh_token: {type: string, description: refresh_token}
  6772. '500':
  6773. description: '500'
  6774. schema:
  6775. type: object
  6776. properties:
  6777. refId: {type: string, description: refId}
  6778. errorCode: {type: number, format: float, description: errorCode}
  6779. message: {type: string, description: message}
  6780. /users/{userId}/alternateemails/{alternateEmailId}:
  6781. get:
  6782. summary: Get Alternate Email
  6783. description: Get Alternate Email
  6784. operationId: GetAlternateEmail
  6785. parameters:
  6786. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6787. - {name: alternateEmailId, default: '-4847524.674802229', in: path, type: string,
  6788. required: true}
  6789. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6790. description: Accept}
  6791. responses:
  6792. '200':
  6793. description: '200'
  6794. schema:
  6795. type: object
  6796. properties:
  6797. value: {type: string, description: value}
  6798. '500':
  6799. description: '500'
  6800. schema:
  6801. type: object
  6802. properties:
  6803. refId: {type: string, description: refId}
  6804. errorCode: {type: number, format: float, description: errorCode}
  6805. message: {type: string, description: message}
  6806. delete:
  6807. summary: Delete Alternate Email
  6808. description: Delete Alternate Email
  6809. operationId: DeleteAlternateEmail
  6810. parameters:
  6811. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6812. - {name: alternateEmailId, default: '-4847524.674802229', in: path, type: string,
  6813. required: true}
  6814. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6815. description: Accept}
  6816. responses:
  6817. '200':
  6818. description: '200'
  6819. schema:
  6820. type: object
  6821. properties:
  6822. message: {type: string, description: message}
  6823. resultCode: {type: integer, format: int32, description: resultCode}
  6824. '500':
  6825. description: '500'
  6826. schema:
  6827. type: object
  6828. properties:
  6829. refId: {type: string, description: refId}
  6830. errorCode: {type: number, format: float, description: errorCode}
  6831. message: {type: string, description: message}
  6832. /users/{userId}/alternateemails/{alternateEmailId}/makeprimary:
  6833. post:
  6834. summary: Make Alternate Email Primary
  6835. description: Make Alternate Email Primary
  6836. operationId: MakeAlternateEmailPrimary
  6837. parameters:
  6838. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6839. - {name: alternateEmailId, default: '-4847524.674802229', in: path, type: string,
  6840. required: true}
  6841. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6842. description: Accept}
  6843. responses:
  6844. '200':
  6845. description: '200'
  6846. schema:
  6847. type: object
  6848. properties:
  6849. message: {type: string, description: message}
  6850. resultCode: {type: integer, format: int32, description: resultCode}
  6851. data:
  6852. type: array
  6853. items:
  6854. type: object
  6855. properties:
  6856. value: {type: string, description: value}
  6857. description: data
  6858. '500':
  6859. description: '500'
  6860. schema:
  6861. type: object
  6862. properties:
  6863. refId: {type: string, description: refId}
  6864. errorCode: {type: number, format: float, description: errorCode}
  6865. message: {type: string, description: message}
  6866. /users/{userId}/alternateemails:
  6867. get:
  6868. summary: List Alternate Emails
  6869. description: List Alternate Emails
  6870. operationId: ListAlternateEmails
  6871. parameters:
  6872. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6873. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6874. description: Accept}
  6875. responses:
  6876. '200':
  6877. description: '200'
  6878. schema:
  6879. type: object
  6880. properties:
  6881. pageNumber: {type: integer, format: int32, description: pageNumber}
  6882. pageSize: {type: integer, format: int32, description: pageSize}
  6883. totalPages: {type: integer, format: int32, description: totalPages}
  6884. totalCount: {type: integer, format: int32, description: totalCount}
  6885. data:
  6886. type: array
  6887. items:
  6888. type: object
  6889. properties:
  6890. value: {type: string, description: value}
  6891. description: data
  6892. '500':
  6893. description: '500'
  6894. schema:
  6895. type: object
  6896. properties:
  6897. refId: {type: string, description: refId}
  6898. errorCode: {type: number, format: float, description: errorCode}
  6899. message: {type: string, description: message}
  6900. post:
  6901. summary: Add Alternate Emails
  6902. description: Add Alternate Emails
  6903. operationId: AddAlternateEmails
  6904. parameters:
  6905. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6906. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  6907. description: Content-Type}
  6908. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6909. description: Accept}
  6910. - name: body
  6911. in: body
  6912. schema:
  6913. type: object
  6914. properties:
  6915. email: {type: string, description: email}
  6916. default: {email: [email protected]}
  6917. required: true
  6918. responses:
  6919. '200':
  6920. description: '200'
  6921. schema:
  6922. type: object
  6923. properties:
  6924. message: {type: string, description: message}
  6925. resultCode: {type: integer, format: int32, description: resultCode}
  6926. data:
  6927. type: array
  6928. items:
  6929. type: object
  6930. properties:
  6931. value: {type: string, description: value}
  6932. description: data
  6933. '500':
  6934. description: '500'
  6935. schema:
  6936. type: object
  6937. properties:
  6938. refId: {type: string, description: refId}
  6939. errorCode: {type: number, format: float, description: errorCode}
  6940. message: {type: string, description: message}
  6941. /users/{userId}:
  6942. get:
  6943. summary: Get User
  6944. description: Get User
  6945. operationId: GetUser
  6946. parameters:
  6947. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  6948. - {name: Accept, in: header, required: true, type: string, default: application/json,
  6949. description: Accept}
  6950. responses:
  6951. '200':
  6952. description: '200'
  6953. schema:
  6954. type: object
  6955. properties:
  6956. id: {type: integer, format: int32, description: id}
  6957. account:
  6958. type: object
  6959. properties:
  6960. value: {type: string, description: value}
  6961. description: account
  6962. admin: {type: boolean, description: admin}
  6963. alternateEmails:
  6964. type: object
  6965. properties:
  6966. value: {type: string, description: value}
  6967. description: alternateEmails
  6968. company: {type: string, description: company}
  6969. customWelcomeScreenViewed: {type: string, description: customWelcomeScreenViewed}
  6970. department: {type: string, description: department}
  6971. email: {type: string, description: email}
  6972. firstName: {type: string, description: firstName}
  6973. groupAdmin: {type: boolean, description: groupAdmin}
  6974. jiraAdmin: {type: boolean, description: jiraAdmin}
  6975. lastLogin: {type: string, description: lastLogin}
  6976. lastName: {type: string, description: lastName}
  6977. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  6978. locale: {type: string, description: locale}
  6979. mobilePhone: {type: string, description: mobilePhone}
  6980. profileImage:
  6981. type: object
  6982. properties:
  6983. value: {type: string, description: value}
  6984. description: profileImage
  6985. resourceViewer: {type: boolean, description: resourceViewer}
  6986. role: {type: string, description: role}
  6987. salesforceAdmin: {type: boolean, description: salesforceAdmin}
  6988. salesforceUser: {type: boolean, description: salesforceUser}
  6989. sheetCount: {type: integer, format: int32, description: sheetCount}
  6990. timeZone: {type: string, description: timeZone}
  6991. title: {type: string, description: title}
  6992. workPhone: {type: string, description: workPhone}
  6993. '500':
  6994. description: '500'
  6995. schema:
  6996. type: object
  6997. properties:
  6998. refId: {type: string, description: refId}
  6999. errorCode: {type: number, format: float, description: errorCode}
  7000. message: {type: string, description: message}
  7001. delete:
  7002. summary: Remove User
  7003. description: Remove User
  7004. operationId: RemoveUser
  7005. parameters:
  7006. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  7007. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7008. description: Content-Type}
  7009. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7010. description: Accept}
  7011. - name: body
  7012. in: body
  7013. schema:
  7014. type: object
  7015. properties:
  7016. removeFromSharing: {type: boolean, description: removeFromSharing}
  7017. transferSheets: {type: boolean, description: transferSheets}
  7018. transferTo: {type: integer, format: int32, description: transferTo}
  7019. default: {removeFromSharing: true, transferSheets: true, transferTo: 94094820842}
  7020. required: true
  7021. responses:
  7022. '200':
  7023. description: '200'
  7024. schema:
  7025. type: object
  7026. properties:
  7027. message: {type: string, description: message}
  7028. resultCode: {type: integer, format: int32, description: resultCode}
  7029. '500':
  7030. description: '500'
  7031. schema:
  7032. type: object
  7033. properties:
  7034. refId: {type: string, description: refId}
  7035. errorCode: {type: number, format: float, description: errorCode}
  7036. message: {type: string, description: message}
  7037. put:
  7038. summary: Update User
  7039. description: Update User
  7040. operationId: UpdateUser
  7041. parameters:
  7042. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  7043. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7044. description: Content-Type}
  7045. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7046. description: Accept}
  7047. - name: body
  7048. in: body
  7049. schema:
  7050. type: object
  7051. properties:
  7052. admin: {type: boolean, description: admin}
  7053. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  7054. firstName: {type: string, description: firstName}
  7055. lastName: {type: string, description: lastName}
  7056. groupAdmin: {type: boolean, description: groupAdmin}
  7057. resourceViewer: {type: boolean, description: resourceViewer}
  7058. default: {admin: true, licensedSheetCreator: true, firstName: Jane, lastName: Doe,
  7059. groupAdmin: true, resourceViewer: true}
  7060. required: true
  7061. responses:
  7062. '200':
  7063. description: '200'
  7064. schema:
  7065. type: object
  7066. properties:
  7067. message: {type: string, description: message}
  7068. resultCode: {type: integer, format: int32, description: resultCode}
  7069. data:
  7070. type: array
  7071. items:
  7072. type: object
  7073. properties:
  7074. email: {type: string, description: email}
  7075. name: {type: string, description: name}
  7076. firstName: {type: string, description: firstName}
  7077. lastName: {type: string, description: lastName}
  7078. profileImage:
  7079. type: object
  7080. properties:
  7081. value: {type: string, description: value}
  7082. description: profileImage
  7083. id: {type: integer, format: int32, description: id}
  7084. description: data
  7085. '500':
  7086. description: '500'
  7087. schema:
  7088. type: object
  7089. properties:
  7090. refId: {type: string, description: refId}
  7091. errorCode: {type: number, format: float, description: errorCode}
  7092. message: {type: string, description: message}
  7093. /users/{userId}/profileimage:
  7094. post:
  7095. summary: Update User Profile Image
  7096. description: Update User Profile Image
  7097. operationId: UpdateUserProfileImage
  7098. parameters:
  7099. - {name: userId, default: '-4847524.674802229', in: path, type: string, required: true}
  7100. - {name: Content-Type, in: header, required: true, type: string, default: multipart/form-data,
  7101. description: Content-Type}
  7102. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7103. description: Accept}
  7104. responses:
  7105. '200':
  7106. description: '200'
  7107. schema:
  7108. type: object
  7109. properties:
  7110. message: {type: string, description: message}
  7111. resultCode: {type: integer, format: int32, description: resultCode}
  7112. data:
  7113. type: array
  7114. items:
  7115. type: object
  7116. properties:
  7117. email: {type: string, description: email}
  7118. name: {type: string, description: name}
  7119. firstName: {type: string, description: firstName}
  7120. lastName: {type: string, description: lastName}
  7121. profileImage:
  7122. type: object
  7123. properties:
  7124. value: {type: string, description: value}
  7125. description: profileImage
  7126. id: {type: integer, format: int32, description: id}
  7127. description: data
  7128. '500':
  7129. description: '500'
  7130. schema:
  7131. type: object
  7132. properties:
  7133. refId: {type: string, description: refId}
  7134. errorCode: {type: number, format: float, description: errorCode}
  7135. message: {type: string, description: message}
  7136. /users:
  7137. get:
  7138. summary: List Users
  7139. description: List Users
  7140. operationId: ListUsers
  7141. parameters:
  7142. - {name: email, default: ex Excepteur laboris, in: query, type: string, required: true}
  7143. - {name: include, default: ex Excepteur laboris, in: query, type: string, required: true}
  7144. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  7145. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  7146. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  7147. - {name: page, default: '1', in: query, type: string, required: true}
  7148. - {name: pageSize, default: '100', in: query, type: string, required: true}
  7149. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7150. description: Accept}
  7151. responses:
  7152. '200':
  7153. description: '200'
  7154. schema:
  7155. type: object
  7156. properties:
  7157. pageNumber: {type: integer, format: int32, description: pageNumber}
  7158. pageSize: {type: integer, format: int32, description: pageSize}
  7159. totalPages: {type: integer, format: int32, description: totalPages}
  7160. totalCount: {type: integer, format: int32, description: totalCount}
  7161. data:
  7162. type: array
  7163. items:
  7164. type: object
  7165. properties:
  7166. id: {type: integer, format: int32, description: id}
  7167. admin: {type: boolean, description: admin}
  7168. customWelcomeScreenViewed: {type: string, description: customWelcomeScreenViewed}
  7169. email: {type: string, description: email}
  7170. firstName: {type: string, description: firstName}
  7171. groupAdmin: {type: boolean, description: groupAdmin}
  7172. lastLogin: {type: string, description: lastLogin}
  7173. lastName: {type: string, description: lastName}
  7174. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  7175. name: {type: string, description: name}
  7176. profileImage:
  7177. type: object
  7178. properties:
  7179. value: {type: string, description: value}
  7180. description: profileImage
  7181. resourceViewer: {type: boolean, description: resourceViewer}
  7182. sheetCount: {type: integer, format: int32, description: sheetCount}
  7183. status: {type: string, description: status}
  7184. description: data
  7185. '500':
  7186. description: '500'
  7187. schema:
  7188. type: object
  7189. properties:
  7190. refId: {type: string, description: refId}
  7191. errorCode: {type: number, format: float, description: errorCode}
  7192. message: {type: string, description: message}
  7193. post:
  7194. summary: Add User
  7195. description: Add User
  7196. operationId: AddUser
  7197. parameters:
  7198. - {name: sendEmail, default: 'false', in: query, type: string, required: true}
  7199. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7200. description: Content-Type}
  7201. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7202. description: Accept}
  7203. - name: body
  7204. in: body
  7205. schema:
  7206. type: object
  7207. properties:
  7208. admin: {type: boolean, description: admin}
  7209. email: {type: string, description: email}
  7210. firstName: {type: string, description: firstName}
  7211. groupAdmin: {type: boolean, description: groupAdmin}
  7212. lastName: {type: string, description: lastName}
  7213. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  7214. profileImage:
  7215. type: object
  7216. properties:
  7217. value: {type: string, description: value}
  7218. description: profileImage
  7219. resourceViewer: {type: boolean, description: resourceViewer}
  7220. status: {type: string, description: status}
  7221. default:
  7222. admin: true
  7223. email: [email protected]
  7224. firstName: Jane
  7225. groupAdmin: true
  7226. lastName: Doe
  7227. licensedSheetCreator: true
  7228. profileImage: {value: 'reference #/components/schemas/User/properties/profileImage
  7229. not found in the OpenAPI spec'}
  7230. resourceViewer: true
  7231. status: ACTIVE
  7232. required: true
  7233. responses:
  7234. '200':
  7235. description: '200'
  7236. schema:
  7237. type: object
  7238. properties:
  7239. message: {type: string, description: message}
  7240. resultCode: {type: integer, format: int32, description: resultCode}
  7241. result:
  7242. type: object
  7243. properties:
  7244. id: {type: integer, format: int32, description: id}
  7245. admin: {type: boolean, description: admin}
  7246. customWelcomeScreenViewed: {type: string, description: customWelcomeScreenViewed}
  7247. email: {type: string, description: email}
  7248. firstName: {type: string, description: firstName}
  7249. groupAdmin: {type: boolean, description: groupAdmin}
  7250. lastLogin: {type: string, description: lastLogin}
  7251. lastName: {type: string, description: lastName}
  7252. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  7253. name: {type: string, description: name}
  7254. profileImage:
  7255. type: object
  7256. properties:
  7257. value: {type: string, description: value}
  7258. description: profileImage
  7259. resourceViewer: {type: boolean, description: resourceViewer}
  7260. sheetCount: {type: integer, format: int32, description: sheetCount}
  7261. status: {type: string, description: status}
  7262. description: result
  7263. '500':
  7264. description: '500'
  7265. schema:
  7266. type: object
  7267. properties:
  7268. refId: {type: string, description: refId}
  7269. errorCode: {type: number, format: float, description: errorCode}
  7270. message: {type: string, description: message}
  7271. /users/me:
  7272. get:
  7273. summary: Get Current User
  7274. description: Get Current User
  7275. operationId: GetCurrentUser
  7276. parameters:
  7277. - {name: include, default: groups, in: query, type: string, required: true}
  7278. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7279. description: Accept}
  7280. responses:
  7281. '200':
  7282. description: '200'
  7283. schema:
  7284. type: object
  7285. properties:
  7286. id: {type: integer, format: int32, description: id}
  7287. account:
  7288. type: object
  7289. properties:
  7290. value: {type: string, description: value}
  7291. description: account
  7292. admin: {type: boolean, description: admin}
  7293. alternateEmails:
  7294. type: object
  7295. properties:
  7296. value: {type: string, description: value}
  7297. description: alternateEmails
  7298. company: {type: string, description: company}
  7299. customWelcomeScreenViewed: {type: string, description: customWelcomeScreenViewed}
  7300. department: {type: string, description: department}
  7301. email: {type: string, description: email}
  7302. firstName: {type: string, description: firstName}
  7303. groupAdmin: {type: boolean, description: groupAdmin}
  7304. jiraAdmin: {type: boolean, description: jiraAdmin}
  7305. lastLogin: {type: string, description: lastLogin}
  7306. lastName: {type: string, description: lastName}
  7307. licensedSheetCreator: {type: boolean, description: licensedSheetCreator}
  7308. locale: {type: string, description: locale}
  7309. mobilePhone: {type: string, description: mobilePhone}
  7310. profileImage:
  7311. type: object
  7312. properties:
  7313. value: {type: string, description: value}
  7314. description: profileImage
  7315. resourceViewer: {type: boolean, description: resourceViewer}
  7316. role: {type: string, description: role}
  7317. salesforceAdmin: {type: boolean, description: salesforceAdmin}
  7318. salesforceUser: {type: boolean, description: salesforceUser}
  7319. sheetCount: {type: integer, format: int32, description: sheetCount}
  7320. timeZone: {type: string, description: timeZone}
  7321. title: {type: string, description: title}
  7322. workPhone: {type: string, description: workPhone}
  7323. data:
  7324. type: array
  7325. items:
  7326. type: object
  7327. properties:
  7328. id: {type: integer, format: int32, description: id}
  7329. name: {type: string, description: name}
  7330. description: {type: string, description: description}
  7331. owner: {type: string, description: owner}
  7332. ownerId: {type: integer, format: int32, description: ownerId}
  7333. createdAt:
  7334. type: object
  7335. properties:
  7336. value: {type: string, description: value}
  7337. description: createdAt
  7338. modifiedAt:
  7339. type: object
  7340. properties:
  7341. value: {type: string, description: value}
  7342. description: modifiedAt
  7343. description: data
  7344. '500':
  7345. description: '500'
  7346. schema:
  7347. type: object
  7348. properties:
  7349. refId: {type: string, description: refId}
  7350. errorCode: {type: number, format: float, description: errorCode}
  7351. message: {type: string, description: message}
  7352. /users/sheets:
  7353. get:
  7354. summary: List Org Sheets
  7355. description: List Org Sheets
  7356. operationId: ListOrgSheets
  7357. parameters:
  7358. - {name: modifiedSince, default: <dateTime>, in: query, type: string, required: true}
  7359. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7360. description: Accept}
  7361. responses:
  7362. '200':
  7363. description: '200'
  7364. schema:
  7365. type: object
  7366. properties:
  7367. pageNumber: {type: integer, format: int32, description: pageNumber}
  7368. pageSize: {type: integer, format: int32, description: pageSize}
  7369. totalPages: {type: integer, format: int32, description: totalPages}
  7370. totalCount: {type: integer, format: int32, description: totalCount}
  7371. data:
  7372. type: array
  7373. items:
  7374. type: object
  7375. properties:
  7376. id: {type: number, format: float, description: id}
  7377. name: {type: string, description: name}
  7378. owner: {type: string, description: owner}
  7379. ownerId: {type: number, format: float, description: ownerId}
  7380. description: data
  7381. '500':
  7382. description: '500'
  7383. schema:
  7384. type: object
  7385. properties:
  7386. refId: {type: string, description: refId}
  7387. errorCode: {type: number, format: float, description: errorCode}
  7388. message: {type: string, description: message}
  7389. /webhooks/{webhookId}:
  7390. get:
  7391. summary: Get Webhook
  7392. description: Get Webhook
  7393. operationId: GetWebhook
  7394. parameters:
  7395. - {name: webhookId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7396. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7397. description: Accept}
  7398. responses:
  7399. '200':
  7400. description: '200'
  7401. schema:
  7402. type: object
  7403. properties:
  7404. callbackUrl: {type: string, description: callbackUrl}
  7405. enabled: {type: boolean, description: enabled}
  7406. events:
  7407. type: array
  7408. items: {type: string}
  7409. description: events
  7410. name: {type: string, description: name}
  7411. version: {type: integer, format: int32, description: version}
  7412. id: {type: integer, format: int32, description: id}
  7413. apiClientId: {type: string, description: apiClientId}
  7414. scopeObjectId: {type: integer, format: int32, description: scopeObjectId}
  7415. apiClientName: {type: string, description: apiClientName}
  7416. createdAt:
  7417. type: object
  7418. properties:
  7419. value: {type: string, description: value}
  7420. description: createdAt
  7421. disabledDetails: {type: string, description: disabledDetails}
  7422. modifiedAt:
  7423. type: object
  7424. properties:
  7425. value: {type: string, description: value}
  7426. description: modifiedAt
  7427. scope: {type: string, description: scope}
  7428. sharedSecret: {type: string, description: sharedSecret}
  7429. stats:
  7430. type: object
  7431. properties:
  7432. lastCallbackAttempt: {type: string, description: lastCallbackAttempt}
  7433. lastCallbackAttemptRetryCount: {type: number, format: float, description: lastCallbackAttemptRetryCount}
  7434. lastSuccessfulCallback: {type: string, description: lastSuccessfulCallback}
  7435. description: stats
  7436. status: {type: string, description: status}
  7437. subscope:
  7438. type: array
  7439. items: {type: number, format: float}
  7440. description: subscope
  7441. delete:
  7442. summary: Delete Webhook
  7443. description: Delete Webhook
  7444. operationId: DeleteWebhook
  7445. parameters:
  7446. - {name: webhookId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7447. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7448. description: Accept}
  7449. responses:
  7450. '200':
  7451. description: '200'
  7452. schema:
  7453. type: object
  7454. properties:
  7455. message:
  7456. type: object
  7457. properties:
  7458. value: {type: string, description: value}
  7459. description: message
  7460. resultCode:
  7461. type: object
  7462. properties:
  7463. value: {type: string, description: value}
  7464. description: resultCode
  7465. put:
  7466. summary: Update Webhook
  7467. description: Update Webhook
  7468. operationId: UpdateWebhook
  7469. parameters:
  7470. - {name: webhookId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7471. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7472. description: Content-Type}
  7473. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7474. description: Accept}
  7475. - name: body
  7476. in: body
  7477. schema:
  7478. type: object
  7479. properties:
  7480. callbackUrl: {type: string, description: callbackUrl}
  7481. enabled: {type: boolean, description: enabled}
  7482. events:
  7483. type: array
  7484. items: {type: string}
  7485. description: events
  7486. name: {type: string, description: name}
  7487. version: {type: integer, format: int32, description: version}
  7488. default:
  7489. callbackUrl: https://www.myApp.com/webhooks
  7490. enabled: true
  7491. events: ['*.*', '*.*']
  7492. name: Webhook for Sheet Creation
  7493. version: 1
  7494. required: true
  7495. responses:
  7496. '200':
  7497. description: '200'
  7498. schema:
  7499. type: object
  7500. properties:
  7501. message: {type: string, description: message}
  7502. resultCode: {type: integer, format: int32, description: resultCode}
  7503. result:
  7504. type: object
  7505. properties:
  7506. callbackUrl:
  7507. type: object
  7508. properties:
  7509. value: {type: string, description: value}
  7510. description: callbackUrl
  7511. enabled:
  7512. type: object
  7513. properties:
  7514. value: {type: string, description: value}
  7515. description: enabled
  7516. events:
  7517. type: object
  7518. properties:
  7519. value: {type: string, description: value}
  7520. description: events
  7521. name:
  7522. type: object
  7523. properties:
  7524. value: {type: string, description: value}
  7525. description: name
  7526. version:
  7527. type: object
  7528. properties:
  7529. value: {type: string, description: value}
  7530. description: version
  7531. id:
  7532. type: object
  7533. properties:
  7534. value: {type: string, description: value}
  7535. description: id
  7536. apiClientId:
  7537. type: object
  7538. properties:
  7539. value: {type: string, description: value}
  7540. description: apiClientId
  7541. scopeObjectId:
  7542. type: object
  7543. properties:
  7544. value: {type: string, description: value}
  7545. description: scopeObjectId
  7546. apiClientName:
  7547. type: object
  7548. properties:
  7549. value: {type: string, description: value}
  7550. description: apiClientName
  7551. createdAt:
  7552. type: object
  7553. properties:
  7554. value: {type: string, description: value}
  7555. description: createdAt
  7556. disabledDetails:
  7557. type: object
  7558. properties:
  7559. value: {type: string, description: value}
  7560. description: disabledDetails
  7561. modifiedAt:
  7562. type: object
  7563. properties:
  7564. value: {type: string, description: value}
  7565. description: modifiedAt
  7566. scope:
  7567. type: object
  7568. properties:
  7569. value: {type: string, description: value}
  7570. description: scope
  7571. sharedSecret:
  7572. type: object
  7573. properties:
  7574. value: {type: string, description: value}
  7575. description: sharedSecret
  7576. stats:
  7577. type: object
  7578. properties:
  7579. value: {type: string, description: value}
  7580. description: stats
  7581. status:
  7582. type: object
  7583. properties:
  7584. value: {type: string, description: value}
  7585. description: status
  7586. subscope:
  7587. type: object
  7588. properties:
  7589. value: {type: string, description: value}
  7590. description: subscope
  7591. description: result
  7592. /webhooks/{webhookId}/resetSharedSecret:
  7593. post:
  7594. summary: Reset Shared Secret
  7595. description: Reset Shared Secret
  7596. operationId: ResetSharedSecret
  7597. parameters:
  7598. - {name: webhookId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7599. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7600. description: Accept}
  7601. responses:
  7602. '200':
  7603. description: '200'
  7604. schema:
  7605. type: object
  7606. properties:
  7607. message: {type: string, description: message}
  7608. resultCode: {type: integer, format: int32, description: resultCode}
  7609. result:
  7610. type: object
  7611. properties:
  7612. sharedSecret: {type: string, description: sharedSecret}
  7613. description: result
  7614. /webhooks:
  7615. get:
  7616. summary: List Webhooks
  7617. description: List Webhooks
  7618. operationId: ListWebhooks
  7619. parameters:
  7620. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  7621. - {name: page, default: '1', in: query, type: string, required: true}
  7622. - {name: pageSize, default: '100', in: query, type: string, required: true}
  7623. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7624. description: Accept}
  7625. responses:
  7626. '200':
  7627. description: '200'
  7628. schema:
  7629. type: object
  7630. properties:
  7631. pageNumber: {type: integer, format: int32, description: pageNumber}
  7632. pageSize: {type: integer, format: int32, description: pageSize}
  7633. totalPages: {type: integer, format: int32, description: totalPages}
  7634. totalCount: {type: integer, format: int32, description: totalCount}
  7635. data:
  7636. type: array
  7637. items:
  7638. type: object
  7639. properties:
  7640. callbackUrl: {type: string, description: callbackUrl}
  7641. enabled: {type: boolean, description: enabled}
  7642. events:
  7643. type: array
  7644. items:
  7645. type: object
  7646. properties:
  7647. value: {type: string, description: value}
  7648. description: events
  7649. name: {type: string, description: name}
  7650. version: {type: integer, format: int32, description: version}
  7651. id: {type: integer, format: int32, description: id}
  7652. apiClientId: {type: string, description: apiClientId}
  7653. scopeObjectId: {type: integer, format: int32, description: scopeObjectId}
  7654. apiClientName: {type: string, description: apiClientName}
  7655. createdAt:
  7656. type: object
  7657. properties:
  7658. value: {type: string, description: value}
  7659. description: createdAt
  7660. disabledDetails: {type: string, description: disabledDetails}
  7661. modifiedAt:
  7662. type: object
  7663. properties:
  7664. value: {type: string, description: value}
  7665. description: modifiedAt
  7666. scope: {type: string, description: scope}
  7667. sharedSecret: {type: string, description: sharedSecret}
  7668. stats:
  7669. type: object
  7670. properties:
  7671. lastCallbackAttempt:
  7672. type: object
  7673. properties:
  7674. value: {type: string, description: value}
  7675. description: lastCallbackAttempt
  7676. lastCallbackAttemptRetryCount:
  7677. type: object
  7678. properties:
  7679. value: {type: string, description: value}
  7680. description: lastCallbackAttemptRetryCount
  7681. lastSuccessfulCallback:
  7682. type: object
  7683. properties:
  7684. value: {type: string, description: value}
  7685. description: lastSuccessfulCallback
  7686. description: stats
  7687. status: {type: string, description: status}
  7688. subscope:
  7689. type: array
  7690. items:
  7691. type: object
  7692. properties:
  7693. value: {type: string, description: value}
  7694. description: subscope
  7695. description: data
  7696. '500':
  7697. description: '500'
  7698. schema:
  7699. type: object
  7700. properties:
  7701. refId: {type: string, description: refId}
  7702. errorCode: {type: number, format: float, description: errorCode}
  7703. message: {type: string, description: message}
  7704. post:
  7705. summary: Create Webhook
  7706. description: Create Webhook
  7707. operationId: CreateWebhook
  7708. parameters:
  7709. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7710. description: Content-Type}
  7711. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7712. description: Accept}
  7713. - name: body
  7714. in: body
  7715. schema:
  7716. type: object
  7717. properties:
  7718. callbackUrl: {type: string, description: callbackUrl}
  7719. events:
  7720. type: array
  7721. items: {type: string}
  7722. description: events
  7723. name: {type: string, description: name}
  7724. scope: {type: string, description: scope}
  7725. scopeObjectId: {type: integer, format: int32, description: scopeObjectId}
  7726. version: {type: integer, format: int32, description: version}
  7727. enabled: {type: boolean, description: enabled}
  7728. subscope:
  7729. type: array
  7730. items: {type: number, format: float}
  7731. description: subscope
  7732. default:
  7733. callbackUrl: https://www.myApp.com/webhooks
  7734. events: ['*.*', '*.*']
  7735. name: Webhook for Sheet Creation
  7736. scope: sheet
  7737. scopeObjectId: 3285357287499652
  7738. version: 1
  7739. enabled: true
  7740. subscope: [54316402.04272866, -62064896.8991425]
  7741. required: true
  7742. responses:
  7743. '200':
  7744. description: '200'
  7745. schema:
  7746. type: object
  7747. properties:
  7748. message: {type: string, description: message}
  7749. resultCode: {type: integer, format: int32, description: resultCode}
  7750. result:
  7751. type: object
  7752. properties:
  7753. callbackUrl: {type: string, description: callbackUrl}
  7754. enabled: {type: boolean, description: enabled}
  7755. events:
  7756. type: array
  7757. items:
  7758. type: object
  7759. properties:
  7760. value: {type: string, description: value}
  7761. description: events
  7762. name: {type: string, description: name}
  7763. version: {type: integer, format: int32, description: version}
  7764. id: {type: integer, format: int32, description: id}
  7765. apiClientId: {type: string, description: apiClientId}
  7766. scopeObjectId: {type: integer, format: int32, description: scopeObjectId}
  7767. apiClientName: {type: string, description: apiClientName}
  7768. createdAt:
  7769. type: object
  7770. properties:
  7771. value: {type: string, description: value}
  7772. description: createdAt
  7773. disabledDetails: {type: string, description: disabledDetails}
  7774. modifiedAt:
  7775. type: object
  7776. properties:
  7777. value: {type: string, description: value}
  7778. description: modifiedAt
  7779. scope: {type: string, description: scope}
  7780. sharedSecret: {type: string, description: sharedSecret}
  7781. stats:
  7782. type: object
  7783. properties:
  7784. lastCallbackAttempt:
  7785. type: object
  7786. properties:
  7787. value: {type: string, description: value}
  7788. description: lastCallbackAttempt
  7789. lastCallbackAttemptRetryCount:
  7790. type: object
  7791. properties:
  7792. value: {type: string, description: value}
  7793. description: lastCallbackAttemptRetryCount
  7794. lastSuccessfulCallback:
  7795. type: object
  7796. properties:
  7797. value: {type: string, description: value}
  7798. description: lastSuccessfulCallback
  7799. description: stats
  7800. status: {type: string, description: status}
  7801. subscope:
  7802. type: array
  7803. items:
  7804. type: object
  7805. properties:
  7806. value: {type: string, description: value}
  7807. description: subscope
  7808. description: result
  7809. '500':
  7810. description: '500'
  7811. schema:
  7812. type: object
  7813. properties:
  7814. refId: {type: string, description: refId}
  7815. errorCode: {type: number, format: float, description: errorCode}
  7816. message: {type: string, description: message}
  7817. /workspaces/{workspaceId}/folders:
  7818. get:
  7819. summary: Get Workspace folders
  7820. description: Get Workspace folders
  7821. operationId: GetWorkspaceFolders
  7822. parameters:
  7823. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  7824. - {name: page, default: '1', in: query, type: string, required: true}
  7825. - {name: pageSize, default: '100', in: query, type: string, required: true}
  7826. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  7827. required: true}
  7828. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7829. description: Accept}
  7830. responses:
  7831. '200':
  7832. description: '200'
  7833. schema:
  7834. type: object
  7835. properties:
  7836. pageNumber: {type: integer, format: int32, description: pageNumber}
  7837. pageSize: {type: integer, format: int32, description: pageSize}
  7838. totalPages: {type: integer, format: int32, description: totalPages}
  7839. totalCount: {type: integer, format: int32, description: totalCount}
  7840. result:
  7841. type: array
  7842. items:
  7843. type: object
  7844. properties:
  7845. value: {type: string, description: value}
  7846. description: result
  7847. '500':
  7848. description: '500'
  7849. schema:
  7850. type: object
  7851. properties:
  7852. refId: {type: string, description: refId}
  7853. errorCode: {type: number, format: float, description: errorCode}
  7854. message: {type: string, description: message}
  7855. post:
  7856. summary: Create a Folder
  7857. description: Create a Folder
  7858. operationId: CreateAFolder
  7859. parameters:
  7860. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  7861. required: true}
  7862. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7863. description: Content-Type}
  7864. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7865. description: Accept}
  7866. - name: body
  7867. in: body
  7868. schema:
  7869. type: object
  7870. properties:
  7871. name: {type: string, description: name}
  7872. default: {name: adipisicing dolor sunt sed fugiat}
  7873. required: true
  7874. responses:
  7875. '200':
  7876. description: '200'
  7877. schema:
  7878. type: object
  7879. properties:
  7880. message: {type: string, description: message}
  7881. resultCode: {type: integer, format: int32, description: resultCode}
  7882. result:
  7883. type: object
  7884. properties:
  7885. name: {type: string, description: name}
  7886. description: result
  7887. '500':
  7888. description: '500'
  7889. schema:
  7890. type: object
  7891. properties:
  7892. refId: {type: string, description: refId}
  7893. errorCode: {type: number, format: float, description: errorCode}
  7894. message: {type: string, description: message}
  7895. /workspaces/{workspaceId}/shares/{shareId}:
  7896. get:
  7897. summary: Get Workspace Share.
  7898. description: Get Workspace Share.
  7899. operationId: GetWorkspaceShare.
  7900. parameters:
  7901. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  7902. required: true}
  7903. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7904. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7905. description: Accept}
  7906. responses:
  7907. '200':
  7908. description: '200'
  7909. schema:
  7910. type: object
  7911. properties:
  7912. id: {type: string, description: id}
  7913. groupId: {type: number, format: float, description: groupId}
  7914. userId: {type: number, format: float, description: userId}
  7915. type: {type: string, description: type}
  7916. accessLevel:
  7917. type: object
  7918. properties:
  7919. value: {type: string, description: value}
  7920. description: accessLevel
  7921. ccMe: {type: boolean, description: ccMe}
  7922. createdAt: {type: string, description: createdAt}
  7923. email: {type: string, description: email}
  7924. message: {type: string, description: message}
  7925. modifiedAt: {type: string, description: modifiedAt}
  7926. name: {type: string, description: name}
  7927. scope: {type: string, description: scope}
  7928. subject: {type: string, description: subject}
  7929. '500':
  7930. description: '500'
  7931. schema:
  7932. type: object
  7933. properties:
  7934. refId: {type: string, description: refId}
  7935. errorCode: {type: number, format: float, description: errorCode}
  7936. message: {type: string, description: message}
  7937. delete:
  7938. summary: Delete Workspace Share
  7939. description: Delete Workspace Share
  7940. operationId: DeleteWorkspaceShare
  7941. parameters:
  7942. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  7943. required: true}
  7944. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7945. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7946. description: Accept}
  7947. responses:
  7948. '200':
  7949. description: '200'
  7950. schema:
  7951. type: object
  7952. properties:
  7953. message: {type: string, description: message}
  7954. resultCode: {type: integer, format: int32, description: resultCode}
  7955. '500':
  7956. description: '500'
  7957. schema:
  7958. type: object
  7959. properties:
  7960. refId: {type: string, description: refId}
  7961. errorCode: {type: number, format: float, description: errorCode}
  7962. message: {type: string, description: message}
  7963. put:
  7964. summary: Update Workspace Share.
  7965. description: Update Workspace Share.
  7966. operationId: UpdateWorkspaceShare.
  7967. parameters:
  7968. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  7969. required: true}
  7970. - {name: shareId, default: ex Excepteur laboris, in: path, type: string, required: true}
  7971. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  7972. description: Content-Type}
  7973. - {name: Accept, in: header, required: true, type: string, default: application/json,
  7974. description: Accept}
  7975. - name: body
  7976. in: body
  7977. schema:
  7978. type: object
  7979. properties:
  7980. id: {type: string, description: id}
  7981. groupId: {type: number, format: float, description: groupId}
  7982. userId: {type: number, format: float, description: userId}
  7983. type: {type: string, description: type}
  7984. accessLevel:
  7985. type: object
  7986. properties:
  7987. value: {type: string, description: value}
  7988. description: accessLevel
  7989. ccMe: {type: boolean, description: ccMe}
  7990. createdAt: {type: string, description: createdAt}
  7991. email: {type: string, description: email}
  7992. message: {type: string, description: message}
  7993. modifiedAt: {type: string, description: modifiedAt}
  7994. name: {type: string, description: name}
  7995. scope: {type: string, description: scope}
  7996. subject: {type: string, description: subject}
  7997. default:
  7998. id: mollit
  7999. groupId: 6458197.992068276
  8000. userId: 55638615.369980216
  8001. type: proident ex
  8002. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  8003. not found in the OpenAPI spec'}
  8004. ccMe: false
  8005. createdAt: <dateTime>
  8006. email: voluptate Duis minim Lorem
  8007. message: voluptate officia eiusmod qui
  8008. modifiedAt: <dateTime>
  8009. name: do in
  8010. scope: occaecat labore
  8011. subject: deserunt ut
  8012. required: true
  8013. responses:
  8014. '200':
  8015. description: '200'
  8016. schema:
  8017. type: object
  8018. properties:
  8019. message:
  8020. type: object
  8021. properties:
  8022. value: {type: string, description: value}
  8023. description: message
  8024. resultCode:
  8025. type: object
  8026. properties:
  8027. value: {type: string, description: value}
  8028. description: resultCode
  8029. result:
  8030. type: object
  8031. properties: {}
  8032. description: result
  8033. '500':
  8034. description: '500'
  8035. schema:
  8036. type: object
  8037. properties:
  8038. refId: {type: string, description: refId}
  8039. errorCode: {type: number, format: float, description: errorCode}
  8040. message: {type: string, description: message}
  8041. /workspaces/{workspaceId}/shares:
  8042. get:
  8043. summary: List Workspace Shares
  8044. description: List Workspace Shares
  8045. operationId: ListWorkspaceShares
  8046. parameters:
  8047. - {name: page, default: '1', in: query, type: string, required: true}
  8048. - {name: pageSize, default: '100', in: query, type: string, required: true}
  8049. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  8050. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8051. required: true}
  8052. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8053. description: Accept}
  8054. responses:
  8055. '200':
  8056. description: '200'
  8057. schema:
  8058. type: object
  8059. properties:
  8060. pageNumber: {type: integer, format: int32, description: pageNumber}
  8061. pageSize: {type: integer, format: int32, description: pageSize}
  8062. totalPages: {type: integer, format: int32, description: totalPages}
  8063. totalCount: {type: integer, format: int32, description: totalCount}
  8064. result:
  8065. type: array
  8066. items:
  8067. type: object
  8068. properties:
  8069. id:
  8070. type: object
  8071. properties:
  8072. value: {type: string, description: value}
  8073. description: id
  8074. groupId:
  8075. type: object
  8076. properties:
  8077. value: {type: string, description: value}
  8078. description: groupId
  8079. userId:
  8080. type: object
  8081. properties:
  8082. value: {type: string, description: value}
  8083. description: userId
  8084. type:
  8085. type: object
  8086. properties:
  8087. value: {type: string, description: value}
  8088. description: type
  8089. accessLevel:
  8090. type: object
  8091. properties:
  8092. value: {type: string, description: value}
  8093. description: accessLevel
  8094. ccMe:
  8095. type: object
  8096. properties:
  8097. value: {type: string, description: value}
  8098. description: ccMe
  8099. createdAt:
  8100. type: object
  8101. properties:
  8102. value: {type: string, description: value}
  8103. description: createdAt
  8104. email:
  8105. type: object
  8106. properties:
  8107. value: {type: string, description: value}
  8108. description: email
  8109. message:
  8110. type: object
  8111. properties:
  8112. value: {type: string, description: value}
  8113. description: message
  8114. modifiedAt:
  8115. type: object
  8116. properties:
  8117. value: {type: string, description: value}
  8118. description: modifiedAt
  8119. name:
  8120. type: object
  8121. properties:
  8122. value: {type: string, description: value}
  8123. description: name
  8124. scope:
  8125. type: object
  8126. properties:
  8127. value: {type: string, description: value}
  8128. description: scope
  8129. subject:
  8130. type: object
  8131. properties:
  8132. value: {type: string, description: value}
  8133. description: subject
  8134. description: result
  8135. '500':
  8136. description: '500'
  8137. schema:
  8138. type: object
  8139. properties:
  8140. refId: {type: string, description: refId}
  8141. errorCode: {type: number, format: float, description: errorCode}
  8142. message: {type: string, description: message}
  8143. post:
  8144. summary: Share Workspace
  8145. description: Share Workspace
  8146. operationId: ShareWorkspace
  8147. parameters:
  8148. - {name: sendEmail, default: 'false', in: query, type: string, required: true}
  8149. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8150. required: true}
  8151. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8152. description: Content-Type}
  8153. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8154. description: Accept}
  8155. - name: body
  8156. in: body
  8157. schema:
  8158. type: object
  8159. properties:
  8160. id: {type: string, description: id}
  8161. groupId: {type: number, format: float, description: groupId}
  8162. userId: {type: number, format: float, description: userId}
  8163. type: {type: string, description: type}
  8164. accessLevel:
  8165. type: object
  8166. properties:
  8167. value: {type: string, description: value}
  8168. description: accessLevel
  8169. ccMe: {type: boolean, description: ccMe}
  8170. createdAt: {type: string, description: createdAt}
  8171. email: {type: string, description: email}
  8172. message: {type: string, description: message}
  8173. modifiedAt: {type: string, description: modifiedAt}
  8174. name: {type: string, description: name}
  8175. scope: {type: string, description: scope}
  8176. subject: {type: string, description: subject}
  8177. default:
  8178. id: mollit
  8179. groupId: 6458197.992068276
  8180. userId: 55638615.369980216
  8181. type: proident ex
  8182. accessLevel: {value: 'reference #/components/schemas/Discussion/properties/accessLevel
  8183. not found in the OpenAPI spec'}
  8184. ccMe: false
  8185. createdAt: <dateTime>
  8186. email: voluptate Duis minim Lorem
  8187. message: voluptate officia eiusmod qui
  8188. modifiedAt: <dateTime>
  8189. name: do in
  8190. scope: occaecat labore
  8191. subject: deserunt ut
  8192. required: true
  8193. responses:
  8194. '200':
  8195. description: '200'
  8196. schema:
  8197. type: object
  8198. properties:
  8199. message: {type: string, description: message}
  8200. resultCode: {type: integer, format: int32, description: resultCode}
  8201. result:
  8202. type: object
  8203. properties:
  8204. id:
  8205. type: object
  8206. properties:
  8207. value: {type: string, description: value}
  8208. description: id
  8209. groupId:
  8210. type: object
  8211. properties:
  8212. value: {type: string, description: value}
  8213. description: groupId
  8214. userId:
  8215. type: object
  8216. properties:
  8217. value: {type: string, description: value}
  8218. description: userId
  8219. type:
  8220. type: object
  8221. properties:
  8222. value: {type: string, description: value}
  8223. description: type
  8224. accessLevel:
  8225. type: object
  8226. properties:
  8227. value: {type: string, description: value}
  8228. description: accessLevel
  8229. ccMe:
  8230. type: object
  8231. properties:
  8232. value: {type: string, description: value}
  8233. description: ccMe
  8234. createdAt:
  8235. type: object
  8236. properties:
  8237. value: {type: string, description: value}
  8238. description: createdAt
  8239. email:
  8240. type: object
  8241. properties:
  8242. value: {type: string, description: value}
  8243. description: email
  8244. message:
  8245. type: object
  8246. properties:
  8247. value: {type: string, description: value}
  8248. description: message
  8249. modifiedAt:
  8250. type: object
  8251. properties:
  8252. value: {type: string, description: value}
  8253. description: modifiedAt
  8254. name:
  8255. type: object
  8256. properties:
  8257. value: {type: string, description: value}
  8258. description: name
  8259. scope:
  8260. type: object
  8261. properties:
  8262. value: {type: string, description: value}
  8263. description: scope
  8264. subject:
  8265. type: object
  8266. properties:
  8267. value: {type: string, description: value}
  8268. description: subject
  8269. description: result
  8270. '400':
  8271. description: '400'
  8272. schema:
  8273. type: object
  8274. properties:
  8275. refId: {type: string, description: refId}
  8276. errorCode: {type: number, format: float, description: errorCode}
  8277. message: {type: string, description: message}
  8278. '500':
  8279. description: '500'
  8280. schema:
  8281. type: object
  8282. properties:
  8283. refId: {type: string, description: refId}
  8284. errorCode: {type: number, format: float, description: errorCode}
  8285. message: {type: string, description: message}
  8286. /workspaces/{workspaceId}/sheets:
  8287. post:
  8288. summary: Create Sheet in Workspace
  8289. description: Create Sheet in Workspace
  8290. operationId: CreateSheetInWorkspace
  8291. parameters:
  8292. - {name: include, default: rules, in: query, type: string, required: true}
  8293. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8294. required: true}
  8295. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8296. description: Content-Type}
  8297. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8298. description: Accept}
  8299. - name: body
  8300. in: body
  8301. schema:
  8302. type: object
  8303. properties:
  8304. columns:
  8305. type: array
  8306. items:
  8307. type: object
  8308. properties:
  8309. autoNumberFormat:
  8310. type: object
  8311. properties:
  8312. value: {type: string, description: value}
  8313. description: autoNumberFormat
  8314. contactOptions:
  8315. type: array
  8316. items:
  8317. type: object
  8318. properties:
  8319. value: {type: string, description: value}
  8320. description: contactOptions
  8321. options:
  8322. type: array
  8323. items:
  8324. type: object
  8325. properties:
  8326. value: {type: string, description: value}
  8327. description: options
  8328. primary: {type: boolean, description: primary}
  8329. symbol: {type: string, description: symbol}
  8330. systemColumnType: {type: string, description: systemColumnType}
  8331. title: {type: string, description: title}
  8332. type: {type: string, description: type}
  8333. width: {type: number, format: float, description: width}
  8334. description: columns
  8335. name:
  8336. type: object
  8337. properties:
  8338. value: {type: string, description: value}
  8339. description: name
  8340. default:
  8341. columns:
  8342. - autoNumberFormat: {value: '<Error: Too many levels of nesting to fake
  8343. this schema>'}
  8344. contactOptions:
  8345. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8346. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8347. options:
  8348. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8349. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8350. primary: false
  8351. symbol: enim
  8352. systemColumnType: MODIFIED_BY
  8353. title: consequat voluptate Ut
  8354. type: MULTI_PICKLIST
  8355. width: -7874532.725726262
  8356. - autoNumberFormat: {value: '<Error: Too many levels of nesting to fake
  8357. this schema>'}
  8358. contactOptions:
  8359. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8360. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8361. options:
  8362. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8363. - {value: '<Error: Too many levels of nesting to fake this schema>'}
  8364. primary: false
  8365. symbol: enim
  8366. systemColumnType: MODIFIED_BY
  8367. title: consequat voluptate Ut
  8368. type: MULTI_PICKLIST
  8369. width: -7874532.725726262
  8370. name: {value: 'reference #/components/schemas/Folder/properties/sheets/items/properties/name
  8371. not found in the OpenAPI spec'}
  8372. required: true
  8373. responses:
  8374. '200':
  8375. description: '200'
  8376. schema:
  8377. type: object
  8378. properties:
  8379. message: {type: string, description: message}
  8380. resultCode: {type: integer, format: int32, description: resultCode}
  8381. result:
  8382. type: object
  8383. properties:
  8384. accessLevel:
  8385. type: object
  8386. properties:
  8387. value: {type: string, description: value}
  8388. description: accessLevel
  8389. columns:
  8390. type: object
  8391. properties:
  8392. value: {type: string, description: value}
  8393. description: columns
  8394. id:
  8395. type: object
  8396. properties:
  8397. value: {type: string, description: value}
  8398. description: id
  8399. name:
  8400. type: object
  8401. properties:
  8402. value: {type: string, description: value}
  8403. description: name
  8404. permalink:
  8405. type: object
  8406. properties:
  8407. value: {type: string, description: value}
  8408. description: permalink
  8409. description: result
  8410. '500':
  8411. description: '500'
  8412. schema:
  8413. type: object
  8414. properties:
  8415. refId: {type: string, description: refId}
  8416. errorCode: {type: number, format: float, description: errorCode}
  8417. message: {type: string, description: message}
  8418. /workspaces/{workspaceId}/sheets/import:
  8419. post:
  8420. summary: Import Sheet into Workspace
  8421. description: Import Sheet into Workspace
  8422. operationId: ImportSheetIntoWorkspace
  8423. parameters:
  8424. - {name: sheetName, default: ex Excepteur laboris, in: query, type: string,
  8425. required: true}
  8426. - {name: headerRowIndex, default: '-4847524.674802229', in: query, type: string,
  8427. required: true}
  8428. - {name: primaryColumnIndex, default: '0', in: query, type: string, required: true}
  8429. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8430. required: true}
  8431. - {name: Content-Disposition, in: header, required: true, type: string, default: attachment;
  8432. filename="ProgressReport.docx", description: Content-Disposition}
  8433. - {name: Content-Type, in: header, required: true, type: string, default: application/octet-stream,
  8434. description: Content-Type}
  8435. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8436. description: Accept}
  8437. responses:
  8438. '200':
  8439. description: '200'
  8440. schema:
  8441. type: object
  8442. properties:
  8443. message: {type: string, description: message}
  8444. resultCode: {type: integer, format: int32, description: resultCode}
  8445. result:
  8446. type: object
  8447. properties:
  8448. accessLevel:
  8449. type: object
  8450. properties:
  8451. value: {type: string, description: value}
  8452. description: accessLevel
  8453. id:
  8454. type: object
  8455. properties:
  8456. value: {type: string, description: value}
  8457. description: id
  8458. name:
  8459. type: object
  8460. properties:
  8461. value: {type: string, description: value}
  8462. description: name
  8463. type: {type: string, description: type}
  8464. permalink:
  8465. type: object
  8466. properties:
  8467. value: {type: string, description: value}
  8468. description: permalink
  8469. description: result
  8470. '500':
  8471. description: '500'
  8472. schema:
  8473. type: object
  8474. properties:
  8475. refId: {type: string, description: refId}
  8476. errorCode: {type: number, format: float, description: errorCode}
  8477. message: {type: string, description: message}
  8478. /workspaces/{workspaceId}:
  8479. get:
  8480. summary: Get Workspace
  8481. description: Get Workspace
  8482. operationId: GetWorkspace
  8483. parameters:
  8484. - {name: include, default: ownerInfo, in: query, type: string, required: true}
  8485. - {name: loadAll, default: 'false', in: query, type: string, required: true}
  8486. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8487. required: true}
  8488. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8489. description: Accept}
  8490. responses:
  8491. '200':
  8492. description: '200'
  8493. schema:
  8494. type: object
  8495. properties:
  8496. value: {type: string, description: value}
  8497. '500':
  8498. description: '500'
  8499. schema:
  8500. type: object
  8501. properties:
  8502. refId: {type: string, description: refId}
  8503. errorCode: {type: number, format: float, description: errorCode}
  8504. message: {type: string, description: message}
  8505. delete:
  8506. summary: Delete Workspace
  8507. description: Delete Workspace
  8508. operationId: DeleteWorkspace
  8509. parameters:
  8510. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8511. required: true}
  8512. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8513. description: Accept}
  8514. responses:
  8515. '200':
  8516. description: '200'
  8517. schema:
  8518. type: object
  8519. properties:
  8520. message: {type: string, description: message}
  8521. resultCode: {type: integer, format: int32, description: resultCode}
  8522. '500':
  8523. description: '500'
  8524. schema:
  8525. type: object
  8526. properties:
  8527. refId: {type: string, description: refId}
  8528. errorCode: {type: number, format: float, description: errorCode}
  8529. message: {type: string, description: message}
  8530. put:
  8531. summary: Update Workspace
  8532. description: Update Workspace
  8533. operationId: UpdateWorkspace
  8534. parameters:
  8535. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8536. required: true}
  8537. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8538. description: Content-Type}
  8539. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8540. description: Accept}
  8541. - name: body
  8542. in: body
  8543. schema:
  8544. type: object
  8545. properties:
  8546. name: {type: string, description: name}
  8547. default: {name: adipisicing dolor sunt sed fugiat}
  8548. required: true
  8549. responses:
  8550. '200':
  8551. description: '200'
  8552. schema:
  8553. type: object
  8554. properties:
  8555. message: {type: string, description: message}
  8556. resultCode: {type: integer, format: int32, description: resultCode}
  8557. result:
  8558. type: object
  8559. properties:
  8560. value: {type: string, description: value}
  8561. description: result
  8562. '500':
  8563. description: '500'
  8564. schema:
  8565. type: object
  8566. properties:
  8567. refId: {type: string, description: refId}
  8568. errorCode: {type: number, format: float, description: errorCode}
  8569. message: {type: string, description: message}
  8570. /workspaces/{workspaceId}/copy:
  8571. post:
  8572. summary: Copy Workspace
  8573. description: Copy Workspace
  8574. operationId: CopyWorkspace
  8575. parameters:
  8576. - {name: include, default: all, in: query, type: string, required: true}
  8577. - {name: skipRemap, default: sights, in: query, type: string, required: true}
  8578. - {name: workspaceId, default: ex Excepteur laboris, in: path, type: string,
  8579. required: true}
  8580. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8581. description: Content-Type}
  8582. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8583. description: Accept}
  8584. - name: body
  8585. in: body
  8586. schema:
  8587. type: object
  8588. properties:
  8589. destinationId: {type: number, format: float, description: destinationId}
  8590. destinationType: {type: string, description: destinationType}
  8591. newName: {type: string, description: newName}
  8592. default: {destinationId: 80073746.07746986, destinationType: workspace,
  8593. newName: in eu}
  8594. required: true
  8595. responses:
  8596. '200':
  8597. description: '200'
  8598. schema:
  8599. type: object
  8600. properties:
  8601. destinationId: {type: number, format: float, description: destinationId}
  8602. destinationType: {type: string, description: destinationType}
  8603. newName: {type: string, description: newName}
  8604. '500':
  8605. description: '500'
  8606. schema:
  8607. type: object
  8608. properties:
  8609. refId: {type: string, description: refId}
  8610. errorCode: {type: number, format: float, description: errorCode}
  8611. message: {type: string, description: message}
  8612. /workspaces:
  8613. get:
  8614. summary: List Workspaces
  8615. description: List Workspaces
  8616. operationId: ListWorkspaces
  8617. parameters:
  8618. - {name: includeAll, default: 'false', in: query, type: string, required: true}
  8619. - {name: page, default: '1', in: query, type: string, required: true}
  8620. - {name: pageSize, default: '100', in: query, type: string, required: true}
  8621. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8622. description: Accept}
  8623. responses:
  8624. '200':
  8625. description: '200'
  8626. schema:
  8627. type: object
  8628. properties:
  8629. pageNumber: {type: integer, format: int32, description: pageNumber}
  8630. pageSize: {type: integer, format: int32, description: pageSize}
  8631. totalPages: {type: integer, format: int32, description: totalPages}
  8632. totalCount: {type: integer, format: int32, description: totalCount}
  8633. result:
  8634. type: array
  8635. items:
  8636. type: object
  8637. properties:
  8638. value: {type: string, description: value}
  8639. description: result
  8640. '500':
  8641. description: '500'
  8642. schema:
  8643. type: object
  8644. properties:
  8645. refId: {type: string, description: refId}
  8646. errorCode: {type: number, format: float, description: errorCode}
  8647. message: {type: string, description: message}
  8648. post:
  8649. summary: Create Workspace
  8650. description: Create Workspace
  8651. operationId: CreateWorkspace
  8652. parameters:
  8653. - {name: include, default: all, in: query, type: string, required: true}
  8654. - {name: skipRemap, default: sights, in: query, type: string, required: true}
  8655. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8656. description: Content-Type}
  8657. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8658. description: Accept}
  8659. - name: body
  8660. in: body
  8661. schema:
  8662. type: object
  8663. properties:
  8664. value: {type: string, description: value}
  8665. default: {value: 'reference #/components/schemas/Home/properties/workspaces/items
  8666. not found in the OpenAPI spec'}
  8667. required: true
  8668. responses:
  8669. '200':
  8670. description: '200'
  8671. schema:
  8672. type: object
  8673. properties:
  8674. message: {type: string, description: message}
  8675. resultCode: {type: integer, format: int32, description: resultCode}
  8676. result:
  8677. type: object
  8678. properties:
  8679. value: {type: string, description: value}
  8680. description: result
  8681. '500':
  8682. description: '500'
  8683. schema:
  8684. type: object
  8685. properties:
  8686. refId: {type: string, description: refId}
  8687. errorCode: {type: number, format: float, description: errorCode}
  8688. message: {type: string, description: message}
  8689. /events:
  8690. get:
  8691. summary: List Events
  8692. description: List Events
  8693. operationId: ListEvents
  8694. parameters:
  8695. - {name: since, default: '1985-09-11T17:58:59.315Z', in: query, type: string,
  8696. required: true}
  8697. - {name: streamPosition, default: XyzAb1234cdefghijklmnofpq, in: query, type: string,
  8698. required: true}
  8699. - {name: maxCount, default: '1000', in: query, type: string, required: true}
  8700. - {name: numericDates, default: 'false', in: query, type: string, required: true}
  8701. - {name: Accept-Encoding, in: header, required: true, type: string, default: gzip,
  8702. description: Accept-Encoding}
  8703. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8704. description: Accept}
  8705. responses:
  8706. '200':
  8707. description: '200'
  8708. schema:
  8709. type: object
  8710. properties:
  8711. nextStreamPosition: {type: string, description: nextStreamPosition}
  8712. moreAvailable: {type: boolean, description: moreAvailable}
  8713. data:
  8714. type: array
  8715. items:
  8716. type: object
  8717. properties:
  8718. eventId: {type: string, description: eventId}
  8719. objectType: {type: string, description: objectType}
  8720. action: {type: string, description: action}
  8721. objectId: {type: string, description: objectId}
  8722. eventTimeStamp: {type: string, description: eventTimeStamp}
  8723. userId: {type: integer, format: int32, description: userId}
  8724. requestUserId: {type: integer, format: int32, description: requestUserId}
  8725. accessTokeName: {type: number, format: float, description: accessTokeName}
  8726. source: {type: string, description: source}
  8727. additionalDetails:
  8728. type: object
  8729. properties:
  8730. consequat90: {type: number, format: float, description: consequat90}
  8731. eiusmod_1: {type: string, description: eiusmod_1}
  8732. consectetur16: {type: boolean, description: consectetur16}
  8733. qui_e: {type: number, format: float, description: qui_e}
  8734. et_a: {type: number, format: float, description: et_a}
  8735. description: additionalDetails
  8736. description: data
  8737. '400':
  8738. description: '400'
  8739. schema:
  8740. type: object
  8741. properties:
  8742. refId: {type: string, description: refId}
  8743. errorCode: {type: number, format: float, description: errorCode}
  8744. message: {type: string, description: message}
  8745. '401':
  8746. description: '401'
  8747. schema:
  8748. type: object
  8749. properties:
  8750. errorCode: {type: integer, format: int32, description: errorCode}
  8751. message: {type: string, description: message}
  8752. refId: {type: string, description: refId}
  8753. '403':
  8754. description: '403'
  8755. schema:
  8756. type: object
  8757. properties:
  8758. refId: {type: string, description: refId}
  8759. errorCode: {type: number, format: float, description: errorCode}
  8760. message: {type: string, description: message}
  8761. '404':
  8762. description: '404'
  8763. schema:
  8764. type: object
  8765. properties:
  8766. errorCode: {type: integer, format: int32, description: errorCode}
  8767. message: {type: string, description: message}
  8768. refId: {type: string, description: refId}
  8769. '405':
  8770. description: '405'
  8771. schema:
  8772. type: object
  8773. properties:
  8774. errorCode: {type: integer, format: int32, description: errorCode}
  8775. message: {type: string, description: message}
  8776. refId: {type: string, description: refId}
  8777. '406':
  8778. description: '406'
  8779. schema:
  8780. type: object
  8781. properties:
  8782. errorCode: {type: integer, format: int32, description: errorCode}
  8783. message: {type: string, description: message}
  8784. refId: {type: string, description: refId}
  8785. '410':
  8786. description: '410'
  8787. schema:
  8788. type: object
  8789. properties:
  8790. errorCode: {type: integer, format: int32, description: errorCode}
  8791. message: {type: string, description: message}
  8792. refId: {type: string, description: refId}
  8793. '415':
  8794. description: '415'
  8795. schema:
  8796. type: object
  8797. properties:
  8798. errorCode: {type: integer, format: int32, description: errorCode}
  8799. message: {type: string, description: message}
  8800. refId: {type: string, description: refId}
  8801. '429':
  8802. description: '429'
  8803. schema:
  8804. type: object
  8805. properties:
  8806. errorCode: {type: integer, format: int32, description: errorCode}
  8807. message: {type: string, description: message}
  8808. refId: {type: string, description: refId}
  8809. '500':
  8810. description: '500'
  8811. schema:
  8812. type: object
  8813. properties:
  8814. errorCode: {type: integer, format: int32, description: errorCode}
  8815. message: {type: string, description: message}
  8816. refId: {type: string, description: refId}
  8817. /imageurls:
  8818. post:
  8819. summary: List Image URLs
  8820. description: List Image URLs
  8821. operationId: ListImageUrls
  8822. parameters:
  8823. - {name: Content-Type, in: header, required: true, type: string, default: application/json,
  8824. description: Content-Type}
  8825. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8826. description: Accept}
  8827. - name: body
  8828. in: body
  8829. schema:
  8830. type: object
  8831. properties:
  8832. value: {type: string, description: value}
  8833. default: {value: 'reference #/components/schemas/ImageUrlMap/properties/imageUrls/items
  8834. not found in the OpenAPI spec'}
  8835. required: true
  8836. responses:
  8837. '200':
  8838. description: '200'
  8839. schema:
  8840. type: object
  8841. properties:
  8842. imageUrls:
  8843. type: array
  8844. items:
  8845. type: object
  8846. properties:
  8847. value: {type: string, description: value}
  8848. description: imageUrls
  8849. urlExpiresInMillis: {type: number, format: float, description: urlExpiresInMillis}
  8850. /serverinfo:
  8851. get:
  8852. summary: Gets application constants.
  8853. description: Gets application constants.
  8854. operationId: GetsApplicationConstants
  8855. parameters:
  8856. - {name: Accept, in: header, required: true, type: string, default: application/json,
  8857. description: Accept}
  8858. responses:
  8859. '200':
  8860. description: '200'
  8861. schema:
  8862. type: object
  8863. properties:
  8864. formats:
  8865. type: object
  8866. properties:
  8867. value: {type: string, description: value}
  8868. description: formats
  8869. supportedLocales:
  8870. type: array
  8871. items: {type: string}
  8872. description: supportedLocales
  8873. definitions: {}
  8874. parameters: {}
  8875. responses: {}
  8876. securityDefinitions:
  8877. API Key: {type: apiKey, in: header, name: Authorization}
  8878. security:
  8879. - API Key: []
  8880. tags: []
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!