templates_controller.rb 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. # Copyright (C) 2012-2014 Zammad Foundation, http://zammad-foundation.org/
  2. class TemplatesController < ApplicationController
  3. before_filter :authentication_check
  4. =begin
  5. Format:
  6. JSON
  7. Example:
  8. {
  9. "id":1,
  10. "name":"some template",
  11. "user_id": null,
  12. "options":{"a":1,"b":2},
  13. "updated_at":"2012-09-14T17:51:53Z",
  14. "created_at":"2012-09-14T17:51:53Z",
  15. "updated_by_id":2.
  16. "created_by_id":2,
  17. }
  18. =end
  19. =begin
  20. Resource:
  21. GET /api/v1/templates.json
  22. Response:
  23. [
  24. {
  25. "id": 1,
  26. "name": "some_name1",
  27. ...
  28. },
  29. {
  30. "id": 2,
  31. "name": "some_name2",
  32. ...
  33. }
  34. ]
  35. Test:
  36. curl http://localhost/api/v1/templates.json -v -u #{login}:#{password}
  37. =end
  38. def index
  39. return if deny_if_not_role('Agent')
  40. model_index_render(Template, params)
  41. end
  42. =begin
  43. Resource:
  44. GET /api/v1/templates/#{id}.json
  45. Response:
  46. {
  47. "id": 1,
  48. "name": "name_1",
  49. ...
  50. }
  51. Test:
  52. curl http://localhost/api/v1/templates/#{id}.json -v -u #{login}:#{password}
  53. =end
  54. def show
  55. return if deny_if_not_role('Agent')
  56. model_show_render(Template, params)
  57. end
  58. =begin
  59. Resource:
  60. POST /api/v1/templates.json
  61. Payload:
  62. {
  63. "name": "some name",
  64. "options":{"a":1,"b":2},
  65. }
  66. Response:
  67. {
  68. "id": 1,
  69. "name": "some_name",
  70. ...
  71. }
  72. Test:
  73. curl http://localhost/api/v1/templates.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
  74. =end
  75. def create
  76. return if deny_if_not_role('Agent')
  77. model_create_render(Template, params)
  78. end
  79. =begin
  80. Resource:
  81. PUT /api/v1/templates/{id}.json
  82. Payload:
  83. {
  84. "name": "some name",
  85. "options":{"a":1,"b":2},
  86. }
  87. Response:
  88. {
  89. "id": 1,
  90. "name": "some_name",
  91. ...
  92. }
  93. Test:
  94. curl http://localhost/api/v1/templates.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
  95. =end
  96. def update
  97. return if deny_if_not_role('Agent')
  98. model_update_render(Template, params)
  99. end
  100. =begin
  101. Resource:
  102. DELETE /api/v1/templates/{id}.json
  103. Response:
  104. {}
  105. Test:
  106. curl http://localhost/api/v1/templates.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X DELETE
  107. =end
  108. def destroy
  109. return if deny_if_not_role('Agent')
  110. model_destory_render(Template, params)
  111. end
  112. end