API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Nov 30th, 2018
98
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 81.24 KB | None | 0 0
raw download clone embed print report
  1. ---
  2. swagger: "2.0"
  3. info:
  4. version: "2.0.0"
  5. title: "Optanix API v2"
  6. contact: {}
  7. host: "."
  8. basePath: "/api/v2"
  9. schemes:
  10. - "https"
  11. consumes:
  12. - "application/vnd.api+json"
  13. produces:
  14. - "application/vnd.api+json"
  15. # define reusable parameters:
  16. parameters:
  17. com.optanix.api:
  18. name: "com.optanix.api"
  19. in: "header"
  20. required: true
  21. type: "string"
  22. default: "2.0.0"
  23. pageNumber:
  24. name: "page[number]"
  25. in: "query"
  26. required: false
  27. type: "number"
  28. default: "1"
  29. description: "The page number that you want to get, if omitted the server\
  30. \ will reply with the page 1"
  31. x-example: "../entities.json?page%5Bnumber%5D=3 will bring the page 3"
  32. pageSize:
  33. name: "page[size]"
  34. in: "query"
  35. required: false
  36. type: "number"
  37. default: "50"
  38. description: "sets the number of items per page to be returned used in conjunction\
  39. \ with the page[number] query parameter"
  40. x-example: "../entities.json?page%5Bnumber%5D=3&page%5Bsize%5D=10 will bring the page 3 with\
  41. \ 10 items per page"
  42. paths:
  43. /entities:
  44. get:
  45. tags:
  46. - "entities"
  47. description: "Get list of available entities"
  48. parameters:
  49. - $ref: "#/parameters/com.optanix.api"
  50. - $ref: "#/parameters/pageNumber"
  51. - $ref: "#/parameters/pageSize"
  52.  
  53. responses:
  54. 200:
  55. description: "Entity List Response"
  56. schema:
  57. required:
  58. - "data"
  59. type: "object"
  60. properties:
  61. data:
  62. $ref: "#/definitions/EntityListResponseData"
  63. links:
  64. $ref: "#/definitions/PaginationLinks"
  65. errors:
  66. type: "array"
  67. items:
  68. $ref: "#/definitions/ErrorObject"
  69. meta:
  70. $ref: "#/definitions/MetaObject"
  71. 403:
  72. description: "Forbidden"
  73. schema:
  74. $ref: "#/definitions/ErrorSchema"
  75. post:
  76. tags:
  77. - "entities"
  78. description: "Create new entity"
  79. consumes: []
  80. parameters:
  81. - name: "body"
  82. in: "body"
  83. required: true
  84. schema:
  85. $ref: "#/definitions/EntityCreateRequest"
  86. responses:
  87. 201:
  88. description: "Entity Response"
  89. schema:
  90. required:
  91. - "data"
  92. type: "object"
  93. properties:
  94. jsonapi:
  95. $ref: "#/definitions/JsonApiElement"
  96. data:
  97. $ref: "#/definitions/EntityResponseData"
  98. links:
  99. $ref: "#/definitions/SelfLink"
  100. 403:
  101. description: "Forbidden"
  102. schema:
  103. $ref: "#/definitions/ErrorSchema"
  104. /entities/{id}:
  105. get:
  106. tags:
  107. - "entities"
  108. description: "Get information about a single entity"
  109. parameters: []
  110. responses:
  111. 200:
  112. description: "Entity Response"
  113. schema:
  114. required:
  115. - "data"
  116. type: "object"
  117. properties:
  118. jsonapi:
  119. $ref: "#/definitions/JsonApiElement"
  120. data:
  121. $ref: "#/definitions/EntityResponseData"
  122. links:
  123. $ref: "#/definitions/Links"
  124. 403:
  125. description: "Forbidden"
  126. schema:
  127. $ref: "#/definitions/ErrorSchema"
  128. 404:
  129. description: "Not Found"
  130. schema:
  131. $ref: "#/definitions/ErrorSchema"
  132. delete:
  133. tags:
  134. - "entities"
  135. description: "Remove a specific entity"
  136. parameters: []
  137. responses:
  138. 204:
  139. description: "No Content"
  140. 403:
  141. description: "Forbidden"
  142. schema:
  143. $ref: "#/definitions/ErrorSchema"
  144. 404:
  145. description: "Not Found"
  146. schema:
  147. $ref: "#/definitions/ErrorSchema"
  148. patch:
  149. tags:
  150. - "entities"
  151. description: "Update specific entity"
  152. consumes: []
  153. parameters:
  154. - name: "body"
  155. in: "body"
  156. required: true
  157. schema:
  158. $ref: "#/definitions/EntityPatchRequest"
  159. responses:
  160. 204:
  161. description: "No Content"
  162. 403:
  163. description: "Forbidden"
  164. schema:
  165. $ref: "#/definitions/ErrorSchema"
  166. 404:
  167. description: "Not Found"
  168. schema:
  169. $ref: "#/definitions/ErrorSchema"
  170. parameters:
  171. - name: "id"
  172. in: "path"
  173. required: true
  174. type: "integer"
  175. /entities/commit:
  176. post:
  177. tags:
  178. - "entities"
  179. description: "Commit information about entities that have been changed"
  180. parameters: []
  181. responses:
  182. 202:
  183. description: "Entity Commit Response"
  184. schema:
  185. type: "object"
  186. properties:
  187. jsonapi:
  188. $ref: "#/definitions/JsonApiElement"
  189. 500:
  190. description: "Internal Server Error"
  191. schema:
  192. $ref: "#/definitions/ErrorSchema"
  193. /entities/status:
  194. get:
  195. tags:
  196. - "entities"
  197. description: "Get list of available entities statuses"
  198. parameters: []
  199. responses:
  200. 200:
  201. description: "Status List Response"
  202. schema:
  203. required:
  204. - "data"
  205. type: "object"
  206. properties:
  207. jsonapi:
  208. $ref: "#/definitions/JsonApiElement"
  209. data:
  210. $ref: "#/definitions/StatusListResponseData"
  211. links:
  212. $ref: "#/definitions/Links"
  213. 403:
  214. description: "Forbidden"
  215. schema:
  216. $ref: "#/definitions/ErrorSchema"
  217. /entities/{id}/status:
  218. get:
  219. tags:
  220. - "entities"
  221. description: "Get list of statuses for a single entity"
  222. parameters: []
  223. responses:
  224. 200:
  225. description: "Status List Response"
  226. schema:
  227. required:
  228. - "data"
  229. type: "object"
  230. properties:
  231. jsonapi:
  232. $ref: "#/definitions/JsonApiElement"
  233. data:
  234. $ref: "#/definitions/StatusListResponseData"
  235. links:
  236. $ref: "#/definitions/Links"
  237. 403:
  238. description: "Forbidden"
  239. schema:
  240. $ref: "#/definitions/ErrorSchema"
  241. parameters:
  242. - name: "id"
  243. in: "path"
  244. required: true
  245. type: "integer"
  246. /entities/status/{id}:
  247. get:
  248. tags:
  249. - "entities"
  250. description: "Get status for a single entity"
  251. parameters: []
  252. responses:
  253. 200:
  254. description: "Status Response"
  255. schema:
  256. required:
  257. - "data"
  258. type: "object"
  259. properties:
  260. jsonapi:
  261. $ref: "#/definitions/JsonApiElement"
  262. data:
  263. $ref: "#/definitions/StatusResponseData"
  264. links:
  265. $ref: "#/definitions/Links"
  266. 403:
  267. description: "Forbidden"
  268. schema:
  269. $ref: "#/definitions/ErrorSchema"
  270. parameters:
  271. - name: "id"
  272. in: "path"
  273. required: true
  274. type: "integer"
  275. /entities/{id}/pocs:
  276. get:
  277. tags:
  278. - "entities"
  279. description: "Get all pocs(User and Role) for a single entity"
  280. parameters: []
  281. responses:
  282. 200:
  283. description: "EntityPoc List Response"
  284. schema:
  285. required:
  286. - "data"
  287. type: "object"
  288. properties:
  289. jsonapi:
  290. $ref: "#/definitions/JsonApiElement"
  291. data:
  292. $ref: "#/definitions/PocListResponseData"
  293. 404:
  294. description: "Not Found"
  295. schema:
  296. $ref: "#/definitions/ErrorSchema"
  297. post:
  298. tags:
  299. - "entities"
  300. description: "Create a new poc for entitiy"
  301. consumes: []
  302. parameters:
  303. - name: "body"
  304. in: "body"
  305. required: true
  306. schema:
  307. $ref: "#/definitions/EntityPocPostRequestData"
  308. responses:
  309. 200:
  310. description: "EntityPoc Response"
  311. schema:
  312. required:
  313. - "data"
  314. type: "object"
  315. properties:
  316. jsonapi:
  317. $ref: "#/definitions/JsonApiElement"
  318. data:
  319. $ref: "#/definitions/PocResponseData"
  320. 404:
  321. description: "Not Found"
  322. schema:
  323. $ref: "#/definitions/ErrorSchema"
  324. parameters:
  325. - name: "id"
  326. in: "path"
  327. required: true
  328. type: "integer"
  329. /entities/pocs/{poc_id}:
  330. get:
  331. tags:
  332. - "entities"
  333. description: "Get single poc information"
  334. parameters: []
  335. responses:
  336. 200:
  337. description: "EntityPoc Response"
  338. schema:
  339. required:
  340. - "data"
  341. type: "object"
  342. properties:
  343. jsonapi:
  344. $ref: "#/definitions/JsonApiElement"
  345. data:
  346. $ref: "#/definitions/PocResponseData"
  347. 404:
  348. description: "Not Found"
  349. schema:
  350. $ref: "#/definitions/ErrorSchema"
  351. delete:
  352. tags:
  353. - "entities"
  354. description: "Delete the EntityPoc"
  355. parameters: []
  356. responses:
  357. 204:
  358. description: "No Content"
  359. 404:
  360. description: "Not Found"
  361. schema:
  362. $ref: "#/definitions/ErrorSchema"
  363. parameters:
  364. - name: "poc_id"
  365. in: "path"
  366. required: true
  367. type: "integer"
  368. /entities/{id}/relationships/snmp_credentials:
  369. patch:
  370. consumes: []
  371. parameters:
  372. - name: "body"
  373. in: "body"
  374. required: true
  375. schema:
  376. type: "object"
  377. required:
  378. - "data"
  379. properties:
  380. data:
  381. $ref: "#/definitions/RelationshipObject"
  382. responses:
  383. 204:
  384. description: "Status 204"
  385. 403:
  386. description: "Forbidden"
  387. schema:
  388. $ref: "#/definitions/ErrorSchema"
  389. 404:
  390. description: "Not Found"
  391. schema:
  392. $ref: "#/definitions/ErrorSchema"
  393. parameters:
  394. - name: "id"
  395. in: "path"
  396. required: true
  397. type: "string"
  398. /entities/{id}/relationships/snmp_credentials/{id}:
  399. get:
  400. parameters: []
  401. responses:
  402. 200:
  403. description: "Relationship Response"
  404. schema:
  405. required:
  406. - "data"
  407. type: "object"
  408. properties:
  409. data:
  410. $ref: "#/definitions/SnmpCredentialResponseData"
  411. jsonapi:
  412. $ref: "#/definitions/JsonApiElement"
  413. parameters:
  414. - name: "id"
  415. in: "path"
  416. required: true
  417. type: "string"
  418. /performance/entities:
  419. get:
  420. tags:
  421. - "performance"
  422. description: "Get a list of the entities with configured performance metrics"
  423. parameters: []
  424. responses:
  425. 200:
  426. description: "Entity Performance List Response"
  427. schema:
  428. required:
  429. - "data"
  430. type: "object"
  431. properties:
  432. jsonapi:
  433. $ref: "#/definitions/JsonApiElement"
  434. data:
  435. type: "array"
  436. items:
  437. type: "object"
  438. properties:
  439. type:
  440. type: "string"
  441. default: "entity"
  442. id:
  443. type: "integer"
  444. entity:
  445. type: "string"
  446. links:
  447. $ref: "#/definitions/Links"
  448. links:
  449. $ref: "#/definitions/Links"
  450. 403:
  451. description: "Forbidden"
  452. schema:
  453. $ref: "#/definitions/ErrorSchema"
  454. /performance/entities/{id}/metrics:
  455. get:
  456. tags:
  457. - "performance"
  458. description: "Get information about the configured metrics on the entity"
  459. parameters:
  460. - name: "fields"
  461. in: "query"
  462. required: false
  463. type: "array"
  464. description: "## Fields Format:\n\nThe `fields` parameter uses a comma-separated-value\
  465. \ list to request a sparse fieldset for the response.\nThe parameter may\
  466. \ be repeated for each unique type. When a returned type is not present\
  467. \ here, the\nresponse will include all of its attributes. The format of\
  468. \ its value is:\n\n`fields[{type}]={attr}[,{attr}...]`\n\n## Fields Example:\n\
  469. \n`fields[channel]=id,name,expirationPeriod&fields[method]=id,name`\n"
  470. items:
  471. type: "string"
  472. responses:
  473. 200:
  474. description: "Entity Performance Metrics List Response"
  475. schema:
  476. required:
  477. - "data"
  478. type: "object"
  479. properties:
  480. jsonapi:
  481. $ref: "#/definitions/JsonApiElement"
  482. data:
  483. type: "array"
  484. items:
  485. $ref: "#/definitions/EntityPerformanceMetricDataAttributes"
  486. links:
  487. $ref: "#/definitions/Links"
  488. 403:
  489. description: "Forbidden"
  490. schema:
  491. $ref: "#/definitions/ErrorSchema"
  492. 404:
  493. description: "Not Found"
  494. schema:
  495. $ref: "#/definitions/ErrorSchema"
  496. parameters:
  497. - name: "id"
  498. in: "path"
  499. required: true
  500. type: "integer"
  501. /performance/entities/{id}/metrics/{metricId}:
  502. get:
  503. tags:
  504. - "performance"
  505. description: "Get information about entity's metrics"
  506. parameters: []
  507. responses:
  508. 200:
  509. description: "Entity Performance Metric Response"
  510. schema:
  511. required:
  512. - "data"
  513. type: "object"
  514. properties:
  515. jsonapi:
  516. $ref: "#/definitions/JsonApiElement"
  517. data:
  518. $ref: "#/definitions/EntityPerformanceMetricDataAttributes"
  519. links:
  520. $ref: "#/definitions/Links"
  521. 403:
  522. description: "Forbidden"
  523. schema:
  524. $ref: "#/definitions/ErrorSchema"
  525. 404:
  526. description: "Not Found"
  527. schema:
  528. $ref: "#/definitions/ErrorSchema"
  529. parameters:
  530. - name: "id"
  531. in: "path"
  532. required: true
  533. type: "integer"
  534. - name: "metricId"
  535. in: "path"
  536. required: true
  537. type: "integer"
  538. /locations:
  539. get:
  540. tags:
  541. - "locations"
  542. description: "Get list of available locations"
  543. parameters: []
  544. responses:
  545. 200:
  546. description: "Location List Response"
  547. schema:
  548. required:
  549. - "data"
  550. type: "object"
  551. properties:
  552. jsonapi:
  553. $ref: "#/definitions/JsonApiElement"
  554. data:
  555. $ref: "#/definitions/LocationListResponseData"
  556. links:
  557. $ref: "#/definitions/Links"
  558. 403:
  559. description: "Forbidden"
  560. schema:
  561. $ref: "#/definitions/ErrorSchema"
  562. post:
  563. tags:
  564. - "locations"
  565. description: "Create new location"
  566. consumes: []
  567. parameters:
  568. - name: "body"
  569. in: "body"
  570. required: true
  571. schema:
  572. $ref: "#/definitions/LocationCreateRequest"
  573. responses:
  574. 201:
  575. description: "Location Response"
  576. schema:
  577. required:
  578. - "data"
  579. type: "object"
  580. properties:
  581. jsonapi:
  582. $ref: "#/definitions/JsonApiElement"
  583. data:
  584. $ref: "#/definitions/LocationResponseData"
  585. links:
  586. $ref: "#/definitions/Links"
  587. 403:
  588. description: "Forbidden"
  589. schema:
  590. $ref: "#/definitions/ErrorSchema"
  591. /locations/{id}:
  592. get:
  593. tags:
  594. - "locations"
  595. description: "Get information about a single location"
  596. parameters: []
  597. responses:
  598. 200:
  599. description: "Entity Response"
  600. schema:
  601. required:
  602. - "data"
  603. type: "object"
  604. properties:
  605. jsonapi:
  606. $ref: "#/definitions/JsonApiElement"
  607. data:
  608. $ref: "#/definitions/EntityResponseData"
  609. links:
  610. $ref: "#/definitions/Links"
  611. 403:
  612. description: "Forbidden"
  613. schema:
  614. $ref: "#/definitions/ErrorSchema"
  615. 404:
  616. description: "Not Found"
  617. schema:
  618. $ref: "#/definitions/ErrorSchema"
  619. delete:
  620. tags:
  621. - "locations"
  622. description: "Remove a specific entity"
  623. parameters: []
  624. responses:
  625. 204:
  626. description: "No Content"
  627. 403:
  628. description: "Forbidden"
  629. schema:
  630. $ref: "#/definitions/ErrorSchema"
  631. 404:
  632. description: "Not Found"
  633. schema:
  634. $ref: "#/definitions/ErrorSchema"
  635. patch:
  636. tags:
  637. - "locations"
  638. description: "Update specific location"
  639. consumes: []
  640. parameters:
  641. - name: "body"
  642. in: "body"
  643. required: true
  644. schema:
  645. $ref: "#/definitions/LocationPatchRequest"
  646. responses:
  647. 204:
  648. description: "No Content"
  649. 403:
  650. description: "Forbidden"
  651. schema:
  652. $ref: "#/definitions/ErrorSchema"
  653. 404:
  654. description: "Not Found"
  655. schema:
  656. $ref: "#/definitions/ErrorSchema"
  657. parameters:
  658. - name: "id"
  659. in: "path"
  660. required: true
  661. type: "integer"
  662. /snmp_credentials:
  663. get:
  664. tags:
  665. - "snmp_credentials"
  666. description: "Get list of available snmp_credentials"
  667. parameters: []
  668. responses:
  669. 200:
  670. description: "Snmp_credentials List Response"
  671. schema:
  672. required:
  673. - "data"
  674. type: "object"
  675. properties:
  676. jsonapi:
  677. $ref: "#/definitions/JsonApiElement"
  678. data:
  679. $ref: "#/definitions/SnmpCredentialListResponseData"
  680. links:
  681. $ref: "#/definitions/Links"
  682. 403:
  683. description: "Forbidden"
  684. schema:
  685. $ref: "#/definitions/ErrorSchema"
  686. post:
  687. tags:
  688. - "snmp_credentials"
  689. description: "Create new snmp_credential"
  690. consumes: []
  691. parameters:
  692. - name: "body"
  693. in: "body"
  694. required: true
  695. schema:
  696. $ref: "#/definitions/SnmpCredentialCreateRequest"
  697. responses:
  698. 201:
  699. description: "Snmp_credential Response"
  700. schema:
  701. required:
  702. - "data"
  703. type: "object"
  704. properties:
  705. jsonapi:
  706. $ref: "#/definitions/JsonApiElement"
  707. data:
  708. $ref: "#/definitions/SnmpCredentialResponseData"
  709. links:
  710. $ref: "#/definitions/Links"
  711. 403:
  712. description: "Forbidden"
  713. schema:
  714. $ref: "#/definitions/ErrorSchema"
  715. /snmp_credentials/{id}:
  716. get:
  717. tags:
  718. - "snmp_credentials"
  719. description: "Get information about a single snmp_credential"
  720. parameters: []
  721. responses:
  722. 200:
  723. description: "Snmp_credential Response"
  724. schema:
  725. required:
  726. - "data"
  727. type: "object"
  728. properties:
  729. jsonapi:
  730. $ref: "#/definitions/JsonApiElement"
  731. data:
  732. $ref: "#/definitions/SnmpCredentialResponseData"
  733. links:
  734. $ref: "#/definitions/Links"
  735. 403:
  736. description: "Forbidden"
  737. schema:
  738. $ref: "#/definitions/ErrorSchema"
  739. 404:
  740. description: "Not Found"
  741. schema:
  742. $ref: "#/definitions/ErrorSchema"
  743. delete:
  744. tags:
  745. - "snmp_credentials"
  746. description: "Remove a specific snmp_credential"
  747. parameters: []
  748. responses:
  749. 204:
  750. description: "No Content"
  751. 403:
  752. description: "Forbidden"
  753. schema:
  754. $ref: "#/definitions/ErrorSchema"
  755. 404:
  756. description: "Not Found"
  757. schema:
  758. $ref: "#/definitions/ErrorSchema"
  759. patch:
  760. tags:
  761. - "snmp_credentials"
  762. description: "Update specific snmp_credential"
  763. consumes: []
  764. parameters:
  765. - name: "body"
  766. in: "body"
  767. required: true
  768. schema:
  769. $ref: "#/definitions/SnmpCredentialPatchRequest"
  770. responses:
  771. 204:
  772. description: "No Content"
  773. 403:
  774. description: "Forbidden"
  775. schema:
  776. $ref: "#/definitions/ErrorSchema"
  777. 404:
  778. description: "Not Found"
  779. schema:
  780. $ref: "#/definitions/ErrorSchema"
  781. parameters:
  782. - name: "id"
  783. in: "path"
  784. required: true
  785. type: "integer"
  786. /groups:
  787. get:
  788. tags:
  789. - "groups"
  790. description: "Get list of available groups"
  791. parameters: []
  792. responses:
  793. 200:
  794. description: "Group List Response"
  795. schema:
  796. required:
  797. - "data"
  798. type: "object"
  799. properties:
  800. jsonapi:
  801. $ref: "#/definitions/JsonApiElement"
  802. data:
  803. $ref: "#/definitions/GroupListResponseData"
  804. links:
  805. $ref: "#/definitions/Links"
  806. 403:
  807. description: "Forbidden"
  808. schema:
  809. $ref: "#/definitions/ErrorSchema"
  810. post:
  811. tags:
  812. - "groups"
  813. description: "Create new group"
  814. consumes: []
  815. parameters:
  816. - name: "body"
  817. in: "body"
  818. required: true
  819. schema:
  820. $ref: "#/definitions/GroupCreateRequest"
  821. responses:
  822. 201:
  823. description: "Group Response"
  824. schema:
  825. required:
  826. - "data"
  827. type: "object"
  828. properties:
  829. jsonapi:
  830. $ref: "#/definitions/JsonApiElement"
  831. data:
  832. $ref: "#/definitions/GroupResponseData"
  833. links:
  834. $ref: "#/definitions/Links"
  835. 403:
  836. description: "Forbidden"
  837. schema:
  838. $ref: "#/definitions/ErrorSchema"
  839. /groups/{id}:
  840. get:
  841. tags:
  842. - "groups"
  843. description: "Get information about a single group"
  844. parameters: []
  845. responses:
  846. 200:
  847. description: "Group Response"
  848. schema:
  849. required:
  850. - "data"
  851. type: "object"
  852. properties:
  853. jsonapi:
  854. $ref: "#/definitions/JsonApiElement"
  855. data:
  856. $ref: "#/definitions/GroupResponseData"
  857. links:
  858. $ref: "#/definitions/Links"
  859. 403:
  860. description: "Forbidden"
  861. schema:
  862. $ref: "#/definitions/ErrorSchema"
  863. 404:
  864. description: "Not Found"
  865. schema:
  866. $ref: "#/definitions/ErrorSchema"
  867. delete:
  868. tags:
  869. - "groups"
  870. description: "Remove a specific group"
  871. parameters: []
  872. responses:
  873. 204:
  874. description: "No Content"
  875. 403:
  876. description: "Forbidden"
  877. schema:
  878. $ref: "#/definitions/ErrorSchema"
  879. 404:
  880. description: "Not Found"
  881. schema:
  882. $ref: "#/definitions/ErrorSchema"
  883. patch:
  884. tags:
  885. - "groups"
  886. description: "Update specific group"
  887. consumes: []
  888. parameters:
  889. - name: "body"
  890. in: "body"
  891. required: true
  892. schema:
  893. $ref: "#/definitions/GroupPatchRequest"
  894. responses:
  895. 204:
  896. description: "No Content"
  897. 403:
  898. description: "Forbidden"
  899. schema:
  900. $ref: "#/definitions/ErrorSchema"
  901. 404:
  902. description: "Not Found"
  903. schema:
  904. $ref: "#/definitions/ErrorSchema"
  905. parameters:
  906. - name: "id"
  907. in: "path"
  908. required: true
  909. type: "integer"
  910. /categories:
  911. get:
  912. tags:
  913. - "categories"
  914. description: "Get list of available categories"
  915. parameters: []
  916. responses:
  917. 200:
  918. description: "Category List Response"
  919. schema:
  920. required:
  921. - "data"
  922. type: "object"
  923. properties:
  924. jsonapi:
  925. $ref: "#/definitions/JsonApiElement"
  926. data:
  927. $ref: "#/definitions/CategoryListResponseData"
  928. links:
  929. $ref: "#/definitions/Links"
  930. 403:
  931. description: "Forbidden"
  932. schema:
  933. $ref: "#/definitions/ErrorSchema"
  934. post:
  935. tags:
  936. - "categories"
  937. description: "Create new group"
  938. consumes: []
  939. parameters:
  940. - name: "body"
  941. in: "body"
  942. required: true
  943. schema:
  944. $ref: "#/definitions/CategoryCreateRequest"
  945. responses:
  946. 201:
  947. description: "Category Response"
  948. schema:
  949. required:
  950. - "data"
  951. type: "object"
  952. properties:
  953. jsonapi:
  954. $ref: "#/definitions/JsonApiElement"
  955. data:
  956. $ref: "#/definitions/CategoryResponseData"
  957. links:
  958. $ref: "#/definitions/Links"
  959. 403:
  960. description: "Forbidden"
  961. schema:
  962. $ref: "#/definitions/ErrorSchema"
  963. /categories/{id}:
  964. get:
  965. tags:
  966. - "categories"
  967. description: "Get information about a single category"
  968. parameters: []
  969. responses:
  970. 200:
  971. description: "Category Response"
  972. schema:
  973. required:
  974. - "data"
  975. type: "object"
  976. properties:
  977. jsonapi:
  978. $ref: "#/definitions/JsonApiElement"
  979. data:
  980. $ref: "#/definitions/CategoryResponseData"
  981. links:
  982. $ref: "#/definitions/Links"
  983. 403:
  984. description: "Forbidden"
  985. schema:
  986. $ref: "#/definitions/ErrorSchema"
  987. 404:
  988. description: "Not Found"
  989. schema:
  990. $ref: "#/definitions/ErrorSchema"
  991. delete:
  992. tags:
  993. - "categories"
  994. description: "Remove a specific category"
  995. parameters: []
  996. responses:
  997. 204:
  998. description: "No Content"
  999. 403:
  1000. description: "Forbidden"
  1001. schema:
  1002. $ref: "#/definitions/ErrorSchema"
  1003. 404:
  1004. description: "Not Found"
  1005. schema:
  1006. $ref: "#/definitions/ErrorSchema"
  1007. patch:
  1008. tags:
  1009. - "categories"
  1010. description: "Update specific category"
  1011. consumes: []
  1012. parameters:
  1013. - name: "body"
  1014. in: "body"
  1015. required: true
  1016. schema:
  1017. $ref: "#/definitions/CategoryPatchRequest"
  1018. responses:
  1019. 204:
  1020. description: "No Content"
  1021. 403:
  1022. description: "Forbidden"
  1023. schema:
  1024. $ref: "#/definitions/ErrorSchema"
  1025. 404:
  1026. description: "Not Found"
  1027. schema:
  1028. $ref: "#/definitions/ErrorSchema"
  1029. parameters:
  1030. - name: "id"
  1031. in: "path"
  1032. required: true
  1033. type: "integer"
  1034. /polling_groups:
  1035. get:
  1036. tags:
  1037. - "polling_groups"
  1038. description: "Get list of available polling groups"
  1039. parameters: []
  1040. responses:
  1041. 200:
  1042. description: "PollingGroup List Response"
  1043. schema:
  1044. required:
  1045. - "data"
  1046. type: "object"
  1047. properties:
  1048. jsonapi:
  1049. $ref: "#/definitions/JsonApiElement"
  1050. data:
  1051. $ref: "#/definitions/PollingGroupListResponseData"
  1052. links:
  1053. $ref: "#/definitions/Links"
  1054. 403:
  1055. description: "Forbidden"
  1056. schema:
  1057. $ref: "#/definitions/ErrorSchema"
  1058. post:
  1059. tags:
  1060. - "polling_groups"
  1061. description: "Create new polling group"
  1062. consumes: []
  1063. parameters:
  1064. - name: "body"
  1065. in: "body"
  1066. required: true
  1067. schema:
  1068. $ref: "#/definitions/PollingGroupCreateRequest"
  1069. responses:
  1070. 201:
  1071. description: "PollingGroup Response"
  1072. schema:
  1073. required:
  1074. - "data"
  1075. type: "object"
  1076. properties:
  1077. jsonapi:
  1078. $ref: "#/definitions/JsonApiElement"
  1079. data:
  1080. $ref: "#/definitions/PollingGroupResponseData"
  1081. links:
  1082. $ref: "#/definitions/Links"
  1083. 403:
  1084. description: "Forbidden"
  1085. schema:
  1086. $ref: "#/definitions/ErrorSchema"
  1087. /polling_groups/{id}:
  1088. get:
  1089. tags:
  1090. - "polling_groups"
  1091. description: "Get information about a single polling group"
  1092. parameters: []
  1093. responses:
  1094. 200:
  1095. description: "PollingGroup Response"
  1096. schema:
  1097. required:
  1098. - "data"
  1099. type: "object"
  1100. properties:
  1101. jsonapi:
  1102. $ref: "#/definitions/JsonApiElement"
  1103. data:
  1104. $ref: "#/definitions/PollingGroupResponseData"
  1105. links:
  1106. $ref: "#/definitions/Links"
  1107. 403:
  1108. description: "Forbidden"
  1109. schema:
  1110. $ref: "#/definitions/ErrorSchema"
  1111. 404:
  1112. description: "Not Found"
  1113. schema:
  1114. $ref: "#/definitions/ErrorSchema"
  1115. delete:
  1116. tags:
  1117. - "polling_groups"
  1118. description: "Remove a specific polling group"
  1119. parameters: []
  1120. responses:
  1121. 204:
  1122. description: "No Content"
  1123. 403:
  1124. description: "Forbidden"
  1125. schema:
  1126. $ref: "#/definitions/ErrorSchema"
  1127. 404:
  1128. description: "Not Found"
  1129. schema:
  1130. $ref: "#/definitions/ErrorSchema"
  1131. patch:
  1132. tags:
  1133. - "polling_groups"
  1134. description: "Update specific polling group"
  1135. consumes: []
  1136. parameters:
  1137. - name: "body"
  1138. in: "body"
  1139. required: true
  1140. schema:
  1141. $ref: "#/definitions/PollingGroupPatchRequest"
  1142. responses:
  1143. 204:
  1144. description: "No Content"
  1145. 403:
  1146. description: "Forbidden"
  1147. schema:
  1148. $ref: "#/definitions/ErrorSchema"
  1149. 404:
  1150. description: "Not Found"
  1151. schema:
  1152. $ref: "#/definitions/ErrorSchema"
  1153. parameters:
  1154. - name: "id"
  1155. in: "path"
  1156. required: true
  1157. type: "integer"
  1158. /support_contracts:
  1159. get:
  1160. tags:
  1161. - "support_contracts"
  1162. description: "Get list of available support contracts"
  1163. parameters: []
  1164. responses:
  1165. 200:
  1166. description: "SupportContract List Response"
  1167. schema:
  1168. required:
  1169. - "data"
  1170. type: "object"
  1171. properties:
  1172. jsonapi:
  1173. $ref: "#/definitions/JsonApiElement"
  1174. data:
  1175. $ref: "#/definitions/SupportContractListResponseData"
  1176. links:
  1177. $ref: "#/definitions/Links"
  1178. 403:
  1179. description: "Forbidden"
  1180. schema:
  1181. $ref: "#/definitions/ErrorSchema"
  1182. post:
  1183. tags:
  1184. - "support_contracts"
  1185. description: "Create new support contract"
  1186. consumes: []
  1187. parameters:
  1188. - name: "body"
  1189. in: "body"
  1190. required: true
  1191. schema:
  1192. $ref: "#/definitions/SupportContractCreateRequest"
  1193. responses:
  1194. 201:
  1195. description: "SupportContract Response"
  1196. schema:
  1197. required:
  1198. - "data"
  1199. type: "object"
  1200. properties:
  1201. jsonapi:
  1202. $ref: "#/definitions/JsonApiElement"
  1203. data:
  1204. $ref: "#/definitions/SupportContractResponseData"
  1205. links:
  1206. $ref: "#/definitions/Links"
  1207. 403:
  1208. description: "Forbidden"
  1209. schema:
  1210. $ref: "#/definitions/ErrorSchema"
  1211. /support_contracts/{id}:
  1212. get:
  1213. tags:
  1214. - "support_contracts"
  1215. description: "Get information about a single support contract"
  1216. parameters: []
  1217. responses:
  1218. 200:
  1219. description: "SupportContract Response"
  1220. schema:
  1221. required:
  1222. - "data"
  1223. type: "object"
  1224. properties:
  1225. jsonapi:
  1226. $ref: "#/definitions/JsonApiElement"
  1227. data:
  1228. $ref: "#/definitions/SupportContractResponseData"
  1229. links:
  1230. $ref: "#/definitions/Links"
  1231. 403:
  1232. description: "Forbidden"
  1233. schema:
  1234. $ref: "#/definitions/ErrorSchema"
  1235. 404:
  1236. description: "Not Found"
  1237. schema:
  1238. $ref: "#/definitions/ErrorSchema"
  1239. delete:
  1240. tags:
  1241. - "support_contracts"
  1242. description: "Remove a specific support contract"
  1243. parameters: []
  1244. responses:
  1245. 204:
  1246. description: "No Content"
  1247. 403:
  1248. description: "Forbidden"
  1249. schema:
  1250. $ref: "#/definitions/ErrorSchema"
  1251. 404:
  1252. description: "Not Found"
  1253. schema:
  1254. $ref: "#/definitions/ErrorSchema"
  1255. patch:
  1256. tags:
  1257. - "support_contracts"
  1258. description: "Update specific support contract"
  1259. consumes: []
  1260. parameters:
  1261. - name: "body"
  1262. in: "body"
  1263. required: true
  1264. schema:
  1265. $ref: "#/definitions/SupportContractPatchRequest"
  1266. responses:
  1267. 204:
  1268. description: "No Content"
  1269. 403:
  1270. description: "Forbidden"
  1271. schema:
  1272. $ref: "#/definitions/ErrorSchema"
  1273. 404:
  1274. description: "Not Found"
  1275. schema:
  1276. $ref: "#/definitions/ErrorSchema"
  1277. parameters:
  1278. - name: "id"
  1279. in: "path"
  1280. required: true
  1281. type: "integer"
  1282. /support_programs:
  1283. get:
  1284. tags:
  1285. - "support_programs"
  1286. description: "Get list of available support programs"
  1287. parameters: []
  1288. responses:
  1289. 200:
  1290. description: "SupportProgram List Response"
  1291. schema:
  1292. required:
  1293. - "data"
  1294. type: "object"
  1295. properties:
  1296. jsonapi:
  1297. $ref: "#/definitions/JsonApiElement"
  1298. data:
  1299. $ref: "#/definitions/SupportProgramListResponseData"
  1300. links:
  1301. $ref: "#/definitions/Links"
  1302. 403:
  1303. description: "Forbidden"
  1304. schema:
  1305. $ref: "#/definitions/ErrorSchema"
  1306. post:
  1307. tags:
  1308. - "support_programs"
  1309. description: "Create new support program"
  1310. consumes: []
  1311. parameters:
  1312. - name: "body"
  1313. in: "body"
  1314. required: true
  1315. schema:
  1316. $ref: "#/definitions/SupportProgramCreateRequest"
  1317. responses:
  1318. 201:
  1319. description: "SupportProgram Response"
  1320. schema:
  1321. required:
  1322. - "data"
  1323. type: "object"
  1324. properties:
  1325. jsonapi:
  1326. $ref: "#/definitions/JsonApiElement"
  1327. data:
  1328. $ref: "#/definitions/SupportProgramResponseData"
  1329. links:
  1330. $ref: "#/definitions/Links"
  1331. 403:
  1332. description: "Forbidden"
  1333. schema:
  1334. $ref: "#/definitions/ErrorSchema"
  1335. /support_programs/{id}:
  1336. get:
  1337. tags:
  1338. - "support_programs"
  1339. description: "Get information about a single support program"
  1340. parameters: []
  1341. responses:
  1342. 200:
  1343. description: "SupportProgram Response"
  1344. schema:
  1345. required:
  1346. - "data"
  1347. type: "object"
  1348. properties:
  1349. jsonapi:
  1350. $ref: "#/definitions/JsonApiElement"
  1351. data:
  1352. $ref: "#/definitions/SupportProgramResponseData"
  1353. links:
  1354. $ref: "#/definitions/Links"
  1355. 403:
  1356. description: "Forbidden"
  1357. schema:
  1358. $ref: "#/definitions/ErrorSchema"
  1359. 404:
  1360. description: "Not Found"
  1361. schema:
  1362. $ref: "#/definitions/ErrorSchema"
  1363. delete:
  1364. tags:
  1365. - "support_programs"
  1366. description: "Remove a specific support program"
  1367. parameters: []
  1368. responses:
  1369. 204:
  1370. description: "No Content"
  1371. 403:
  1372. description: "Forbidden"
  1373. schema:
  1374. $ref: "#/definitions/ErrorSchema"
  1375. 404:
  1376. description: "Not Found"
  1377. schema:
  1378. $ref: "#/definitions/ErrorSchema"
  1379. patch:
  1380. tags:
  1381. - "support_programs"
  1382. description: "Update specific support program"
  1383. consumes: []
  1384. parameters:
  1385. - name: "body"
  1386. in: "body"
  1387. required: true
  1388. schema:
  1389. $ref: "#/definitions/SupportProgramPatchRequest"
  1390. responses:
  1391. 204:
  1392. description: "No Content"
  1393. 403:
  1394. description: "Forbidden"
  1395. schema:
  1396. $ref: "#/definitions/ErrorSchema"
  1397. 404:
  1398. description: "Not Found"
  1399. schema:
  1400. $ref: "#/definitions/ErrorSchema"
  1401. parameters:
  1402. - name: "id"
  1403. in: "path"
  1404. required: true
  1405. type: "integer"
  1406. /def_ccm_credentials:
  1407. get:
  1408. tags:
  1409. - "def_ccm_credentials"
  1410. description: "Get list of available def_ccm_credentials"
  1411. parameters: []
  1412. responses:
  1413. 200:
  1414. description: "DefCcmCredentials List Response"
  1415. schema:
  1416. required:
  1417. - "data"
  1418. type: "object"
  1419. properties:
  1420. jsonapi:
  1421. $ref: "#/definitions/JsonApiElement"
  1422. data:
  1423. $ref: "#/definitions/DefCcmCredentialListResponseData"
  1424. links:
  1425. $ref: "#/definitions/Links"
  1426. 403:
  1427. description: "Forbidden"
  1428. schema:
  1429. $ref: "#/definitions/ErrorSchema"
  1430. post:
  1431. tags:
  1432. - "def_ccm_credentials"
  1433. description: "Create new def_ccm_credentials"
  1434. consumes: []
  1435. parameters:
  1436. - name: "body"
  1437. in: "body"
  1438. required: true
  1439. schema:
  1440. $ref: "#/definitions/DefCcmCredentialCreateRequest"
  1441. responses:
  1442. 201:
  1443. description: "DefCcmCredentials Response"
  1444. schema:
  1445. required:
  1446. - "data"
  1447. type: "object"
  1448. properties:
  1449. jsonapi:
  1450. $ref: "#/definitions/JsonApiElement"
  1451. data:
  1452. $ref: "#/definitions/DefCcmCredentialResponseData"
  1453. links:
  1454. $ref: "#/definitions/Links"
  1455. 403:
  1456. description: "Forbidden"
  1457. schema:
  1458. $ref: "#/definitions/ErrorSchema"
  1459. /def_ccm_credentials/{id}:
  1460. get:
  1461. tags:
  1462. - "def_ccm_credentials"
  1463. description: "Get information about a single def_ccm_credentials id"
  1464. parameters: []
  1465. responses:
  1466. 200:
  1467. description: "DefCcmCredentials Response"
  1468. schema:
  1469. required:
  1470. - "data"
  1471. type: "object"
  1472. properties:
  1473. jsonapi:
  1474. $ref: "#/definitions/JsonApiElement"
  1475. data:
  1476. $ref: "#/definitions/DefCcmCredentialResponseData"
  1477. links:
  1478. $ref: "#/definitions/Links"
  1479. 403:
  1480. description: "Forbidden"
  1481. schema:
  1482. $ref: "#/definitions/ErrorSchema"
  1483. 404:
  1484. description: "Not Found"
  1485. schema:
  1486. $ref: "#/definitions/ErrorSchema"
  1487. delete:
  1488. tags:
  1489. - "def_ccm_credentials"
  1490. description: "Remove a specific def_ccm_credentials id"
  1491. parameters: []
  1492. responses:
  1493. 204:
  1494. description: "No Content"
  1495. 403:
  1496. description: "Forbidden"
  1497. schema:
  1498. $ref: "#/definitions/ErrorSchema"
  1499. 404:
  1500. description: "Not Found"
  1501. schema:
  1502. $ref: "#/definitions/ErrorSchema"
  1503. patch:
  1504. tags:
  1505. - "def_ccm_credentials"
  1506. description: "Update specific def_ccm_credentials id"
  1507. consumes: []
  1508. parameters:
  1509. - name: "body"
  1510. in: "body"
  1511. required: true
  1512. schema:
  1513. $ref: "#/definitions/DefCcmCredentialPatchRequest"
  1514. responses:
  1515. 204:
  1516. description: "No Content"
  1517. 403:
  1518. description: "Forbidden"
  1519. schema:
  1520. $ref: "#/definitions/ErrorSchema"
  1521. 404:
  1522. description: "Not Found"
  1523. schema:
  1524. $ref: "#/definitions/ErrorSchema"
  1525. parameters:
  1526. - name: "id"
  1527. in: "path"
  1528. required: true
  1529. type: "integer"
  1530. securityDefinitions:
  1531. HttpBasic:
  1532. type: "basic"
  1533. definitions:
  1534. JsonApiElement:
  1535. type: "object"
  1536. properties:
  1537. version:
  1538. type: "number"
  1539. Links:
  1540. type: "object"
  1541. ErrorSourceObject:
  1542. type: "object"
  1543. properties:
  1544. pointer:
  1545. type: "string"
  1546. description: "a JSON Pointer [RFC6901] to the associated entity in the request\
  1547. \ document"
  1548. parameter:
  1549. type: "string"
  1550. description: "a string indicating which URI query parameter caused the error"
  1551. MetaObject:
  1552. type: "object"
  1553. RelationshipObject:
  1554. type: "object"
  1555. required:
  1556. - "id"
  1557. - "type"
  1558. properties:
  1559. id:
  1560. type: "integer"
  1561. type:
  1562. type: "string"
  1563. RelationshipList:
  1564. type: "array"
  1565. items:
  1566. $ref: "#/definitions/RelationshipObject"
  1567. ErrorSchema:
  1568. type: "object"
  1569. required:
  1570. - "errors"
  1571. properties:
  1572. errors:
  1573. type: "array"
  1574. items:
  1575. $ref: "#/definitions/ErrorObject"
  1576. ErrorObject:
  1577. type: "object"
  1578. properties:
  1579. id:
  1580. type: "string"
  1581. description: "a unique identifier for this particular occurrence of the problem."
  1582. links:
  1583. $ref: "#/definitions/Links"
  1584. status:
  1585. type: "string"
  1586. description: "the HTTP status code applicable to this problem, expressed as\
  1587. \ a string value."
  1588. code:
  1589. type: "string"
  1590. description: "an application-specific error code, expressed as a string value."
  1591. title:
  1592. type: "string"
  1593. description: "a short, human-readable summary of the problem"
  1594. detail:
  1595. type: "string"
  1596. description: "a human-readable explanation specific to this occurrence of\
  1597. \ the problem"
  1598. source:
  1599. $ref: "#/definitions/ErrorSourceObject"
  1600. meta:
  1601. $ref: "#/definitions/MetaObject"
  1602. StatusListResponseData:
  1603. type: "array"
  1604. items:
  1605. $ref: "#/definitions/StatusResponseData"
  1606. StatusResponseData:
  1607. type: "object"
  1608. required:
  1609. - "attributes"
  1610. - "id"
  1611. - "type"
  1612. properties:
  1613. type:
  1614. type: "string"
  1615. id:
  1616. type: "integer"
  1617. attributes:
  1618. $ref: "#/definitions/StatusResponseDataAttributes"
  1619. links:
  1620. $ref: "#/definitions/Links"
  1621. StatusResponseDataAttributes:
  1622. type: "object"
  1623. properties:
  1624. name:
  1625. type: "string"
  1626. method:
  1627. type: "string"
  1628. instance:
  1629. type: "string"
  1630. entity:
  1631. type: "string"
  1632. status_type:
  1633. type: "string"
  1634. status_level:
  1635. type: "string"
  1636. status_date:
  1637. type: "string"
  1638. extra_info:
  1639. type: "string"
  1640. EntityListResponseData:
  1641. type: "array"
  1642. items:
  1643. $ref: "#/definitions/EntityResponseData"
  1644. EntityResponseData:
  1645. type: "object"
  1646. required:
  1647. - "attributes"
  1648. - "id"
  1649. - "type"
  1650. properties:
  1651. type:
  1652. type: "string"
  1653. default: "entity"
  1654. id:
  1655. type: "integer"
  1656. attributes:
  1657. $ref: "#/definitions/EntityResponseDataAttributes"
  1658. links:
  1659. $ref: "#/definitions/SelfLink"
  1660. EntityResponseDataAttributes:
  1661. type: "object"
  1662. properties:
  1663. name:
  1664. type: "string"
  1665. method:
  1666. type: "string"
  1667. instance:
  1668. type: "string"
  1669. entity:
  1670. type: "string"
  1671. description:
  1672. type: "string"
  1673. depend:
  1674. type: "string"
  1675. icon:
  1676. type: "string"
  1677. icon_large:
  1678. type: "string"
  1679. create_date:
  1680. type: "string"
  1681. format: "date-time"
  1682. last_update:
  1683. type: "string"
  1684. format: "date-time"
  1685. create_by:
  1686. type: "integer"
  1687. ip_addr_ipvx:
  1688. type: "string"
  1689. nat_addr_ipvx:
  1690. type: "string"
  1691. physical_address:
  1692. type: "string"
  1693. snmp_port:
  1694. type: "integer"
  1695. web_url:
  1696. type: "string"
  1697. model_num:
  1698. type: "string"
  1699. model_oid:
  1700. type: "string"
  1701. vendor:
  1702. type: "string"
  1703. serial_num:
  1704. type: "string"
  1705. override_deps:
  1706. type: "integer"
  1707. monitor_options:
  1708. type: "integer"
  1709. normal_status:
  1710. type: "integer"
  1711. escalation_policy_id:
  1712. type: "integer"
  1713. workflow_id:
  1714. type: "integer"
  1715. console_object:
  1716. type: "boolean"
  1717. spdevice:
  1718. type: "boolean"
  1719. lu_system_object_type_id:
  1720. type: "integer"
  1721. availability_report:
  1722. type: "boolean"
  1723. sla_report:
  1724. type: "boolean"
  1725. kpi_target:
  1726. type: "boolean"
  1727. outage_entity:
  1728. type: "boolean"
  1729. location:
  1730. type: "string"
  1731. unremovable:
  1732. type: "boolean"
  1733. health_check_entity:
  1734. type: "boolean"
  1735. caseworthy:
  1736. type: "integer"
  1737. location_id:
  1738. type: "integer"
  1739. snmp_version:
  1740. type: "string"
  1741. default: "1"
  1742. enum:
  1743. - "1"
  1744. - "2"
  1745. - "2c"
  1746. - "3"
  1747. exception_monitoring:
  1748. type: "string"
  1749. exception_support:
  1750. type: "string"
  1751. poller_group_id:
  1752. type: "integer"
  1753. product_type_id:
  1754. type: "integer"
  1755. sold_service_id:
  1756. type: "integer"
  1757. standards_sku_id:
  1758. type: "integer"
  1759. standards_device_id:
  1760. type: "integer"
  1761. is_oob_polling:
  1762. type: "integer"
  1763. EntityPatchRequest:
  1764. type: "object"
  1765. required:
  1766. - "data"
  1767. properties:
  1768. jsonapi:
  1769. $ref: "#/definitions/JsonApiElement"
  1770. data:
  1771. $ref: "#/definitions/EntityPatchData"
  1772. EntityPatchData:
  1773. type: "object"
  1774. required:
  1775. - "attributes"
  1776. - "id"
  1777. - "type"
  1778. properties:
  1779. type:
  1780. type: "string"
  1781. default: "entities"
  1782. id:
  1783. type: "string"
  1784. attributes:
  1785. $ref: "#/definitions/EntityPatchDataAttributes"
  1786. EntityPatchDataAttributes:
  1787. type: "object"
  1788. properties:
  1789. name:
  1790. type: "string"
  1791. method:
  1792. type: "string"
  1793. instance:
  1794. type: "string"
  1795. entity:
  1796. type: "string"
  1797. description:
  1798. type: "string"
  1799. depend:
  1800. type: "string"
  1801. icon:
  1802. type: "string"
  1803. icon_large:
  1804. type: "string"
  1805. create_date:
  1806. type: "string"
  1807. format: "date-time"
  1808. last_update:
  1809. type: "string"
  1810. format: "date-time"
  1811. create_by:
  1812. type: "integer"
  1813. ip_addr_ipvx:
  1814. type: "string"
  1815. nat_addr_ipvx:
  1816. type: "string"
  1817. physical_address:
  1818. type: "string"
  1819. snmp_port:
  1820. type: "integer"
  1821. web_url:
  1822. type: "string"
  1823. model_num:
  1824. type: "string"
  1825. model_oid:
  1826. type: "string"
  1827. vendor:
  1828. type: "string"
  1829. serial_num:
  1830. type: "string"
  1831. override_deps:
  1832. type: "integer"
  1833. monitor_options:
  1834. type: "integer"
  1835. normal_status:
  1836. type: "integer"
  1837. escalation_policy_id:
  1838. type: "integer"
  1839. workflow_id:
  1840. type: "integer"
  1841. console_object:
  1842. type: "boolean"
  1843. spdevice:
  1844. type: "boolean"
  1845. lu_system_object_type_id:
  1846. type: "integer"
  1847. availability_report:
  1848. type: "boolean"
  1849. sla_report:
  1850. type: "boolean"
  1851. kpi_target:
  1852. type: "boolean"
  1853. outage_entity:
  1854. type: "boolean"
  1855. location:
  1856. type: "string"
  1857. unremovable:
  1858. type: "boolean"
  1859. health_check_entity:
  1860. type: "boolean"
  1861. caseworthy:
  1862. type: "integer"
  1863. location_id:
  1864. type: "integer"
  1865. snmp_version:
  1866. type: "string"
  1867. default: "1"
  1868. enum:
  1869. - "1"
  1870. - "2"
  1871. - "2c"
  1872. - "3"
  1873. exception_monitoring:
  1874. type: "string"
  1875. exception_support:
  1876. type: "string"
  1877. poller_group_id:
  1878. type: "integer"
  1879. product_type_id:
  1880. type: "integer"
  1881. sold_service_id:
  1882. type: "integer"
  1883. standards_sku_id:
  1884. type: "integer"
  1885. standards_device_id:
  1886. type: "integer"
  1887. is_oob_polling:
  1888. type: "integer"
  1889. EntityCreateRequest:
  1890. type: "object"
  1891. required:
  1892. - "data"
  1893. properties:
  1894. jsonapi:
  1895. $ref: "#/definitions/JsonApiElement"
  1896. data:
  1897. $ref: "#/definitions/EntityCreateData"
  1898. EntityCreateData:
  1899. type: "object"
  1900. required:
  1901. - "attributes"
  1902. - "type"
  1903. properties:
  1904. type:
  1905. type: "string"
  1906. default: "entities"
  1907. attributes:
  1908. $ref: "#/definitions/EntityCreateDataAttributes"
  1909. EntityCreateDataAttributes:
  1910. type: "object"
  1911. properties:
  1912. name:
  1913. type: "string"
  1914. example: "TestEntity"
  1915. method:
  1916. type: "string"
  1917. example: "GRP"
  1918. instance:
  1919. type: "string"
  1920. example: "NODE"
  1921. entity:
  1922. type: "string"
  1923. example: "TestEntity::GRP::NODE"
  1924. description:
  1925. type: "string"
  1926. example: "This is a test entity"
  1927. depend:
  1928. type: "string"
  1929. icon:
  1930. type: "string"
  1931. icon_large:
  1932. type: "string"
  1933. create_date:
  1934. type: "string"
  1935. format: "date-time"
  1936. last_update:
  1937. type: "string"
  1938. format: "date-time"
  1939. create_by:
  1940. type: "integer"
  1941. ip_addr_ipvx:
  1942. type: "string"
  1943. nat_addr_ipvx:
  1944. type: "string"
  1945. physical_address:
  1946. type: "string"
  1947. snmp_port:
  1948. type: "integer"
  1949. web_url:
  1950. type: "string"
  1951. model_num:
  1952. type: "string"
  1953. model_oid:
  1954. type: "string"
  1955. vendor:
  1956. type: "string"
  1957. serial_num:
  1958. type: "string"
  1959. override_deps:
  1960. type: "integer"
  1961. monitor_options:
  1962. type: "integer"
  1963. normal_status:
  1964. type: "integer"
  1965. escalation_policy_id:
  1966. type: "integer"
  1967. workflow_id:
  1968. type: "integer"
  1969. console_object:
  1970. type: "boolean"
  1971. spdevice:
  1972. type: "boolean"
  1973. lu_system_object_type_id:
  1974. type: "integer"
  1975. availability_report:
  1976. type: "boolean"
  1977. sla_report:
  1978. type: "boolean"
  1979. kpi_target:
  1980. type: "boolean"
  1981. outage_entity:
  1982. type: "boolean"
  1983. location:
  1984. type: "string"
  1985. unremovable:
  1986. type: "boolean"
  1987. health_check_entity:
  1988. type: "boolean"
  1989. caseworthy:
  1990. type: "integer"
  1991. location_id:
  1992. type: "integer"
  1993. snmp_version:
  1994. type: "string"
  1995. default: "1"
  1996. enum:
  1997. - "1"
  1998. - "2"
  1999. - "2c"
  2000. - "3"
  2001. exception_monitoring:
  2002. type: "string"
  2003. exception_support:
  2004. type: "string"
  2005. poller_group_id:
  2006. type: "integer"
  2007. product_type_id:
  2008. type: "integer"
  2009. sold_service_id:
  2010. type: "integer"
  2011. standards_sku_id:
  2012. type: "integer"
  2013. standards_device_id:
  2014. type: "integer"
  2015. is_oob_polling:
  2016. type: "integer"
  2017. wlc_object:
  2018. type: "boolean"
  2019. EntityPerformanceMetricResponseDataAttributes:
  2020. type: "object"
  2021. properties:
  2022. metric_name:
  2023. type: "string"
  2024. data:
  2025. type: "array"
  2026. items:
  2027. type: "object"
  2028. properties:
  2029. timestamp:
  2030. type: "string"
  2031. value:
  2032. type: "string"
  2033. EntityPerformanceMetricDataAttributes:
  2034. type: "object"
  2035. properties:
  2036. id:
  2037. type: "integer"
  2038. type:
  2039. type: "string"
  2040. attributes:
  2041. type: "object"
  2042. properties:
  2043. id:
  2044. type: "integer"
  2045. device_name:
  2046. type: "string"
  2047. device_ipvx:
  2048. type: "string"
  2049. metric_name:
  2050. type: "string"
  2051. metric_desc:
  2052. type: "string"
  2053. metric_category:
  2054. type: "string"
  2055. metric_max_value:
  2056. type: "string"
  2057. metric_type:
  2058. type: "string"
  2059. monitoring_options:
  2060. type: "string"
  2061. expression:
  2062. type: "string"
  2063. target_list:
  2064. type: "string"
  2065. poll_type:
  2066. type: "string"
  2067. rrd_metric_alias:
  2068. type: "string"
  2069. rrd_filepath:
  2070. type: "string"
  2071. graph_legend_label:
  2072. type: "string"
  2073. LocationListResponseData:
  2074. type: "array"
  2075. items:
  2076. $ref: "#/definitions/LocationResponseData"
  2077. LocationResponseData:
  2078. type: "object"
  2079. required:
  2080. - "attributes"
  2081. - "id"
  2082. - "type"
  2083. properties:
  2084. type:
  2085. type: "string"
  2086. default: "locations"
  2087. id:
  2088. type: "integer"
  2089. attributes:
  2090. $ref: "#/definitions/LocationResponseDataAttributes"
  2091. links:
  2092. $ref: "#/definitions/Links"
  2093. LocationResponseDataAttributes:
  2094. type: "object"
  2095. properties:
  2096. name:
  2097. type: "string"
  2098. address1:
  2099. type: "string"
  2100. address2:
  2101. type: "string"
  2102. contact_name:
  2103. type: "string"
  2104. contact_phone:
  2105. type: "string"
  2106. contact_email:
  2107. type: "string"
  2108. city:
  2109. type: "string"
  2110. region:
  2111. type: "string"
  2112. postal_code:
  2113. type: "string"
  2114. country:
  2115. type: "string"
  2116. latitude:
  2117. type: "integer"
  2118. longitude:
  2119. type: "integer"
  2120. timezone_id:
  2121. type: "integer"
  2122. LocationPatchRequest:
  2123. type: "object"
  2124. required:
  2125. - "data"
  2126. properties:
  2127. jsonapi:
  2128. $ref: "#/definitions/JsonApiElement"
  2129. data:
  2130. $ref: "#/definitions/LocationPatchData"
  2131. LocationPatchData:
  2132. type: "object"
  2133. required:
  2134. - "attributes"
  2135. - "id"
  2136. - "type"
  2137. properties:
  2138. type:
  2139. type: "string"
  2140. default: "locations"
  2141. id:
  2142. type: "string"
  2143. attributes:
  2144. $ref: "#/definitions/LocationPatchDataAttributes"
  2145. LocationPatchDataAttributes:
  2146. type: "object"
  2147. properties:
  2148. name:
  2149. type: "string"
  2150. address1:
  2151. type: "string"
  2152. address2:
  2153. type: "string"
  2154. contact_name:
  2155. type: "string"
  2156. contact_phone:
  2157. type: "string"
  2158. contact_email:
  2159. type: "string"
  2160. city:
  2161. type: "string"
  2162. region:
  2163. type: "string"
  2164. postal_code:
  2165. type: "string"
  2166. country:
  2167. type: "string"
  2168. latitude:
  2169. type: "integer"
  2170. longitude:
  2171. type: "integer"
  2172. timezone_id:
  2173. type: "integer"
  2174. LocationCreateRequest:
  2175. type: "object"
  2176. required:
  2177. - "data"
  2178. properties:
  2179. jsonapi:
  2180. $ref: "#/definitions/JsonApiElement"
  2181. data:
  2182. $ref: "#/definitions/LocationCreateData"
  2183. LocationCreateData:
  2184. type: "object"
  2185. required:
  2186. - "attributes"
  2187. - "type"
  2188. properties:
  2189. type:
  2190. type: "string"
  2191. default: "locations"
  2192. attributes:
  2193. $ref: "#/definitions/LocationCreateDataAttributes"
  2194. LocationCreateDataAttributes:
  2195. type: "object"
  2196. properties:
  2197. name:
  2198. type: "string"
  2199. address1:
  2200. type: "string"
  2201. address2:
  2202. type: "string"
  2203. contact_name:
  2204. type: "string"
  2205. contact_phone:
  2206. type: "string"
  2207. contact_email:
  2208. type: "string"
  2209. city:
  2210. type: "string"
  2211. region:
  2212. type: "string"
  2213. postal_code:
  2214. type: "string"
  2215. country:
  2216. type: "string"
  2217. latitude:
  2218. type: "integer"
  2219. longitude:
  2220. type: "integer"
  2221. timezone_id:
  2222. type: "integer"
  2223. SnmpCredentialCreateRequest:
  2224. type: "object"
  2225. required:
  2226. - "data"
  2227. properties:
  2228. jsonapi:
  2229. $ref: "#/definitions/JsonApiElement"
  2230. data:
  2231. $ref: "#/definitions/SnmpCredentialCreateData"
  2232. SnmpCredentialCreateData:
  2233. type: "object"
  2234. required:
  2235. - "attributes"
  2236. - "type"
  2237. properties:
  2238. type:
  2239. type: "string"
  2240. default: "SnmpCredential"
  2241. attributes:
  2242. $ref: "#/definitions/SnmpCredentialCreateDataAttributes"
  2243. SnmpCredentialCreateDataAttributes:
  2244. type: "object"
  2245. properties:
  2246. snmp_credential_version_id:
  2247. type: "integer"
  2248. description: "Valid value is an integer 1 = v1, v2 = v2c , 3=v3"
  2249. port:
  2250. type: "integer"
  2251. community:
  2252. type: "string"
  2253. sec_name:
  2254. type: "string"
  2255. snmp_credential_security_level_id:
  2256. type: "integer"
  2257. description: "null for earlier snmp_versions, value is an integer 1=noAuthNoPrivValid,\
  2258. \ 2=authNoPriv, 3=authPriv "
  2259. snmp_credential_authentication_protocol_id:
  2260. type: "integer"
  2261. description: "null for earlier snmp_versions, value is an integer 1=MD5, 2=SHA"
  2262. snmp_credential_privacy_protocol_id:
  2263. type: "integer"
  2264. description: "null for earlier snmp_versions, 1=DES ,2=AES"
  2265. auth_passphrase:
  2266. type: "string"
  2267. priv_passphrase:
  2268. type: "string"
  2269. is_read_write:
  2270. type: "integer"
  2271. retries:
  2272. type: "integer"
  2273. timeout:
  2274. type: "integer"
  2275. throttle:
  2276. type: "integer"
  2277. SnmpCredentialListResponseData:
  2278. type: "array"
  2279. items:
  2280. $ref: "#/definitions/SnmpCredentialResponseData"
  2281. SnmpCredentialResponseData:
  2282. type: "object"
  2283. required:
  2284. - "attributes"
  2285. - "id"
  2286. - "type"
  2287. properties:
  2288. type:
  2289. type: "string"
  2290. default: "SnmpCredential"
  2291. id:
  2292. type: "integer"
  2293. attributes:
  2294. $ref: "#/definitions/SnmpCredentialResponseDataAttributes"
  2295. links:
  2296. $ref: "#/definitions/Links"
  2297. SnmpCredentialResponseDataAttributes:
  2298. type: "object"
  2299. properties:
  2300. snmp_credential_version_id:
  2301. type: "integer"
  2302. description: "Valid value is an integer 1 = v1, v2 = v2c , 3=v3"
  2303. port:
  2304. type: "integer"
  2305. community:
  2306. type: "string"
  2307. sec_name:
  2308. type: "string"
  2309. snmp_credential_security_level_id:
  2310. type: "integer"
  2311. description: "null for earlier snmp_versions, value is an integer 1=noAuthNoPrivValid,\
  2312. \ 2=authNoPriv, 3=authPriv "
  2313. snmp_credential_authentication_protocol_id:
  2314. type: "integer"
  2315. description: "null for earlier snmp_versions, value is an integer 1=MD5, 2=SHA"
  2316. snmp_credential_privacy_protocol_id:
  2317. type: "integer"
  2318. description: "null for earlier snmp_versions, 1=DES ,2=AES"
  2319. auth_passphrase:
  2320. type: "string"
  2321. priv_passphrase:
  2322. type: "string"
  2323. is_read_write:
  2324. type: "integer"
  2325. retries:
  2326. type: "integer"
  2327. timeout:
  2328. type: "integer"
  2329. throttle:
  2330. type: "integer"
  2331. SnmpCredentialPatchRequest:
  2332. type: "object"
  2333. required:
  2334. - "data"
  2335. properties:
  2336. jsonapi:
  2337. $ref: "#/definitions/JsonApiElement"
  2338. data:
  2339. $ref: "#/definitions/SnmpCredentialPatchData"
  2340. SnmpCredentialPatchData:
  2341. type: "object"
  2342. required:
  2343. - "attributes"
  2344. - "id"
  2345. - "type"
  2346. properties:
  2347. type:
  2348. type: "string"
  2349. default: "locations"
  2350. id:
  2351. type: "string"
  2352. attributes:
  2353. $ref: "#/definitions/SnmpCredentialPatchDataAttributes"
  2354. SnmpCredentialPatchDataAttributes:
  2355. type: "object"
  2356. properties:
  2357. snmp_credential_version_id:
  2358. type: "integer"
  2359. description: "Valid value is an integer 1 = v1, v2 = v2c , 3=v3"
  2360. port:
  2361. type: "integer"
  2362. community:
  2363. type: "string"
  2364. sec_name:
  2365. type: "string"
  2366. snmp_credential_security_level_id:
  2367. type: "integer"
  2368. description: "null for earlier snmp_versions, value is an integer 1=noAuthNoPrivValid,\
  2369. \ 2=authNoPriv, 3=authPriv "
  2370. snmp_credential_authentication_protocol_id:
  2371. type: "integer"
  2372. description: "null for earlier snmp_versions, value is an integer 1=MD5, 2=SHA"
  2373. snmp_credential_privacy_protocol_id:
  2374. type: "integer"
  2375. description: "null for earlier snmp_versions, 1=DES ,2=AES"
  2376. auth_passphrase:
  2377. type: "string"
  2378. priv_passphrase:
  2379. type: "string"
  2380. is_read_write:
  2381. type: "integer"
  2382. retries:
  2383. type: "integer"
  2384. timeout:
  2385. type: "integer"
  2386. throttle:
  2387. type: "integer"
  2388. GroupListResponseData:
  2389. type: "array"
  2390. items:
  2391. $ref: "#/definitions/GroupResponseData"
  2392. GroupResponseData:
  2393. type: "object"
  2394. required:
  2395. - "attributes"
  2396. - "id"
  2397. - "type"
  2398. properties:
  2399. type:
  2400. type: "string"
  2401. default: "groups"
  2402. id:
  2403. type: "integer"
  2404. attributes:
  2405. $ref: "#/definitions/GroupResponseDataAttributes"
  2406. links:
  2407. $ref: "#/definitions/Links"
  2408. GroupResponseDataAttributes:
  2409. type: "object"
  2410. properties:
  2411. name:
  2412. type: "string"
  2413. description:
  2414. type: "string"
  2415. depend:
  2416. type: "array"
  2417. items:
  2418. type: "string"
  2419. availability_report:
  2420. type: "boolean"
  2421. kpi_target:
  2422. type: "boolean"
  2423. outage_entity:
  2424. type: "boolean"
  2425. unremovable:
  2426. type: "boolean"
  2427. GroupPatchRequest:
  2428. type: "object"
  2429. required:
  2430. - "data"
  2431. properties:
  2432. jsonapi:
  2433. $ref: "#/definitions/JsonApiElement"
  2434. data:
  2435. $ref: "#/definitions/GroupPatchData"
  2436. GroupPatchData:
  2437. type: "object"
  2438. required:
  2439. - "attributes"
  2440. - "id"
  2441. - "type"
  2442. properties:
  2443. type:
  2444. type: "string"
  2445. default: "groups"
  2446. id:
  2447. type: "string"
  2448. attributes:
  2449. $ref: "#/definitions/GroupPatchDataAttributes"
  2450. GroupPatchDataAttributes:
  2451. type: "object"
  2452. properties:
  2453. name:
  2454. type: "string"
  2455. description:
  2456. type: "string"
  2457. depend:
  2458. type: "array"
  2459. items:
  2460. type: "string"
  2461. availability_report:
  2462. type: "boolean"
  2463. kpi_target:
  2464. type: "boolean"
  2465. outage_entity:
  2466. type: "boolean"
  2467. unremovable:
  2468. type: "boolean"
  2469. GroupCreateRequest:
  2470. type: "object"
  2471. required:
  2472. - "data"
  2473. properties:
  2474. jsonapi:
  2475. $ref: "#/definitions/JsonApiElement"
  2476. data:
  2477. $ref: "#/definitions/GroupCreateData"
  2478. GroupCreateData:
  2479. type: "object"
  2480. required:
  2481. - "attributes"
  2482. - "type"
  2483. properties:
  2484. type:
  2485. type: "string"
  2486. default: "groups"
  2487. attributes:
  2488. $ref: "#/definitions/GroupCreateDataAttributes"
  2489. GroupCreateDataAttributes:
  2490. type: "object"
  2491. properties:
  2492. name:
  2493. type: "string"
  2494. description:
  2495. type: "string"
  2496. depend:
  2497. type: "array"
  2498. items:
  2499. type: "string"
  2500. availability_report:
  2501. type: "boolean"
  2502. kpi_target:
  2503. type: "boolean"
  2504. outage_entity:
  2505. type: "boolean"
  2506. unremovable:
  2507. type: "boolean"
  2508. CategoryListResponseData:
  2509. type: "array"
  2510. items:
  2511. $ref: "#/definitions/CategoryResponseData"
  2512. CategoryResponseData:
  2513. type: "object"
  2514. required:
  2515. - "attributes"
  2516. - "id"
  2517. - "type"
  2518. properties:
  2519. type:
  2520. type: "string"
  2521. default: "categories"
  2522. id:
  2523. type: "integer"
  2524. attributes:
  2525. $ref: "#/definitions/CategoryResponseDataAttributes"
  2526. links:
  2527. $ref: "#/definitions/Links"
  2528. CategoryResponseDataAttributes:
  2529. type: "object"
  2530. properties:
  2531. case_category:
  2532. type: "string"
  2533. description:
  2534. type: "string"
  2535. protect:
  2536. type: "string"
  2537. enum:
  2538. - "Y"
  2539. - "N"
  2540. auto_close_time:
  2541. type: "integer"
  2542. auto_close_warning:
  2543. type: "integer"
  2544. p1_auto_close_override:
  2545. type: "string"
  2546. enum:
  2547. - "Y"
  2548. - "N"
  2549. sticky:
  2550. type: "boolean"
  2551. is_impact_category:
  2552. type: "boolean"
  2553. p2_auto_close_override:
  2554. type: "string"
  2555. enum:
  2556. - "Y"
  2557. - "N"
  2558. sent_to_fieldwatch:
  2559. type: "boolean"
  2560. CategoryPatchRequest:
  2561. type: "object"
  2562. required:
  2563. - "data"
  2564. properties:
  2565. jsonapi:
  2566. $ref: "#/definitions/JsonApiElement"
  2567. data:
  2568. $ref: "#/definitions/CategoryPatchData"
  2569. CategoryPatchData:
  2570. type: "object"
  2571. required:
  2572. - "attributes"
  2573. - "id"
  2574. - "type"
  2575. properties:
  2576. type:
  2577. type: "string"
  2578. default: "categories"
  2579. id:
  2580. type: "string"
  2581. attributes:
  2582. $ref: "#/definitions/CategoryPatchDataAttributes"
  2583. CategoryPatchDataAttributes:
  2584. type: "object"
  2585. properties:
  2586. case_category:
  2587. type: "string"
  2588. description:
  2589. type: "string"
  2590. protect:
  2591. type: "string"
  2592. enum:
  2593. - "Y"
  2594. - "N"
  2595. auto_close_time:
  2596. type: "integer"
  2597. auto_close_warning:
  2598. type: "integer"
  2599. p1_auto_close_override:
  2600. type: "string"
  2601. enum:
  2602. - "Y"
  2603. - "N"
  2604. sticky:
  2605. type: "boolean"
  2606. is_impact_category:
  2607. type: "boolean"
  2608. p2_auto_close_override:
  2609. type: "string"
  2610. enum:
  2611. - "Y"
  2612. - "N"
  2613. CategoryCreateRequest:
  2614. type: "object"
  2615. required:
  2616. - "data"
  2617. properties:
  2618. jsonapi:
  2619. $ref: "#/definitions/JsonApiElement"
  2620. data:
  2621. $ref: "#/definitions/CategoryCreateData"
  2622. CategoryCreateData:
  2623. type: "object"
  2624. required:
  2625. - "attributes"
  2626. - "type"
  2627. properties:
  2628. type:
  2629. type: "string"
  2630. default: "categories"
  2631. attributes:
  2632. $ref: "#/definitions/CategoryCreateDataAttributes"
  2633. CategoryCreateDataAttributes:
  2634. type: "object"
  2635. properties:
  2636. case_category:
  2637. type: "string"
  2638. description:
  2639. type: "string"
  2640. protect:
  2641. type: "string"
  2642. enum:
  2643. - "Y"
  2644. - "N"
  2645. auto_close_time:
  2646. type: "integer"
  2647. auto_close_warning:
  2648. type: "integer"
  2649. p1_auto_close_override:
  2650. type: "string"
  2651. enum:
  2652. - "Y"
  2653. - "N"
  2654. sticky:
  2655. type: "boolean"
  2656. is_impact_category:
  2657. type: "boolean"
  2658. p2_auto_close_override:
  2659. type: "string"
  2660. enum:
  2661. - "Y"
  2662. - "N"
  2663. PollingGroupListResponseData:
  2664. type: "array"
  2665. items:
  2666. $ref: "#/definitions/PollingGroupResponseData"
  2667. PollingGroupResponseData:
  2668. type: "object"
  2669. required:
  2670. - "attributes"
  2671. - "id"
  2672. - "type"
  2673. properties:
  2674. type:
  2675. type: "string"
  2676. default: "polling_groups"
  2677. id:
  2678. type: "integer"
  2679. attributes:
  2680. $ref: "#/definitions/PollingGroupResponseDataAttributes"
  2681. links:
  2682. $ref: "#/definitions/Links"
  2683. PollingGroupResponseDataAttributes:
  2684. type: "object"
  2685. properties:
  2686. description:
  2687. type: "string"
  2688. enabled:
  2689. type: "boolean"
  2690. no_delete:
  2691. type: "boolean"
  2692. batch_size:
  2693. type: "integer"
  2694. create_date:
  2695. type: "string"
  2696. create_by:
  2697. type: "string"
  2698. last_update:
  2699. type: "string"
  2700. last_update_by:
  2701. type: "string"
  2702. PollingGroupPatchRequest:
  2703. type: "object"
  2704. required:
  2705. - "data"
  2706. properties:
  2707. jsonapi:
  2708. $ref: "#/definitions/JsonApiElement"
  2709. data:
  2710. $ref: "#/definitions/PollingGroupPatchData"
  2711. PollingGroupPatchData:
  2712. type: "object"
  2713. required:
  2714. - "attributes"
  2715. - "id"
  2716. - "type"
  2717. properties:
  2718. type:
  2719. type: "string"
  2720. default: "polling_groups"
  2721. id:
  2722. type: "string"
  2723. attributes:
  2724. $ref: "#/definitions/PollingGroupPatchDataAttributes"
  2725. PollingGroupPatchDataAttributes:
  2726. type: "object"
  2727. properties:
  2728. description:
  2729. type: "string"
  2730. enabled:
  2731. type: "boolean"
  2732. no_delete:
  2733. type: "boolean"
  2734. batch_size:
  2735. type: "integer"
  2736. create_date:
  2737. type: "string"
  2738. create_by:
  2739. type: "string"
  2740. last_update:
  2741. type: "string"
  2742. last_update_by:
  2743. type: "string"
  2744. PollingGroupCreateRequest:
  2745. type: "object"
  2746. required:
  2747. - "data"
  2748. properties:
  2749. jsonapi:
  2750. $ref: "#/definitions/JsonApiElement"
  2751. data:
  2752. $ref: "#/definitions/PollingGroupCreateData"
  2753. PollingGroupCreateData:
  2754. type: "object"
  2755. required:
  2756. - "attributes"
  2757. - "type"
  2758. properties:
  2759. type:
  2760. type: "string"
  2761. default: "polling_groups"
  2762. attributes:
  2763. $ref: "#/definitions/PollingGroupCreateDataAttributes"
  2764. PollingGroupCreateDataAttributes:
  2765. type: "object"
  2766. properties:
  2767. description:
  2768. type: "string"
  2769. enabled:
  2770. type: "boolean"
  2771. no_delete:
  2772. type: "boolean"
  2773. batch_size:
  2774. type: "integer"
  2775. create_date:
  2776. type: "string"
  2777. create_by:
  2778. type: "string"
  2779. last_update:
  2780. type: "string"
  2781. last_update_by:
  2782. type: "string"
  2783. SupportContractListResponseData:
  2784. type: "array"
  2785. items:
  2786. $ref: "#/definitions/SupportContractResponseData"
  2787. SupportContractResponseData:
  2788. type: "object"
  2789. required:
  2790. - "attributes"
  2791. - "id"
  2792. - "type"
  2793. properties:
  2794. type:
  2795. type: "string"
  2796. default: "support_contracts"
  2797. id:
  2798. type: "integer"
  2799. attributes:
  2800. $ref: "#/definitions/SupportContractResponseDataAttributes"
  2801. links:
  2802. $ref: "#/definitions/Links"
  2803. SupportContractResponseDataAttributes:
  2804. type: "object"
  2805. properties:
  2806. contract:
  2807. type: "string"
  2808. expiration:
  2809. type: "string"
  2810. protect:
  2811. type: "string"
  2812. enum:
  2813. - "Y N"
  2814. SupportContractPatchRequest:
  2815. type: "object"
  2816. required:
  2817. - "data"
  2818. properties:
  2819. jsonapi:
  2820. $ref: "#/definitions/JsonApiElement"
  2821. data:
  2822. $ref: "#/definitions/SupportContractPatchData"
  2823. SupportContractPatchData:
  2824. type: "object"
  2825. required:
  2826. - "attributes"
  2827. - "id"
  2828. - "type"
  2829. properties:
  2830. type:
  2831. type: "string"
  2832. default: "support_contracts"
  2833. id:
  2834. type: "string"
  2835. attributes:
  2836. $ref: "#/definitions/SupportContractPatchDataAttributes"
  2837. SupportContractPatchDataAttributes:
  2838. type: "object"
  2839. properties:
  2840. contract:
  2841. type: "string"
  2842. expiration:
  2843. type: "string"
  2844. protect:
  2845. type: "string"
  2846. enum:
  2847. - "Y N"
  2848. SupportContractCreateRequest:
  2849. type: "object"
  2850. required:
  2851. - "data"
  2852. properties:
  2853. jsonapi:
  2854. $ref: "#/definitions/JsonApiElement"
  2855. data:
  2856. $ref: "#/definitions/SupportContractCreateData"
  2857. SupportContractCreateData:
  2858. type: "object"
  2859. required:
  2860. - "attributes"
  2861. - "type"
  2862. properties:
  2863. type:
  2864. type: "string"
  2865. default: "support_contracts"
  2866. attributes:
  2867. $ref: "#/definitions/SupportContractCreateDataAttributes"
  2868. SupportContractCreateDataAttributes:
  2869. type: "object"
  2870. properties:
  2871. contract:
  2872. type: "string"
  2873. expiration:
  2874. type: "string"
  2875. protect:
  2876. type: "string"
  2877. enum:
  2878. - "Y N"
  2879. SupportProgramListResponseData:
  2880. type: "array"
  2881. items:
  2882. $ref: "#/definitions/SupportProgramResponseData"
  2883. SupportProgramResponseData:
  2884. type: "object"
  2885. required:
  2886. - "attributes"
  2887. - "id"
  2888. - "type"
  2889. properties:
  2890. type:
  2891. type: "string"
  2892. default: "support_programs"
  2893. id:
  2894. type: "integer"
  2895. attributes:
  2896. $ref: "#/definitions/SupportProgramResponseDataAttributes"
  2897. links:
  2898. $ref: "#/definitions/Links"
  2899. SupportProgramResponseDataAttributes:
  2900. type: "object"
  2901. properties:
  2902. support_program:
  2903. type: "string"
  2904. telephone_number:
  2905. type: "string"
  2906. URL:
  2907. type: "string"
  2908. protect:
  2909. type: "string"
  2910. enum:
  2911. - "Y N"
  2912. SupportProgramPatchRequest:
  2913. type: "object"
  2914. required:
  2915. - "data"
  2916. properties:
  2917. jsonapi:
  2918. $ref: "#/definitions/JsonApiElement"
  2919. data:
  2920. $ref: "#/definitions/SupportProgramPatchData"
  2921. SupportProgramPatchData:
  2922. type: "object"
  2923. required:
  2924. - "attributes"
  2925. - "id"
  2926. - "type"
  2927. properties:
  2928. type:
  2929. type: "string"
  2930. default: "support_programs"
  2931. id:
  2932. type: "string"
  2933. attributes:
  2934. $ref: "#/definitions/SupportProgramPatchDataAttributes"
  2935. SupportProgramPatchDataAttributes:
  2936. type: "object"
  2937. properties:
  2938. support_program:
  2939. type: "string"
  2940. telephone_number:
  2941. type: "string"
  2942. URL:
  2943. type: "string"
  2944. protect:
  2945. type: "string"
  2946. enum:
  2947. - "Y N"
  2948. SupportProgramCreateRequest:
  2949. type: "object"
  2950. required:
  2951. - "data"
  2952. properties:
  2953. jsonapi:
  2954. $ref: "#/definitions/JsonApiElement"
  2955. data:
  2956. $ref: "#/definitions/SupportProgramCreateData"
  2957. SupportProgramCreateData:
  2958. type: "object"
  2959. required:
  2960. - "attributes"
  2961. - "type"
  2962. properties:
  2963. type:
  2964. type: "string"
  2965. default: "support_programs"
  2966. attributes:
  2967. $ref: "#/definitions/SupportProgramCreateDataAttributes"
  2968. SupportProgramCreateDataAttributes:
  2969. type: "object"
  2970. properties:
  2971. support_program:
  2972. type: "string"
  2973. telephone_number:
  2974. type: "string"
  2975. URL:
  2976. type: "string"
  2977. protect:
  2978. type: "string"
  2979. enum:
  2980. - "Y N"
  2981. DefCcmCredentialListResponseData:
  2982. type: "array"
  2983. items:
  2984. $ref: "#/definitions/DefCcmCredentialResponseData"
  2985. DefCcmCredentialResponseData:
  2986. type: "object"
  2987. required:
  2988. - "attributes"
  2989. - "id"
  2990. - "type"
  2991. properties:
  2992. type:
  2993. type: "string"
  2994. default: "def_ccm_credentials"
  2995. id:
  2996. type: "integer"
  2997. attributes:
  2998. $ref: "#/definitions/DefCcmCredentialResponseDataAttributes"
  2999. links:
  3000. $ref: "#/definitions/Links"
  3001. DefCcmCredentialResponseDataAttributes:
  3002. type: "object"
  3003. properties:
  3004. type:
  3005. type: "string"
  3006. enum:
  3007. - "publisher"
  3008. - "subscriber"
  3009. publisher:
  3010. type: "string"
  3011. port:
  3012. type: "integer"
  3013. entity:
  3014. type: "string"
  3015. server_name:
  3016. type: "string"
  3017. node_id:
  3018. type: "integer"
  3019. cluster_id:
  3020. type: "string"
  3021. version:
  3022. type: "string"
  3023. username:
  3024. type: "string"
  3025. password:
  3026. type: "string"
  3027. alias:
  3028. type: "string"
  3029. jtapiusername:
  3030. type: "string"
  3031. jtapipassword:
  3032. type: "string"
  3033. sambausername:
  3034. type: "string"
  3035. sambapassword:
  3036. type: "string"
  3037. axlusername:
  3038. type: "string"
  3039. axlpassword:
  3040. type: "string"
  3041. axltimeout:
  3042. type: "integer"
  3043. emusername:
  3044. type: "string"
  3045. empin:
  3046. type: "string"
  3047. enabled:
  3048. type: "integer"
  3049. config_mgr:
  3050. type: "integer"
  3051. bad_call_max_deviation:
  3052. type: "number"
  3053. bad_call_mean_period:
  3054. type: "number"
  3055. DefCcmCredentialPatchRequest:
  3056. type: "object"
  3057. required:
  3058. - "data"
  3059. properties:
  3060. jsonapi:
  3061. $ref: "#/definitions/JsonApiElement"
  3062. data:
  3063. $ref: "#/definitions/DefCcmCredentialPatchData"
  3064. DefCcmCredentialPatchData:
  3065. type: "object"
  3066. required:
  3067. - "attributes"
  3068. - "id"
  3069. - "type"
  3070. properties:
  3071. type:
  3072. type: "string"
  3073. default: "def_ccm_credentials"
  3074. id:
  3075. type: "string"
  3076. attributes:
  3077. $ref: "#/definitions/DefCcmCredentialPatchDataAttributes"
  3078. DefCcmCredentialPatchDataAttributes:
  3079. type: "object"
  3080. properties:
  3081. type:
  3082. type: "string"
  3083. enum:
  3084. - "publisher"
  3085. - "subscriber"
  3086. publisher:
  3087. type: "string"
  3088. port:
  3089. type: "integer"
  3090. entity:
  3091. type: "string"
  3092. server_name:
  3093. type: "string"
  3094. node_id:
  3095. type: "integer"
  3096. cluster_id:
  3097. type: "string"
  3098. version:
  3099. type: "string"
  3100. username:
  3101. type: "string"
  3102. password:
  3103. type: "string"
  3104. alias:
  3105. type: "string"
  3106. jtapiusername:
  3107. type: "string"
  3108. jtapipassword:
  3109. type: "string"
  3110. sambausername:
  3111. type: "string"
  3112. sambapassword:
  3113. type: "string"
  3114. axlusername:
  3115. type: "string"
  3116. axlpassword:
  3117. type: "string"
  3118. axltimeout:
  3119. type: "integer"
  3120. emusername:
  3121. type: "string"
  3122. empin:
  3123. type: "string"
  3124. enabled:
  3125. type: "integer"
  3126. config_mgr:
  3127. type: "integer"
  3128. bad_call_max_deviation:
  3129. type: "number"
  3130. bad_call_mean_period:
  3131. type: "number"
  3132. DefCcmCredentialCreateRequest:
  3133. type: "object"
  3134. required:
  3135. - "data"
  3136. properties:
  3137. jsonapi:
  3138. $ref: "#/definitions/JsonApiElement"
  3139. data:
  3140. $ref: "#/definitions/DefCcmCredentialCreateData"
  3141. DefCcmCredentialCreateData:
  3142. type: "object"
  3143. required:
  3144. - "attributes"
  3145. - "type"
  3146. properties:
  3147. type:
  3148. type: "string"
  3149. default: "def_ccm_credentials"
  3150. attributes:
  3151. $ref: "#/definitions/DefCcmCredentialCreateDataAttributes"
  3152. DefCcmCredentialCreateDataAttributes:
  3153. type: "object"
  3154. properties:
  3155. type:
  3156. type: "string"
  3157. enum:
  3158. - "publisher"
  3159. - "subscriber"
  3160. publisher:
  3161. type: "string"
  3162. port:
  3163. type: "integer"
  3164. entity:
  3165. type: "string"
  3166. server_name:
  3167. type: "string"
  3168. node_id:
  3169. type: "integer"
  3170. cluster_id:
  3171. type: "string"
  3172. version:
  3173. type: "string"
  3174. username:
  3175. type: "string"
  3176. password:
  3177. type: "string"
  3178. alias:
  3179. type: "string"
  3180. jtapiusername:
  3181. type: "string"
  3182. jtapipassword:
  3183. type: "string"
  3184. sambausername:
  3185. type: "string"
  3186. sambapassword:
  3187. type: "string"
  3188. axlusername:
  3189. type: "string"
  3190. axlpassword:
  3191. type: "string"
  3192. axltimeout:
  3193. type: "integer"
  3194. emusername:
  3195. type: "string"
  3196. empin:
  3197. type: "string"
  3198. enabled:
  3199. type: "integer"
  3200. config_mgr:
  3201. type: "integer"
  3202. bad_call_max_deviation:
  3203. type: "number"
  3204. bad_call_mean_period:
  3205. type: "number"
  3206. PocResponseData:
  3207. type: "object"
  3208. properties:
  3209. entity:
  3210. type: "string"
  3211. id:
  3212. type: "integer"
  3213. user_type:
  3214. type: "string"
  3215. user_type_id:
  3216. type: "integer"
  3217. is_inherited_from_group:
  3218. type: "integer"
  3219. links:
  3220. type: "object"
  3221. properties:
  3222. EntityLink:
  3223. type: "string"
  3224. SelfLink:
  3225. type: "string"
  3226. PocLink:
  3227. type: "string"
  3228. PocListResponseData:
  3229. type: "array"
  3230. items:
  3231. $ref: "#/definitions/PocResponseData"
  3232. EntityPocPostRequestData:
  3233. type: "object"
  3234. properties:
  3235. type:
  3236. type: "string"
  3237. enum:
  3238. - "user"
  3239. - "role"
  3240. poc:
  3241. type: "string"
  3242. PaginationLinks:
  3243. type: "object"
  3244. properties:
  3245. first:
  3246. type: "string"
  3247. prev:
  3248. type: "string"
  3249. next:
  3250. type: "string"
  3251. last:
  3252. type: "string"
  3253.  
  3254. SelfLink:
  3255. type: "object"
  3256. properties:
  3257. self:
  3258. type: "string"
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!