cablemodem.json 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870
  1. {
  2. "swagger": "2.0",
  3. "info": {
  4. "description": "API REST para Flowdat Cablemodem.",
  5. "version": "1.0.0",
  6. "title": "Cablemodem Flowdat"
  7. },
  8. "host": "flowdatHost",
  9. "basePath": "/api",
  10. "schemes": [
  11. "https"
  12. ],
  13. "paths": {
  14. "/nodes.json": {
  15. "get": {
  16. "tags": [
  17. "Node"
  18. ],
  19. "summary": "Obtener Nodos por id, id Nodo Padre, nombre.",
  20. "description": "",
  21. "operationId": "getList",
  22. "produces": [
  23. "application/json"
  24. ],
  25. "parameters": [
  26. {
  27. "name": "filters[id]",
  28. "in": "query",
  29. "description": "Id de nodo que quiere obtener.",
  30. "required": false,
  31. "type": "integer"
  32. },
  33. {
  34. "name": "filters[parent]",
  35. "in": "query",
  36. "description": "Id del nodo padre del Nodo que quiere obtener.",
  37. "required": false,
  38. "type": "integer"
  39. },
  40. {
  41. "name": "filters[name]",
  42. "in": "query",
  43. "description": "Nombre del nodo que quiere obtener.",
  44. "required": false,
  45. "type": "string"
  46. },
  47. {
  48. "name": "filters[tenancyId]",
  49. "in": "query",
  50. "description": "Tenancy de nodo.",
  51. "required": false,
  52. "type": "integer",
  53. "default": 2
  54. },
  55. {
  56. "name": "filters[qb-criteria]",
  57. "in": "query",
  58. "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
  59. "required": false,
  60. "type": "integer",
  61. "default": null
  62. },
  63. {
  64. "name": "limit",
  65. "in": "query",
  66. "description": "Cantidad de registros por página.",
  67. "default": 20,
  68. "type": "integer"
  69. },
  70. {
  71. "name": "page",
  72. "in": "query",
  73. "description": "Número de página a buscar.",
  74. "default": 0,
  75. "type": "integer"
  76. }
  77. ],
  78. "responses": {
  79. "200": {
  80. "description": "Operación exitosa.",
  81. "schema": {
  82. "type": "array",
  83. "items": {
  84. "$ref": "#/definitions/Node"
  85. }
  86. }
  87. },
  88. "400": {
  89. "description": "Nodo inválido."
  90. },
  91. "404": {
  92. "description": "Nodo no encontrado."
  93. }
  94. }
  95. }
  96. },
  97. "/nodes/{id}.json": {
  98. "get": {
  99. "tags": [
  100. "Node"
  101. ],
  102. "summary": "Obtener Nodo por id.",
  103. "description": "",
  104. "operationId": "getById",
  105. "produces": [
  106. "application/json"
  107. ],
  108. "parameters": [
  109. {
  110. "name": "id",
  111. "in": "path",
  112. "description": "Id de Nodo que quiere obtener.",
  113. "required": true,
  114. "type": "string"
  115. }
  116. ],
  117. "responses": {
  118. "200": {
  119. "description": "Operación exitosa.",
  120. "schema": {
  121. "$ref": "#/definitions/Node"
  122. }
  123. },
  124. "400": {
  125. "description": "Nodo inválido."
  126. },
  127. "404": {
  128. "description": "Nodo no encontrado."
  129. }
  130. }
  131. }
  132. },
  133. "/profiles.json": {
  134. "get": {
  135. "tags": [
  136. "Profile"
  137. ],
  138. "summary": "Obtener Perfiles por id, nombre.",
  139. "description": "",
  140. "operationId": "getList",
  141. "produces": [
  142. "application/json"
  143. ],
  144. "parameters": [
  145. {
  146. "name": "filters[id]",
  147. "in": "query",
  148. "description": "Id de perfil que quiere obtener.",
  149. "required": false,
  150. "type": "integer"
  151. },
  152. {
  153. "name": "filters[name]",
  154. "in": "query",
  155. "description": "Nombre del perfil que quiere obtener.",
  156. "required": false,
  157. "type": "string"
  158. },
  159. {
  160. "name": "filters[downstream]",
  161. "in": "query",
  162. "description": "Valor de downstream.",
  163. "required": false,
  164. "type": "integer"
  165. },
  166. {
  167. "name": "filters[upstream]",
  168. "in": "query",
  169. "description": "Valor de upstream.",
  170. "required": false,
  171. "type": "integer"
  172. },
  173. {
  174. "name": "filters[filtroUpload]",
  175. "in": "query",
  176. "description": "Valor de filtro de upload.",
  177. "required": false,
  178. "type": "integer"
  179. },
  180. {
  181. "name": "filters[filtroDownload]",
  182. "in": "query",
  183. "description": "Valor de filtro de download.",
  184. "required": false,
  185. "type": "integer"
  186. },
  187. {
  188. "name": "filters[maxCpe]",
  189. "in": "query",
  190. "description": "Max Cpe.",
  191. "required": false,
  192. "type": "integer"
  193. },
  194. {
  195. "name": "filters[tenancyId]",
  196. "in": "query",
  197. "description": "Tenancy de Perfil.",
  198. "required": false,
  199. "type": "integer",
  200. "default": 2
  201. },
  202. {
  203. "name": "filters[qb-criteria]",
  204. "in": "query",
  205. "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
  206. "required": false,
  207. "type": "integer",
  208. "default": null
  209. },
  210. {
  211. "name": "limit",
  212. "in": "query",
  213. "description": "Cantidad de registros por página.",
  214. "default": 20,
  215. "type": "integer"
  216. },
  217. {
  218. "name": "page",
  219. "in": "query",
  220. "description": "Número de página a buscar.",
  221. "default": 0,
  222. "type": "integer"
  223. }
  224. ],
  225. "responses": {
  226. "200": {
  227. "description": "Operación exitosa.",
  228. "schema": {
  229. "type": "array",
  230. "items": {
  231. "$ref": "#/definitions/Profile"
  232. }
  233. }
  234. },
  235. "400": {
  236. "description": "Perfil inválido."
  237. },
  238. "404": {
  239. "description": "Perfil no encontrado."
  240. }
  241. }
  242. }
  243. },
  244. "/profiles/{id}.json": {
  245. "get": {
  246. "tags": [
  247. "Profile"
  248. ],
  249. "summary": "Obtener Perfil por id",
  250. "description": "",
  251. "operationId": "getById",
  252. "produces": [
  253. "application/json"
  254. ],
  255. "parameters": [
  256. {
  257. "name": "id",
  258. "in": "path",
  259. "description": "Id del perfil que quiere obtener.",
  260. "required": true,
  261. "type": "string"
  262. }
  263. ],
  264. "responses": {
  265. "200": {
  266. "description": "Operación exitosa.",
  267. "schema": {
  268. "$ref": "#/definitions/Profile"
  269. }
  270. },
  271. "400": {
  272. "description": "Perfil inválido."
  273. },
  274. "404": {
  275. "description": "Perfil no encontrado."
  276. }
  277. }
  278. }
  279. },
  280. "/cablemodemmodels.json": {
  281. "get": {
  282. "tags": [
  283. "Cablemodem Model"
  284. ],
  285. "summary": "Obtener modelos de cablemodem por id o nombre.",
  286. "operationId": "getList",
  287. "produces": [
  288. "application/json"
  289. ],
  290. "parameters": [
  291. {
  292. "name": "filters[id]",
  293. "in": "query",
  294. "description": "Id del modelo de cablemodem que quiere obtener.",
  295. "required": false,
  296. "type": "integer"
  297. },
  298. {
  299. "name": "filters[name]",
  300. "in": "query",
  301. "description": "Nombre del modelo de cablemodem que quiere obtener.",
  302. "required": false,
  303. "type": "string"
  304. },
  305. {
  306. "name": "filters[qb-criteria]",
  307. "in": "query",
  308. "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
  309. "required": false,
  310. "type": "integer",
  311. "default": null
  312. },
  313. {
  314. "name": "limit",
  315. "in": "query",
  316. "description": "Cantidad de registros por página.",
  317. "default": 20,
  318. "type": "integer"
  319. },
  320. {
  321. "name": "page",
  322. "in": "query",
  323. "description": "Número de página a buscar.",
  324. "default": 0,
  325. "type": "integer"
  326. }
  327. ],
  328. "responses": {
  329. "200": {
  330. "description": "Operación exitosa.",
  331. "schema": {
  332. "type": "array",
  333. "items": {
  334. "$ref": "#/definitions/CablemodemModel"
  335. }
  336. }
  337. },
  338. "400": {
  339. "description": "Modelo de cablemodem inválido."
  340. },
  341. "404": {
  342. "description": "Modelo de cablemodem no encontrado."
  343. }
  344. }
  345. }
  346. },
  347. "/cablemodemmodels/{id}.json": {
  348. "get": {
  349. "tags": [
  350. "Cablemodem Model"
  351. ],
  352. "summary": "Obtener modelos de cablemodem por id.",
  353. "description": "",
  354. "operationId": "getById",
  355. "produces": [
  356. "application/json"
  357. ],
  358. "parameters": [
  359. {
  360. "name": "id",
  361. "in": "path",
  362. "description": "Id de modelo de cablemodem que quiere obtener.",
  363. "required": true,
  364. "type": "string"
  365. }
  366. ],
  367. "responses": {
  368. "200": {
  369. "description": "Operación exitosa.",
  370. "schema": {
  371. "$ref": "#/definitions/CablemodemModel"
  372. }
  373. },
  374. "400": {
  375. "description": "Modelo de cablemodem inválido."
  376. },
  377. "404": {
  378. "description": "Modelo de cablemodem no encontrado."
  379. }
  380. }
  381. }
  382. },
  383. "/cablemodems.json": {
  384. "get": {
  385. "tags": [
  386. "Cablemodem"
  387. ],
  388. "summary": "Encuentra cablemodem por Id, client, modelo, mac, nodo, perfil o tenencia.",
  389. "operationId": "getList",
  390. "produces": [
  391. "application/json"
  392. ],
  393. "parameters": [
  394. {
  395. "name": "filters[id]",
  396. "in": "query",
  397. "description": "Id del cablemodem.",
  398. "required": false,
  399. "type": "integer"
  400. },
  401. {
  402. "name": "filters[clientId]",
  403. "in": "query",
  404. "description": "Id del cliente.",
  405. "required": false,
  406. "type": "integer"
  407. },
  408. {
  409. "name": "filters[mac]",
  410. "in": "query",
  411. "description": "MAC del cablemodem.",
  412. "required": false,
  413. "type": "string"
  414. },
  415. {
  416. "name": "filters[node]",
  417. "in": "query",
  418. "description": "Id del nodo.",
  419. "required": false,
  420. "type": "integer"
  421. },
  422. {
  423. "name": "filters[profile]",
  424. "in": "query",
  425. "description": "Id del perfil de cablemodem.",
  426. "required": false,
  427. "type": "string"
  428. },
  429. {
  430. "name": "filters[model]",
  431. "in": "query",
  432. "description": "Id del modelo de cablemodem.",
  433. "required": false,
  434. "type": "integer"
  435. },
  436. {
  437. "name": "filters[tenancyId]",
  438. "in": "query",
  439. "description": "Id de la tenencia donde se encuentra cargado el cablemodem. Por defecto se utiliza la tenencia base.",
  440. "required": false,
  441. "type": "integer",
  442. "default": 2
  443. },
  444. {
  445. "name": "filters[qb-criteria]",
  446. "in": "query",
  447. "description": "Setear a 1 permite filtrar por parte del nombre al momento de buscar por este campo.",
  448. "required": false,
  449. "type": "integer",
  450. "default": null
  451. },
  452. {
  453. "name": "limit",
  454. "in": "query",
  455. "description": "Cantidad de registros por página.",
  456. "default": 20,
  457. "type": "integer"
  458. },
  459. {
  460. "name": "page",
  461. "in": "query",
  462. "description": "Número de página a buscar.",
  463. "default": 0,
  464. "type": "integer"
  465. }
  466. ],
  467. "responses": {
  468. "200": {
  469. "description": "Operación existosa.",
  470. "schema": {
  471. "type": "array",
  472. "items": {
  473. "$ref": "#/definitions/Cablemodem"
  474. }
  475. }
  476. },
  477. "400": {
  478. "description": "Valor incorrecto."
  479. }
  480. }
  481. },
  482. "post": {
  483. "tags": [
  484. "Cablemodem"
  485. ],
  486. "summary": "Crear una cablemodem",
  487. "description": "Creación de un cablemodem. Dentro de los objetos solo se debe pasar el id.",
  488. "operationId": "create",
  489. "produces": [
  490. "application/json"
  491. ],
  492. "parameters": [
  493. {
  494. "in": "body",
  495. "name": "body",
  496. "description": "Crea un cablemodem a partir del objeto.",
  497. "required": true,
  498. "schema": {
  499. "$ref": "#/definitions/CablemodemCRUD"
  500. }
  501. }
  502. ],
  503. "responses": {
  504. "200": {
  505. "description": "Operación existosa.",
  506. "schema": {
  507. "type": "array",
  508. "items": {
  509. "$ref": "#/definitions/Cablemodem"
  510. }
  511. }
  512. },
  513. "400": {
  514. "description": "Valor incorrecto."
  515. }
  516. }
  517. }
  518. },
  519. "/cablemodems/{id}.json": {
  520. "put": {
  521. "tags": [
  522. "Cablemodem"
  523. ],
  524. "summary": "Actualiza un cablemodem.",
  525. "description": "Modificación de un cablemodem. Dentro de los objetos solo debe pasar el id.",
  526. "operationId": "update",
  527. "consumes": [
  528. "application/json"
  529. ],
  530. "produces": [
  531. "application/json"
  532. ],
  533. "parameters": [
  534. {
  535. "name": "id",
  536. "in": "path",
  537. "description": "Ingresar el Id de un cablemodem que va a editar.",
  538. "type": "string",
  539. "required": true
  540. },
  541. {
  542. "in": "body",
  543. "name": "body",
  544. "description": "Objeto cablemodem que necesita ser modificado.",
  545. "required": true,
  546. "schema": {
  547. "$ref": "#/definitions/CablemodemCRUD"
  548. }
  549. }
  550. ],
  551. "responses": {
  552. "200": {
  553. "description": "Operación exitosa.",
  554. "schema": {
  555. "type": "array",
  556. "items": {
  557. "$ref": "#/definitions/Cablemodem"
  558. }
  559. }
  560. },
  561. "400": {
  562. "description": "Se produjo un error al ejecutar la acción."
  563. },
  564. "404": {
  565. "description": "Cablemodem no encontrado."
  566. },
  567. "405": {
  568. "description": "Validation exception."
  569. }
  570. }
  571. },
  572. "delete": {
  573. "tags": [
  574. "Cablemodem"
  575. ],
  576. "summary": "Eliminar un cablemodem",
  577. "description": "Elimina un cablemodem. Dentro del objeto tenency solo se debe pasar el id.",
  578. "operationId": "delete",
  579. "produces": [
  580. "application/json"
  581. ],
  582. "parameters": [
  583. {
  584. "name": "id",
  585. "in": "path",
  586. "description": "Id del cablemodem que necesita eliminar.",
  587. "required": true,
  588. "type": "intenger"
  589. }
  590. ],
  591. "responses": {
  592. "200": {
  593. "description": "Operación exitosa."
  594. },
  595. "400": {
  596. "description": "Cablemodem no válido."
  597. },
  598. "404": {
  599. "description": "Cablemodem no encontrado."
  600. }
  601. }
  602. },
  603. "get": {
  604. "tags": [
  605. "Cablemodem"
  606. ],
  607. "summary": "Obtener cablemodem por Id",
  608. "description": "",
  609. "operationId": "getById",
  610. "produces": [
  611. "application/json"
  612. ],
  613. "parameters": [
  614. {
  615. "name": "id",
  616. "in": "path",
  617. "description": "Id del cablemodem a consultar.",
  618. "required": true,
  619. "type": "integer"
  620. }
  621. ],
  622. "responses": {
  623. "200": {
  624. "description": "Operación exitosa.",
  625. "schema": {
  626. "$ref": "#/definitions/Cablemodem"
  627. }
  628. },
  629. "400": {
  630. "description": "Id de cablemodem inválido."
  631. },
  632. "404": {
  633. "description": "Cablemodem no encontrado."
  634. }
  635. }
  636. }
  637. },
  638. "/cablemodem/{id}/apply/{workflow}/{transition}": {
  639. "get": {
  640. "tags": [
  641. "Cablemodem"
  642. ],
  643. "summary": "Aplicar acción sobre cablemodem.",
  644. "description": "",
  645. "operationId": "apply",
  646. "produces": [
  647. "application/json"
  648. ],
  649. "parameters": [
  650. {
  651. "name": "id",
  652. "in": "path",
  653. "description": "Id del cablemodem",
  654. "required": true,
  655. "type": "integer"
  656. },
  657. {
  658. "name": "workflow",
  659. "in": "path",
  660. "description": "Workflow del cablemodem",
  661. "required": true,
  662. "type": "string",
  663. "enum": [
  664. "cablemodem_workflow"
  665. ]
  666. },
  667. {
  668. "name": "transition",
  669. "in": "path",
  670. "description": "Acción del Workflow",
  671. "required": true,
  672. "type": "string",
  673. "enum": [
  674. "active",
  675. "disable"
  676. ]
  677. }
  678. ],
  679. "responses": {
  680. "200": {
  681. "description": "Operación exitosa.",
  682. "schema": {
  683. "$ref": "#/definitions/Cablemodem"
  684. }
  685. },
  686. "400": {
  687. "description": "Alguno de los datos no es correcto. Verifique el id, workflow o acción."
  688. },
  689. "404": {
  690. "description": "Error al aplicar la transición."
  691. }
  692. }
  693. }
  694. }
  695. },
  696. "security": [
  697. {
  698. "basicAuth": []
  699. }
  700. ],
  701. "securityDefinitions": {
  702. "basicAuth": {
  703. "type": "basic"
  704. }
  705. },
  706. "definitions": {
  707. "Node": {
  708. "type": "object",
  709. "properties": {
  710. "id": {
  711. "type": "integer",
  712. "description": "Id del nodo."
  713. },
  714. "name": {
  715. "type": "string",
  716. "description": "Nombre del nodo."
  717. },
  718. "parent": {
  719. "type": "integer",
  720. "description": "Id del nodo padre."
  721. },
  722. "childs": {
  723. "type": "array",
  724. "items": {
  725. "$ref": "#/definitions/Node"
  726. },
  727. "description": "Listado de Nodos hijos."
  728. },
  729. "tenancyId": {
  730. "type": "integer",
  731. "description": "Id de la tenencia a la que pertenece el NAP.",
  732. "default": 2
  733. }
  734. }
  735. },
  736. "CablemodemModel": {
  737. "type": "object",
  738. "properties": {
  739. "id": {
  740. "type": "integer",
  741. "description": "Id del modelo."
  742. },
  743. "name": {
  744. "type": "string",
  745. "description": "Nombre del modelo."
  746. }
  747. }
  748. },
  749. "Profile": {
  750. "type": "object",
  751. "properties": {
  752. "id": {
  753. "type": "integer",
  754. "description": "Id del perfil."
  755. },
  756. "name": {
  757. "type": "string",
  758. "description": "Nombre del perfil."
  759. },
  760. "downstream": {
  761. "type": "integer",
  762. "description": "Down stream"
  763. },
  764. "upstream": {
  765. "type": "integer",
  766. "description": "Up stream"
  767. },
  768. "filtroUpload": {
  769. "type": "integer",
  770. "description": "Upload"
  771. },
  772. "filtroDownload": {
  773. "type": "integer",
  774. "description": "Download"
  775. },
  776. "maxCpe": {
  777. "type": "integer",
  778. "description": "Max cpe"
  779. },
  780. "extraData": {
  781. "type": "string",
  782. "format": "json"
  783. },
  784. "tenancyId": {
  785. "type": "integer",
  786. "description": "Id de la tenencia a la que pertenece al perfil.",
  787. "default": 2
  788. }
  789. }
  790. },
  791. "Cablemodem": {
  792. "type": "object",
  793. "properties": {
  794. "id": {
  795. "type": "integer",
  796. "description": "Id del cablemodem."
  797. },
  798. "clientId": {
  799. "description": "Id del cliente.",
  800. "type": "integer"
  801. },
  802. "mac": {
  803. "description": "MAC del cablemodem.",
  804. "type": "string"
  805. },
  806. "node": {
  807. "$ref": "#/definitions/Node"
  808. },
  809. "profile": {
  810. "$ref": "#/definitions/Profile"
  811. },
  812. "model": {
  813. "$ref": "#/definitions/CablemodemModel"
  814. },
  815. "activationCode": {
  816. "type": "string",
  817. "description": "Código de activación."
  818. },
  819. "tenancyId": {
  820. "type": "integer",
  821. "description": "Id de la tenencia a la que pertenece al perfil.",
  822. "default": 2
  823. }
  824. }
  825. },
  826. "CablemodemCRUD": {
  827. "type": "object",
  828. "properties": {
  829. "id": {
  830. "type": "integer",
  831. "description": "Id del cablemodem."
  832. },
  833. "clientId": {
  834. "description": "Id del cliente.",
  835. "type": "integer"
  836. },
  837. "mac": {
  838. "description": "MAC del cablemodem.",
  839. "type": "string"
  840. },
  841. "node": {
  842. "description": "Id del nodo.",
  843. "type": "integer"
  844. },
  845. "profile": {
  846. "description": "Id del perfil.",
  847. "type": "integer"
  848. },
  849. "model": {
  850. "description": "Id del modelo.",
  851. "type": "integer"
  852. },
  853. "activationCode": {
  854. "type": "string",
  855. "description": "Código de activación."
  856. },
  857. "transitionState": {
  858. "description": "success",
  859. "type": "string",
  860. "default": "success"
  861. },
  862. "tenancyId": {
  863. "type": "integer",
  864. "description": "Id de la tenencia a la que pertenece al perfil.",
  865. "default": 2
  866. }
  867. }
  868. }
  869. }
  870. }