Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

  1. Resource URI: /servers
  2. Default Resource Properties:
  3. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. id
    1. Server unique identification number.
    1. host

    Name of the host server.

    1. ip

    The IP address.

    1. primary

    Type of the server. Displays True if it is a primary server or False if it's a not a primary server.

    1. registered

    Displays True if it is a registered server or False if it's not.

    1. description

    Short description provided by the user.

  4. Specific Response Codes: N/A
  5. HTTP Method: GET
  6. Retrieves all configured nodes.
        1. Example: XML format
  7. <Servers>
  8. <Server>
  9. <id>1</id>
  10. <host>openuc_1410.ezuce.ro</host>
  11. <ip>195.167.1.323</ip>
  12. <primary>true</primary>
  13. <registered>true</registered>
  14. <description>Primary</description>
  15. </Server>
  16. <Server>
  17. <id>2</id>
  18. <host>openuc_1410.ezuce.ro</host>
  19. <ip>192.492.3.850</ip>
  20. <primary>true</primary>
  21. <registered>true</registered>
  22. <description>secondary</description>
  23. </Server>
  24. </Servers>
    1. JSON format
  25. {
  26. Wiki Markup
    servers: \[2\]

  27. {
    1. primary: true
  28. description: "Primary"
  29. host: "openuc_1410.ezuce.ro"
  30. id: 1
  31. registered: true
        1. ip: "195.167.1.323"
  32. {
  33. primary: false
  34. description: "secondary"
  35. host: "openuc_1410.ezuce.ro"
  36. id: 2
  37. registered: true
  38. ip: "192.492.3.850"
  39. }-
  40. -
  41. }
  42. HTTP Method: POST
    1. Configures a new node.
  43. Unsupported HTTP Method: PUT, DELETE

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/{serverId}/features
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. name
      1. Name of the feature.
      1. bundle

    Name of the bundle taht contains the feature.

      1. type

    Feature type.

      1. enabeled

    Displays True if it is a registered server or False if it's not.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves nodes for the specified internal ID or host name.
        1. Example: XML format
  8. <Features>
  9. <features>
  10. <name>reports</name>
  11. <bundle>core</bundle>
  12. <type>location</type>
  13. <enabled>false</enabled>
  14. </features>
  15. <features>
  16. <name>dhcpd</name>
  17. <bundle>core</bundle>
  18. <type>location</type>
  19. <enabled>false</enabled>
  20. </features>
  21. <features>
  22. <name>sipxdns</name>
  23. <bundle>core</bundle>
  24. <type>location</type>
  25. <enabled>true</enabled>
  26. </features>
  27. <features>
  28. <name>event</name>
  29. <bundle>core</bundle>
  30. <type>location</type>
  31. <enabled>false</enabled>
  32. </features>
  33. <features>
  34. <name>freeSwitch</name>
  35. <bundle>coreTelephony</bundle>
  36. <type>location</type>
  37. <enabled>false</enabled>
  38. </features>
  39. <features>
  40. <name>authCode</name>
  41. <bundle>coreTelephony</bundle>
  42. <type>location</type>
  43. <enabled>false</enabled>
  44. </features>
  45. <features>
  46. <name>recording</name>
  47. <bundle>coreTelephony</bundle>
  48. <type>location</type>
  49. <enabled>false</enabled>
  50. </features>
  51. <features>
  52. <name>redis</name>
  53. <bundle>coreTelephony</bundle>
  54. <type>location</type>
  55. <enabled>false</enabled>
  56. </features>
  57. <features>
  58. <name>ivr</name>
  59. <bundle>coreTelephony</bundle>
  60. <type>location</type>
  61. <enabled>false</enabled>
  62. </features>
  63. <features>
  64. <name>moh</name>
  65. <bundle>coreTelephony</bundle>
  66. <type>location</type>
  67. <enabled>false</enabled>
  68. </features>
  69. <features>
  70. <name>park</name>
  71. <bundle>coreTelephony</bundle>
  72. <type>location</type>
  73. <enabled>false</enabled>
  74. </features>
  75. <features>
  76. <name>sbcBridge</name>
  77. <bundle>coreTelephony</bundle>
  78. <type>location</type>
  79. <enabled>false</enabled>
  80. </features>
  81. <features>
  82. <name>registrar</name>
  83. <bundle>coreTelephony</bundle>
  84. <type>location</type>
  85. <enabled>false</enabled>
  86. </features>
  87. <features>
  88. <name>sipxcdr</name>
  89. <bundle>coreTelephony</bundle>
  90. <type>location</type>
  91. <enabled>false</enabled>
  92. </features>
  93. <features>
  94. <name>openuc-saa</name>
  95. <bundle>coreTelephony</bundle>
  96. <type>location</type>
  97. <enabled>false</enabled>
  98. </features>
  99. <features>
  100. <name>sipxsqa</name>
  101. <bundle>coreTelephony</bundle>
  102. <type>location</type>
  103. <enabled>false</enabled>
  104. </features>
  105. <features>
  106. <name>callqueue</name>
  107. <bundle>coreTelephony</bundle>
  108. <type>location</type>
  109. <enabled>false</enabled>
  110. </features>
  111. <features>
  112. <name>mwi</name>
  113. <bundle>coreTelephony</bundle>
  114. <type>location</type>
  115. <enabled>false</enabled>
  116. </features>
  117. <features>
  118. <name>homer_web</name>
  119. <bundle>coreTelephony</bundle>
  120. <type>location</type>
  121. <enabled>false</enabled>
  122. </features>
  123. <features>
  124. <name>page</name>
  125. <bundle>coreTelephony</bundle>
  126. <type>location</type>
  127. <enabled>false</enabled>
  128. </features>
  129. <features>
  130. <name>proxy</name>
  131. <bundle>coreTelephony</bundle>
  132. <type>location</type>
  133. <enabled>false</enabled>
  134. </features>
  135. <features>
  136. <name>sipxsss</name>
  137. <bundle>coreTelephony</bundle>
  138. <type>location</type>
  139. <enabled>false</enabled>
  140. </features>
  141. <features>
  142. <name>restServer</name>
  143. <bundle>coreTelephony</bundle>
  144. <type>location</type>
  145. <enabled>false</enabled>
  146. </features>
  147. <features>
  148. <name>conference</name>
  149. <bundle>coreTelephony</bundle>
  150. <type>location</type>
  151. <enabled>false</enabled>
  152. </features>
  153. <features>
  154. <name>homer_capture</name>
  155. <bundle>coreTelephony</bundle>
  156. <type>location</type>
  157. <enabled>false</enabled>
  158. </features>
  159. <features>
  160. <name>mysql</name>
  161. <bundle>coreTelephony</bundle>
  162. <type>location</type>
  163. <enabled>false</enabled>
  164. </features>
  165. <features>
  166. <name>reach</name>
  167. <bundle>callCenter</bundle>
  168. <type>location</type>
  169. <enabled>false</enabled>
  170. </features>
  171. <features>
  172. <name>reach-redis</name>
  173. <bundle>callCenter</bundle>
  174. <type>location</type>
  175. <enabled>false</enabled>
  176. </features>
  177. <features>
  178. <name>instantMessage</name>
  179. <bundle>im</bundle>
  180. <type>location</type>
  181. <enabled>false</enabled>
  182. </features>
  183. <features>
  184. <name>imbot</name>
  185. <bundle>im</bundle>
  186. <type>location</type>
  187. <enabled>false</enabled>
  188. </features>
  189. <features>
  190. <name>dhcpd</name>
  191. <bundle>provision</bundle>
  192. <type>location</type>
  193. <enabled>false</enabled>
  194. </features>
  195. <features>
  196. <name>phonelog</name>
  197. <bundle>provision</bundle>
  198. <type>location</type>
  199. <enabled>false</enabled>
  200. </features>
  201. <features>
  202. <name>hoteling</name>
  203. <bundle>provision</bundle>
  204. <type>location</type>
  205. <enabled>false</enabled>
  206. </features>
  207. <features>
  208. <name>ftp</name>
  209. <bundle>provision</bundle>
  210. <type>location</type>
  211. <enabled>true</enabled>
  212. </features>
  213. <features>
  214. <name>provision</name>
  215. <bundle>provision</bundle>
  216. <type>location</type>
  217. <enabled>false</enabled>
  218. </features>
  219. <features>
  220. <name>tftp</name>
  221. <bundle>provision</bundle>
  222. <type>location</type>
  223. <enabled>true</enabled>
  224. </features>
  225. </Features>
    1. JSON format
  226. {
  227. Wiki Markup
    features: \[36\]

  228. 0: {
  229. bundle: "core"
  230. type: "location"
  231. enabled: false
  232. name: "reports"
  233. }-
  234. 1: {
  235. bundle: "core"
  236. type: "location"
  237. enabled: false
  238. name: "dhcpd"
  239. }-
  240. 2: {
  241. bundle: "core"
  242. type: "location"
  243. enabled: true
  244. name: "sipxdns"
  245. }-
  246. 3: {
  247. bundle: "core"
  248. type: "location"
  249. enabled: false
  250. name: "event"
  251. }-
  252. 4: {
  253. bundle: "coreTelephony"
  254. type: "location"
  255. enabled: false
  256. name: "freeSwitch"
  257. }-
  258. 5: {
  259. bundle: "coreTelephony"
  260. type: "location"
  261. enabled: false
  262. name: "authCode"
  263. }-
  264. 6: {
  265. bundle: "coreTelephony"
  266. type: "location"
  267. enabled: false
  268. name: "recording"
  269. }-
  270. 7: {
  271. bundle: "coreTelephony"
  272. type: "location"
  273. enabled: false
  274. name: "redis"
  275. }-
  276. 8: {
  277. bundle: "coreTelephony"
  278. type: "location"
  279. enabled: false
  280. name: "ivr"
  281. }-
  282. 9: {
  283. bundle: "coreTelephony"
  284. type: "location"
  285. enabled: false
  286. name: "moh"
  287. }-
  288. 10: {
  289. bundle: "coreTelephony"
  290. type: "location"
  291. enabled: false
  292. name: "park"
  293. }-
  294. 11: {
  295. bundle: "coreTelephony"
  296. type: "location"
  297. enabled: false
  298. name: "sbcBridge"
  299. }-
  300. 12: {
  301. bundle: "coreTelephony"
  302. type: "location"
  303. enabled: false
  304. name: "registrar"
  305. }-
  306. 13: {
  307. bundle: "coreTelephony"
  308. type: "location"
  309. enabled: false
  310. name: "sipxcdr"
  311. }-
  312. 14: {
  313. bundle: "coreTelephony"
  314. type: "location"
  315. enabled: false
  316. name: "openuc-saa"
  317. }-
  318. 15: {
  319. bundle: "coreTelephony"
  320. type: "location"
  321. enabled: false
  322. name: "sipxsqa"
  323. }-
  324. 16: {
  325. bundle: "coreTelephony"
  326. type: "location"
  327. enabled: false
  328. name: "callqueue"
  329. }-
  330. 17: {
  331. bundle: "coreTelephony"
  332. type: "location"
  333. enabled: false
  334. name: "mwi"
  335. }-
  336. 18: {
  337. bundle: "coreTelephony"
  338. type: "location"
  339. enabled: false
  340. name: "homer_web"
  341. }-
  342. 19: {
  343. bundle: "coreTelephony"
  344. type: "location"
  345. enabled: false
  346. name: "page"
  347. }-
  348. 20: {
  349. bundle: "coreTelephony"
  350. type: "location"
  351. enabled: false
  352. name: "proxy"
  353. }-
  354. 21: {
  355. bundle: "coreTelephony"
  356. type: "location"
  357. enabled: false
  358. name: "sipxsss"
  359. }-
  360. 22: {
  361. bundle: "coreTelephony"
  362. type: "location"
  363. enabled: false
  364. name: "restServer"
  365. }-
  366. 23: {
  367. bundle: "coreTelephony"
  368. type: "location"
  369. enabled: false
  370. name: "conference"
  371. }-
  372. 24: {
  373. bundle: "coreTelephony"
  374. type: "location"
  375. enabled: false
  376. name: "homer_capture"
  377. }-
  378. 25: {
  379. bundle: "coreTelephony"
  380. type: "location"
  381. enabled: false
  382. name: "mysql"
  383. }-
  384. 26: {
  385. bundle: "callCenter"
  386. type: "location"
  387. enabled: false
  388. name: "reach"
  389. }-
  390. 27: {
  391. bundle: "callCenter"
  392. type: "location"
  393. enabled: false
  394. name: "reach-redis"
  395. }-
  396. 28: {
  397. bundle: "im"
  398. type: "location"
  399. enabled: false
  400. name: "instantMessage"
  401. }-
  402. 29: {
  403. bundle: "im"
  404. type: "location"
  405. enabled: false
  406. name: "imbot"
  407. }-
  408. 30: {
  409. bundle: "provision"
  410. type: "location"
  411. enabled: false
  412. name: "dhcpd"
  413. }-
  414. 31: {
  415. bundle: "provision"
  416. type: "location"
  417. enabled: false
  418. name: "phonelog"
  419. }-
  420. 32: {
  421. bundle: "provision"
  422. type: "location"
  423. enabled: false
  424. name: "hoteling"
  425. }-
  426. 33: {
  427. bundle: "provision"
  428. type: "location"
  429. enabled: true
  430. name: "ftp"
  431. }-
  432. 34: {
  433. bundle: "provision"
  434. type: "location"
  435. enabled: false
  436. name: "provision"
  437. }-
  438. 35: {
  439. bundle: "provision"
  440. type: "location"
  441. enabled: true
  442. name: "tftp"
  443. }-
  444. -
  445. }
  446. Unsupported HTTP Method: POST, PUT, DELETE

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/jobs
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. name
    1. Job name.
    1. status

    Job status. Possible values are: Completed or Failed.

    1. start

    Start date of the job.

    1. end

    End date of the job.

    1. server

    The server related information is similar to the one described under /servers/{serverId}.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve jobs on all servers.
        1. Example: XML format
  8. <Jobs>
  9. <Job>
  10. <name>Configuration deployment</name>
  11. <status>COMPLETED</status>
  12. <start>9/8/14 12:34 PM</start>
  13. <end>9/8/14 12:34 PM</end>
  14. <server>
  15. <id>1</id>
  16. <host>o14_10.ezuce.ro</host>
  17. <ip>192.234.3.788</ip>
  18. <primary>true</primary>
  19. <registered>true</registered>
  20. <description>Primary</description>
  21. </server>
  22. <errMsg />
  23. </Job>
  24. <Job>
  25. <name>Configuration generation</name>
  26. <status>COMPLETED</status>
  27. <start>9/8/14 12:36 PM</start>
  28. <end>9/8/14 12:36 PM</end>
  29. <errMsg />
  30. </Job>
  31. <Job>
  32. <name>Configuration deployment</name>
  33. <status>FAILED</status>
  34. <start>9/8/14 12:36 PM</start>
  35. <end>9/8/14 12:36 PM</end>
  36. <server>
  37. <id>1</id>
  38. <host>o14_10.ezuce.ro</host>
  39. <ip>152.667.1.141</ip>
  40. <primary>true</primary>
  41. <registered>true</registered>
  42. <description>Primary</description>
  43. </server>
  44. <errMsg />
  45. </Job>
  46. </Jobs>
    1. JSON format
  47. {
  48. Wiki Markup
    jobs: \[3\]

  49. 0: {
  50. errMsg: ""
  51. server: {
  52. primary: true
  53. description: "Primary"
  54. host: "o14_10.ezuce.ro"
  55. id: 1
  56. registered: true
  57. ip: "192.234.3.788"
  58. }-
  59. status: "COMPLETED"
  60. start: "9/8/14 12:34 PM"
  61. end: "9/8/14 12:34 PM"
  62. name: "Configuration deployment"
  63. }-
  64. 1: {
  65. errMsg: ""
  66. server: null
  67. status: "COMPLETED"
  68. start: "9/8/14 12:36 PM"
  69. end: "9/8/14 12:36 PM"
  70. name: "Configuration generation"
  71. }-
  72. 2: {
  73. errMsg: ""
  74. server: {
  75. primary: true
  76. description: "Primary"
  77. host: "o14_10.ezuce.ro"
  78. id: 1
  79. registered: true
  80. ip: "152.667.1.141"
  81. }-
  82. status: "FAILED"
  83. start: "9/8/14 12:36 PM"
  84. end: "9/8/14 12:36 PM"
  85. name: "Configuration deployment"
  86. }-
  87. -
  88. }
  89. HTTP Method: DELETE
  90. Delete jobs on all servers.
  91. Unsupported HTTP Method: POST, PUT

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/jobs/failed
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. job
    1. The jobs related information is similar to the one described under /servers/jobs.
            1. server

    The server related information is similar to the one described under /servers/{serverId}.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve failed jobs on all servers.
        1. Example: XML format
  8. <jobs>
  9. <Job>
  10. <name>Configuration deployment</name>
  11. <status>FAILED</status>
  12. <start>9/8/14 12:36 PM</start>
  13. <end>9/8/14 12:36 PM</end>
  14. <server>
  15. <id>1</id>
  16. <host>o14_10.ezuce.ro</host>
  17. <ip>152.667.1.141</ip>
  18. <primary>true</primary>
  19. <registered>true</registered>
  20. <description>Primary</description>
  21. </server>
  22. <errMsg />
  23. </Job>
  24. </Jobs>
    1. JSON format
  25. {
  26. Wiki Markup
    jobs: \[1\]

  27. 0: {
  28. errMsg: ""
  29. server: {
  30. primary: true
  31. description: "Primary"
  32. host: "o14_10.ezuce.ro"
  33. id: 1
  34. registered: true
  35. ip: "192.234.3.788"
  36. }-
  37. ]
  38. HTTP Method: DELETE
  39. Delete failed jobs on all servers.
  40. Unsupported HTTP Method: POST, PUT

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/bundles
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. name
    1. Bundle name.
    1. globalFeature

    List of global features.

    1. locationFeature

    List of location features.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve bundles.
        1. Example: XML format
  8. <Bundles>
  9. <Bundle>
  10. <name>core</name>
  11. <GlobalFeatures>
  12. <Feature>snmp</Feature>
  13. <Feature>sipxlogwatcher</Feature>
  14. <Feature>mail</Feature>
  15. <Feature>firewall</Feature>
  16. <Feature>ntpd</Feature>
  17. <Feature>fail2ban</Feature>
  18. <Feature>alarms</Feature>
  19. </GlobalFeatures>
  20. <LocationFeatures>
  21. <Feature>reports</Feature>
  22. <Feature>dhcpd</Feature>
  23. <Feature>sipxdns</Feature>
  24. <Feature>event</Feature>
  25. </LocationFeatures>
  26. </Bundle>
  27. <Bundle>
  28. <name>coreTelephony</name>
  29. <GlobalFeatures>
  30. <Feature>intercom</Feature>
  31. </GlobalFeatures>
  32. <LocationFeatures>
  33. <Feature>freeSwitch</Feature>
  34. <Feature>authCode</Feature>
  35. <Feature>recording</Feature>
  36. <Feature>redis</Feature>
  37. <Feature>ivr</Feature>
  38. <Feature>moh</Feature>
  39. <Feature>park</Feature>
  40. <Feature>sbcBridge</Feature>
  41. <Feature>registrar</Feature>
  42. <Feature>sipxcdr</Feature>
  43. <Feature>openuc-saa</Feature>
  44. <Feature>sipxsqa</Feature>
  45. <Feature>callqueue</Feature>
  46. <Feature>mwi</Feature>
  47. <Feature>homer_web</Feature>
  48. <Feature>page</Feature>
  49. <Feature>proxy</Feature>
  50. <Feature>sipxsss</Feature>
  51. <Feature>restServer</Feature>
  52. <Feature>conference</Feature>
  53. <Feature>homer_capture</Feature>
  54. <Feature>mysql</Feature>
  55. </LocationFeatures>
  56. </Bundle>
  57. <Bundle>
  58. <name>callCenter</name>
  59. <GlobalFeatures />
  60. <LocationFeatures>
  61. <Feature>reach</Feature>
  62. <Feature>reach-redis</Feature>
  63. </LocationFeatures>
  64. </Bundle>
  65. <Bundle>
  66. <name>im</name>
  67. <GlobalFeatures />
  68. <LocationFeatures>
  69. <Feature>instantMessage</Feature>
  70. <Feature>imbot</Feature>
  71. </LocationFeatures>
  72. </Bundle>
  73. <Bundle>
  74. <name>provision</name>
  75. <GlobalFeatures />
  76. <LocationFeatures>
  77. <Feature>dhcpd</Feature>
  78. <Feature>phonelog</Feature>
  79. <Feature>hoteling</Feature>
  80. <Feature>ftp</Feature>
  81. <Feature>provision</Feature>
  82. <Feature>tftp</Feature>
  83. </LocationFeatures>
  84. </Bundle>
  85. <Bundle>
  86. <name>experimental</name>
  87. <GlobalFeatures />
  88. <LocationFeatures />
  89. </Bundle>
  90. </Bundles>
    1. JSON format
  91. {
  92. Wiki Markup
    bundles: \[6\]

  93. 0: {
  94. Wiki Markup
    locationFeatures: \[4\]

  95. 0: "reports"
  96. 1: "dhcpd"
  97. 2: "sipxdns"
  98. 3: "event"
  99. -
  100. Wiki Markup
    globalFeatures: \[7\]

  101. 0: "snmp"
  102. 1: "sipxlogwatcher"
  103. 2: "mail"
  104. 3: "firewall"
  105. 4: "ntpd"
  106. 5: "fail2ban"
  107. 6: "alarms"
  108. -
  109. name: "core"
  110. }-
  111. 1: {
  112. Wiki Markup
    locationFeatures: \[22\]

  113. 0: "freeSwitch"
  114. 1: "authCode"
  115. 2: "recording"
  116. 3: "redis"
  117. 4: "ivr"
  118. 5: "moh"
  119. 6: "park"
  120. 7: "sbcBridge"
  121. 8: "registrar"
  122. 9: "sipxcdr"
  123. 10: "openuc-saa"
  124. 11: "sipxsqa"
  125. 12: "callqueue"
  126. 13: "mwi"
  127. 14: "homer_web"
  128. 15: "page"
  129. 16: "proxy"
  130. 17: "sipxsss"
  131. 18: "restServer"
  132. 19: "conference"
  133. 20: "homer_capture"
  134. 21: "mysql"
  135. -
  136. Wiki Markup
    globalFeatures: \[1\]

  137. 0: "intercom"
  138. -
  139. name: "coreTelephony"
  140. }-
  141. 2: {
  142. Wiki Markup
    locationFeatures: \[2\]

  143. 0: "reach"
  144. 1: "reach-redis"
  145. -
  146. Wiki Markup
    globalFeatures: \[0\]

  147. name: "callCenter"
  148. }-
  149. 3: {
  150. Wiki Markup
    locationFeatures: \[2\]

  151. 0: "instantMessage"
  152. 1: "imbot"
  153. -
  154. Wiki Markup
    globalFeatures: \[0\]

  155. name: "im"
  156. }-
  157. 4: {
  158. Wiki Markup
    locationFeatures: \[6\]

  159. 0: "dhcpd"
  160. 1: "phonelog"
  161. 2: "hoteling"
  162. 3: "ftp"
  163. 4: "provision"
  164. 5: "tftp"
  165. -
  166. Wiki Markup
    globalFeatures: \[0\]

  167. name: "provision"
  168. }-
  169. 5: {
  170. Wiki Markup
    locationFeatures: \[0\]

  171. Wiki Markup
    globalFeatures: \[0\]

  172. name: "experimental"
  173. }-
  174. -
  175. }
  176. HTTP Method: DELETE
  177. Delete bundles.
  178. Unsupported HTTP Method: POST, PUT

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/bundles/{bundleId}
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. name
    1. Bundle name.
    1. globalFeature

    List of global features.

    1. locationFeature

    List of location features.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieve bundles on the specified bundle ID.
        1. Example: XML format
  8. <Bundle>
  9. <name>im</name>
  10. <GlobalFeatures />
  11. <LocationFeatures>
  12. <Feature>instantMessage</Feature>
  13. <Feature>imbot</Feature>
  14. </LocationFeatures>
  15. </Bundle>
    1. JSON format
  16. {
  17. Wiki Markup
    locationFeatures: \[2\]

  18. 0: "instantMessage"
  19. 1: "imbot"
  20. -
  21. Wiki Markup
    globalFeatures: \[0\]

  22. name: "im"
  23. }
  24. HTTP Method: DELETE
  25. Delete bundles on the specified bundle ID.
  26. Unsupported HTTP Method: POST, PUT

...

  1. Available in 14 starting with 14.10
  2. Resource URI: /servers/features
  3. Default Resource Properties:
  4. The resource is represented by the following properties when the GET request is performed:
    1. Property
    1. Description
    1. name
    1. Feature name.
    1. bundle

    The bundle containig the feature.

    1. type

    Feature type.

    1. enabled

    The status of the feature. Displays True if it is enabled or False if it is disabled.

  5. Specific Response Codes: N/A
  6. HTTP Method: GET
  7. Retrieves list of all global features.
        1. Example: XML format
  8. <Features>
  9. <features>
  10. <name>snmp</name>
  11. <bundle>core</bundle>
  12. <type>global</type>
  13. <enabled>true</enabled>
  14. </features>
  15. <features>
  16. <name>sipxlogwatcher</name>
  17. <bundle>core</bundle>
  18. <type>global</type>
  19. <enabled>true</enabled>
  20. </features>
  21. <features>
  22. <name>reports</name>
  23. <bundle>core</bundle>
  24. <type>location</type>
  25. <enabled>false</enabled>
  26. </features>
  27. <features>
  28. <name>mail</name>
  29. <bundle>core</bundle>
  30. <type>global</type>
  31. <enabled>true</enabled>
  32. </features>
  33. <features>
  34. <name>dhcpd</name>
  35. <bundle>core</bundle>
  36. <type>location</type>
  37. <enabled>false</enabled>
  38. </features>
  39. <features>
  40. <name>provision</name>
  41. <bundle>provision</bundle>
  42. <type>location</type>
  43. <enabled>false</enabled>
  44. </features>
  45. <features>
  46. <name>tftp</name>
  47. <bundle>provision</bundle>
  48. <type>location</type>
  49. <enabled>true</enabled>
  50. </features>
  51. </Features>
    1. JSON format
  52. {
  53. Wiki Markup
    features: \[44\]

  54. 0: {
  55. bundle: "core"
  56. type: "global"
  57. enabled: true
  58. name: "snmp"
  59. }-
  60. {
  61. bundle: "core"
  62. type: "global"
  63. enabled: true
  64. name: "sipxlogwatcher"
  65. }-
  66. {
  67. bundle: "core"
  68. type: "location"
  69. enabled: false
  70. name: "reports"
  71. }-
  72. {
  73. bundle: "core"
  74. type: "global"
  75. enabled: true
  76. name: "mail"
  77. }-
  78. {
  79. bundle: "core"
  80. type: "location"
  81. enabled: false
  82. name: "dhcpd"
  83. }-
  84. {
  85. bundle: "core"
  86. type: "global"
  87. enabled: true
  88. name: "firewall"
  89. }
  90. {
  91. bundle: "provision"
  92. type: "location"
  93. enabled: false
  94. name: "provision"
  95. }-
  96. {
  97. bundle: "provision"
  98. type: "location"
  99. enabled: true
  100. name: "tftp"
  101. }-
  102. -
  103. }
  104. Unsupported HTTP Method: POST, PUT, DELETE

...