solarwinds-itsm-api-definitions 0.0.9 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (113) hide show
  1. checksums.yaml +4 -4
  2. data/lib/definitions/common/components.json +354 -124
  3. data/lib/definitions/common/examples/catalog_item.json +70 -0
  4. data/lib/definitions/common/examples/change.json +123 -0
  5. data/lib/definitions/common/examples/change_catalog.json +72 -0
  6. data/lib/definitions/common/examples/configuration_item.json +110 -0
  7. data/lib/definitions/common/examples/hardware.json +100 -0
  8. data/lib/definitions/common/examples/incident.json +129 -115
  9. data/lib/definitions/common/examples/problem.json +110 -0
  10. data/lib/definitions/common/examples/release.json +128 -0
  11. data/lib/definitions/common/examples/service_request.json +28 -0
  12. data/lib/definitions/common/examples/solution.json +44 -0
  13. data/lib/definitions/common/examples/user.json +76 -0
  14. data/lib/definitions/common/schemas/analytics/audit.json +28 -0
  15. data/lib/definitions/common/schemas/analytics/risk.json +28 -0
  16. data/lib/definitions/common/schemas/inventory/hardware.json +104 -0
  17. data/lib/definitions/common/schemas/inventory/mobile.json +73 -0
  18. data/lib/definitions/common/schemas/inventory/other_asset.json +74 -0
  19. data/lib/definitions/common/schemas/inventory/printer.json +41 -0
  20. data/lib/definitions/common/schemas/inventory/software.json +28 -0
  21. data/lib/definitions/common/schemas/inventory/warranty.json +40 -0
  22. data/lib/definitions/common/schemas/procurement/contract.json +67 -0
  23. data/lib/definitions/common/schemas/procurement/item.json +51 -0
  24. data/lib/definitions/common/schemas/procurement/purchase.json +57 -0
  25. data/lib/definitions/common/schemas/procurement/purchase_order.json +82 -0
  26. data/lib/definitions/common/schemas/procurement/vendor.json +67 -0
  27. data/lib/definitions/common/schemas/service_desk/catalog_item.json +71 -0
  28. data/lib/definitions/common/schemas/service_desk/change.json +88 -0
  29. data/lib/definitions/common/schemas/service_desk/change_catalog.json +77 -0
  30. data/lib/definitions/common/schemas/service_desk/comment.json +52 -0
  31. data/lib/definitions/common/schemas/service_desk/configuration_item.json +119 -0
  32. data/lib/definitions/common/schemas/service_desk/incident.json +89 -0
  33. data/lib/definitions/common/schemas/service_desk/problem.json +81 -0
  34. data/lib/definitions/common/schemas/service_desk/release.json +86 -0
  35. data/lib/definitions/common/schemas/service_desk/service_request.json +31 -0
  36. data/lib/definitions/common/schemas/service_desk/solution.json +61 -0
  37. data/lib/definitions/common/schemas/service_desk/time_track.json +37 -0
  38. data/lib/definitions/common/schemas/setup/category.json +54 -0
  39. data/lib/definitions/common/schemas/setup/department.json +48 -0
  40. data/lib/definitions/common/schemas/setup/group.json +65 -0
  41. data/lib/definitions/common/schemas/setup/role.json +51 -0
  42. data/lib/definitions/common/schemas/setup/site.json +64 -0
  43. data/lib/definitions/common/schemas/setup/user.json +67 -0
  44. data/lib/definitions/common/schemas/tasks/task.json +52 -0
  45. data/lib/definitions/openapi.json +96 -6
  46. data/lib/definitions/paths/attachments/attachments.json +12 -0
  47. data/lib/definitions/paths/audits/audits.json +35 -0
  48. data/lib/definitions/paths/audits/audits_by_id.json +37 -0
  49. data/lib/definitions/paths/catalog_items/catalog_item_by_id.json +83 -0
  50. data/lib/definitions/paths/catalog_items/catalog_items.json +69 -0
  51. data/lib/definitions/paths/categories/categories.json +62 -0
  52. data/lib/definitions/paths/categories/category_by_id.json +70 -0
  53. data/lib/definitions/paths/change_catalogs/change_catalog_by_id.json +83 -0
  54. data/lib/definitions/paths/change_catalogs/change_catalogs.json +69 -0
  55. data/lib/definitions/paths/changes/change_by_id.json +83 -0
  56. data/lib/definitions/paths/changes/changes.json +69 -0
  57. data/lib/definitions/paths/comments/comment_by_id.json +65 -0
  58. data/lib/definitions/paths/comments/comments.json +31 -0
  59. data/lib/definitions/paths/configuration_items/append_dependent_assets.json +24 -0
  60. data/lib/definitions/paths/configuration_items/configuration_item_by_id.json +83 -0
  61. data/lib/definitions/paths/configuration_items/configuration_items.json +69 -0
  62. data/lib/definitions/paths/configuration_items/delete_asset_link.json +24 -0
  63. data/lib/definitions/paths/contracts/contract_by_id.json +74 -0
  64. data/lib/definitions/paths/contracts/contracts.json +62 -0
  65. data/lib/definitions/paths/contracts/item_by_id.json +75 -0
  66. data/lib/definitions/paths/contracts/items.json +30 -0
  67. data/lib/definitions/paths/departments/department_by_id.json +70 -0
  68. data/lib/definitions/paths/departments/departments.json +62 -0
  69. data/lib/definitions/paths/groups/group_by_id.json +70 -0
  70. data/lib/definitions/paths/groups/groups.json +62 -0
  71. data/lib/definitions/paths/hardwares/hardware_by_id.json +83 -0
  72. data/lib/definitions/paths/hardwares/hardwares.json +69 -0
  73. data/lib/definitions/paths/hardwares/warranties.json +64 -0
  74. data/lib/definitions/paths/hardwares/warranty_by_id.json +75 -0
  75. data/lib/definitions/paths/incidents/incident_by_id.json +28 -10
  76. data/lib/definitions/paths/incidents/incidents.json +36 -8
  77. data/lib/definitions/paths/memberships/membership_by_id.json +20 -0
  78. data/lib/definitions/paths/memberships/memberships.json +29 -0
  79. data/lib/definitions/paths/mobiles/mobile_by_id.json +74 -0
  80. data/lib/definitions/paths/mobiles/mobiles.json +62 -0
  81. data/lib/definitions/paths/other_assets/other_asset_by_id.json +74 -0
  82. data/lib/definitions/paths/other_assets/other_assets.json +62 -0
  83. data/lib/definitions/paths/printers/printer_by_id.json +53 -0
  84. data/lib/definitions/paths/printers/printers.json +36 -0
  85. data/lib/definitions/paths/problems/problem_by_id.json +83 -0
  86. data/lib/definitions/paths/problems/problems.json +69 -0
  87. data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +74 -0
  88. data/lib/definitions/paths/purchase_orders/purchase_orders.json +62 -0
  89. data/lib/definitions/paths/purchases/purchase_by_id.json +65 -0
  90. data/lib/definitions/paths/purchases/purchases.json +31 -0
  91. data/lib/definitions/paths/releases/release_by_id.json +83 -0
  92. data/lib/definitions/paths/releases/releases.json +69 -0
  93. data/lib/definitions/paths/risks/risks.json +34 -0
  94. data/lib/definitions/paths/roles/role_by_id.json +70 -0
  95. data/lib/definitions/paths/roles/roles.json +62 -0
  96. data/lib/definitions/paths/service_requests/request_by_id.json +37 -0
  97. data/lib/definitions/paths/sites/site_by_id.json +74 -0
  98. data/lib/definitions/paths/sites/sites.json +62 -0
  99. data/lib/definitions/paths/softwares/software_by_id.json +24 -0
  100. data/lib/definitions/paths/softwares/softwares.json +36 -0
  101. data/lib/definitions/paths/solutions/solution_by_id.json +83 -0
  102. data/lib/definitions/paths/solutions/solutions.json +69 -0
  103. data/lib/definitions/paths/tasks/task_by_id.json +65 -0
  104. data/lib/definitions/paths/tasks/tasks.json +31 -0
  105. data/lib/definitions/paths/time_tracks/time_track_by_id.json +65 -0
  106. data/lib/definitions/paths/time_tracks/time_tracks.json +66 -0
  107. data/lib/definitions/paths/users/user_by_id.json +83 -0
  108. data/lib/definitions/paths/users/users.json +69 -0
  109. data/lib/definitions/paths/vendors/vendor_by_id.json +74 -0
  110. data/lib/definitions/paths/vendors/vendors.json +62 -0
  111. data/lib/resolved_schema/resolved_schema.json +1 -1
  112. metadata +106 -3
  113. data/lib/definitions/common/schemas/incident.json +0 -106
data/lib/resolved_schema/resolved_schema.json CHANGED
@@ -1 +1 @@
1
- {"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.0.9","contact":{"name":"API Support","url":"samanage.com/support","email":"support@samanage.com"}},"servers":[{"url":"https://api.samanage.com"},{"url":"https://apieu.samanage.com"}],"paths":{"/incidents/{id}":{"get":{"operationId":"getIncidentById","description":"Get incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateIncidentById","description":"Update incident with specified fields","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Incident fields to update","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteIncidentById","description":"Delete incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/incidents":{"get":{"operationId":"getIncidents","description":"List of incidents","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of incidents","type":"array","items":{"allOf":[{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}]}},"example":[{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}]},"application/xml":{"schema":{"description":"List of incidents","type":"array","items":{"allOf":[{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}]}},"example":[{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}]}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createIncident","description":"Create new incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Incident fields to fill","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}}},"tags":[{"name":"Incident","description":"Incident operations"}]}
1
+ {"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.1.4","contact":{"name":"API Support","url":"samanage.com/support","email":"support@samanage.com"}},"servers":[{"url":"https://api.samanage.com"},{"url":"https://apieu.samanage.com"}],"paths":{"/incidents/{id}":{"get":{"operationId":"getIncidentById","description":"Get incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}],"is_service_request":false,"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateIncidentById","description":"Update incident with specified fields","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Incident fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","properties":{"name":{"type":"string","example":"Incident Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"solutions":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"changes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Text custom field","value":"content"},{"name":"User custom field","user_value":{"email":"john.doe@email.com"}}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"],"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","properties":{"name":{"type":"string","example":"Incident Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"solutions":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"changes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}],"is_service_request":false,"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteIncidentById","description":"Delete incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted incident's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/incidents":{"get":{"operationId":"getIncidents","description":"List of incidents","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of incidents","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}},"example":[{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}],"is_service_request":false,"cc":["jane.doe@email.com"]}}]},"application/xml":{"schema":{"description":"List of incidents","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createIncident","description":"Create new incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Incident fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Incident Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"solutions":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"changes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Text custom field","value":"content"},{"name":"User custom field","user_value":{"email":"john.doe@email.com"}}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"],"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Incident Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"solutions":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"changes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}],"is_service_request":false,"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/problems/{id}":{"get":{"operationId":"getProblemById","description":"Get problem","tags":["Problem"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateProblemById","description":"Update problem with specified fields","tags":["Problem"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Problem fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"workaround description"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"problem":{"name":"Problem Name","site_id":1,"department_id":1,"description":"description","state":1,"root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1","custom_fields_values_attributes":[{"id":"10","custom_field_id":1,"value":"content"}],"incident_ids":[100],"itsm_change_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"workaround description"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteProblemById","description":"Delete problem","tags":["Problem"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted problem's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/problems":{"get":{"operationId":"getProblems","description":"List of problems","tags":["Problem"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of problems","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}]}},"example":[{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}]},"application/xml":{"schema":{"description":"List of problems","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createProblem","description":"Create new problem","tags":["Problem"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Problem fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"workaround description"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"problem":{"name":"Problem Name","site_id":1,"department_id":1,"description":"description","state":1,"root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1","custom_fields_values_attributes":[{"id":"10","custom_field_id":1,"value":"content"}],"incident_ids":[100],"itsm_change_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"problem":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"workaround description"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"problem":{"id":"10000","number":"1000","name":"Problem Name","description":"description","state":"New","root_cause":"Root cause description","symptoms":"Symptoms description","workaround":"workaround description","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"problem":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Problem Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"root_cause":{"type":"string","example":"Root cause description"},"symptoms":{"type":"string","example":"Symptoms description"},"workaround":{"type":"string","example":"Workaround description"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/changes/{id}":{"get":{"operationId":"getChangeById","description":"Get change","tags":["Change"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateChangeById","description":"Update change with specified fields","tags":["Change"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Change fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change":{"type":"object","properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"change":{"name":"Change Name","change_type":1,"site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01 00:00","planned_end_at":"2025-01-01 05:00","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Text custom field","value":"content"},{"name":"User custom field","user_value":{"email":"john.doe@email.com"}}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change":{"type":"object","properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteChangeById","description":"Delete change","tags":["Change"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted change's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/changes":{"get":{"operationId":"getChanges","description":"List of changes","tags":["Change"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of changes","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}]}},"example":[{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}]},"application/xml":{"schema":{"description":"List of changes","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createChange","description":"Create new change","tags":["Change"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Change fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change":{"type":"object","required":["name","change_type"],"properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"change":{"name":"Change Name","change_type":1,"site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01 00:00","planned_end_at":"2025-01-01 05:00","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Text custom field","value":"content"},{"name":"User custom field","user_value":{"email":"john.doe@email.com"}}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change":{"type":"object","required":["name","change_type"],"properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incidents":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"problems":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"releases":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}},{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}]},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}},"example":{"change":{"id":"10000","number":"1000","name":"Change Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/change_catalogs/{id}":{"get":{"operationId":"getChangeCatalogById","description":"Get change catalog","tags":["Change Catalog"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}},"example":{"change_catalog":{"id":"1","number":"1","name":"Change Catalog Name","description":"description","state":"Approved","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","default_assignee_id":1,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","options":"","type_name":"Text"}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","show_in_portal":true}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateChangeCatalogById","description":"Update change catalog with specified fields","tags":["Change Catalog"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Change catalog fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_catalog":{"type":"object","properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"show_in_portal":{"type":"boolean","example":true}}}}},"example":{"change_catalog":{"name":"Change Catalog Name","change_type":1,"site_id":1,"department_id":1,"description":"description","state_id":1,"default_assignee_id":1,"priority":"High","change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]}},"show_in_portal":true}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_catalog":{"type":"object","properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"show_in_portal":{"type":"boolean","example":true}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}},"example":{"change_catalog":{"id":"1","number":"1","name":"Change Catalog Name","description":"description","state":"Approved","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","default_assignee_id":1,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","options":"","type_name":"Text"}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","show_in_portal":true}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteChangeCatalogById","description":"Delete change catalog","tags":["Change Catalog"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted change catalog's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/change_catalogs":{"get":{"operationId":"getChangeCatalogs","description":"List of change catalogs","tags":["Change Catalog"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of change catalogs","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}}]}},"example":[{"change_catalog":{"id":"1","number":"1","name":"Change Catalog Name","description":"description","state":"Approved","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","default_assignee_id":1,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","options":"","type_name":"Text"}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","show_in_portal":true}}]},"application/xml":{"schema":{"description":"List of change catalogs","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createChangeCatalog","description":"Create new change catalog","tags":["Change Catalog"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Change catalog fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_catalog":{"type":"object","required":["name","change_type"],"properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"show_in_portal":{"type":"boolean","example":true}}}}},"example":{"change_catalog":{"name":"Change Catalog Name","change_type":1,"site_id":1,"department_id":1,"description":"description","state_id":1,"default_assignee_id":1,"priority":"High","change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]}},"show_in_portal":true}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"change_catalog":{"type":"object","required":["name","change_type"],"properties":{"name":{"type":"string","example":"Change Name"},"change_type":{"type":"integer","example":1},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"show_in_portal":{"type":"boolean","example":true}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}},"example":{"change_catalog":{"id":"1","number":"1","name":"Change Catalog Name","description":"description","state":"Approved","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"priority":"High","default_assignee_id":1,"custom_fields_values":[{"id":"1","custom_field_id":"1","name":"Name of custom text field","value":"content","options":"","type_name":"Text"}],"change_plan":"change plan","rollback_plan":"rollback plan","test_plan":"test plan","origin":"api","created_at":"2025-01-01T00:00:00.000+01:00","show_in_portal":true}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"change_catalog":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Change Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Approved"},"priority":{"type":"string","example":"High"},"change_plan":{"type":"string","example":"change plan"},"rollback_plan":{"type":"string","example":"rollback plan"},"test_plan":{"type":"string","example":"test plan"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"default_assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"show_in_portal":{"type":"boolean","example":true}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/releases/{id}":{"get":{"operationId":"getReleaseById","description":"Get release","tags":["Release"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}},"example":{"release":{"id":"10000","number":"1000","name":"Release Name","description":"description","state":"New","plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"Austin TX, USA"},"department":{"id":"1","name":"Support","description":"Support Department","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"approvers":[{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateReleaseById","description":"Update release with specified fields","tags":["Release"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Release fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}},"example":{"release":{"name":"Release Name","site_id":1,"department_id":1,"description":"description","state":1,"plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01 00:00","planned_end_at":"2025-01-01 05:00","assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1","custom_fields_values_attributes":[{"id":"10","custom_field_id":1,"value":"content"}],"approval_levels_attributes":[{"id":"1","approver_ids":"1","approval_condition":"1"}],"itsm_change_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}},"example":{"release":{"id":"10000","number":"1000","name":"Release Name","description":"description","state":"New","plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"Austin TX, USA"},"department":{"id":"1","name":"Support","description":"Support Department","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"approvers":[{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteReleaseById","description":"Delete release","tags":["Release"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted release's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/releases":{"get":{"operationId":"getRelease","description":"List of release","tags":["Release"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of releases","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}]}},"example":[{"release":{"id":"10000","number":"1000","name":"Release Name","description":"description","state":"New","plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"Austin TX, USA"},"department":{"id":"1","name":"Support","description":"Support Department","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"approvers":[{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}]},"application/xml":{"schema":{"description":"List of releases","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createRelease","description":"Create new release","tags":["Release"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Release fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","required":["name","requester"],"properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}},"example":{"release":{"name":"Release Name","site_id":1,"department_id":1,"description":"description","state":1,"plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01 00:00","planned_end_at":"2025-01-01 05:00","assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1","custom_fields_values_attributes":[{"id":"10","custom_field_id":1,"value":"content"}],"approval_levels_attributes":[{"id":"1","approver_ids":"1","approval_condition":"1"}],"itsm_change_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"release":{"type":"object","required":["name","requester"],"properties":{"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"New"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01 00:00"},"planned_end_at":{"type":"string","example":"2025-01-01 05:00"},"add_to_tag_list":{"type":"string","example":"tag1"},"remove_from_tag_list":{"type":"string","example":"tag2"},"tag_list":{"type":"string","example":"tag1"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}},"example":{"release":{"id":"10000","number":"1000","name":"Release Name","description":"description","state":"New","plan":"plan description","build":"build description","deploy":"deploy description","planned_start_at":"2025-01-01T00:00:00.000+01:00","planned_end_at":"2025-01-01T05:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"Austin TX, USA"},"department":{"id":"1","name":"Support","description":"Support Department","default_assignee_id":"1"},"priority":"High","created_by":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"tags":[{"id":1,"name":"tag1","taggings_count":1}],"approvers":[{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"release":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Release Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"plan":{"type":"string","example":"plan description"},"build":{"type":"string","example":"build description"},"deploy":{"type":"string","example":"deploy description"},"planned_start_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"planned_end_at":{"type":"string","example":"2025-01-01T05:00:00.000+01:00"},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"approvers":{"type":"array","items":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/solutions/{id}":{"get":{"operationId":"getSolutionById","description":"Get solution","tags":["Solution"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}},"example":{"solution":{"id":"10000","number":"1000","name":"Solution Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateSolutionById","description":"Update solution with specified fields","tags":["Solution"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Solution fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"solution":{"type":"object","properties":{"name":{"type":"string","example":"Solution Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"solution":{"name":"Solution Name","site_id":1,"department_id":1,"description":"description","state":"Approved","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incident_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"solution":{"type":"object","properties":{"name":{"type":"string","example":"Solution Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}},"example":{"solution":{"id":"10000","number":"1000","name":"Solution Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteSolutionById","description":"Delete solution","tags":["Solution"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted solution's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/solutions":{"get":{"operationId":"getSolutions","description":"List of solutions","tags":["Solution"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of solutions","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}}},"example":[{"solution":{"id":"10000","number":"1000","name":"Solution Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}]},"application/xml":{"schema":{"description":"List of solutions","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createSolution","description":"Create new solution","tags":["Solution"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"solution fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"solution":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Solution Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"solution":{"name":"Solution Name","site_id":1,"department_id":1,"description":"description","state":"Approved","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incident_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"solution":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Solution Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}},"example":{"solution":{"id":"10000","number":"1000","name":"Solution Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","creator":{"id":"1","name":"John Doe","email":"john.doe@email.com"},"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"solution":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Solution Name"},"description":{"type":"string","example":"description"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/catalog_items/{id}":{"get":{"operationId":"getCatalogItemById","description":"Get catalog item","tags":["Catalog Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}},"example":{"catalog_item":{"id":"10000","number":"1000","name":"CI Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"tags":[{"id":1,"name":"tag1","taggings_count":1}],"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateCatalogItemById","description":"Update catalog item with specified fields","tags":["Catalog Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Catalog item fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"catalog_item":{"type":"object","properties":{"name":{"type":"string","example":"CI Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"anyOf":[{"type":"string","example":"1"},{"type":"boolean","example":true}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}},"example":{"catalog_item":{"name":"CI Name","site_id":1,"department_id":1,"description":"description","state":"Approved","default_assignee_id":"1","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"catalog_item":{"type":"object","properties":{"name":{"type":"string","example":"CI Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"anyOf":[{"type":"string","example":"1"},{"type":"boolean","example":true}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}},"example":{"catalog_item":{"id":"10000","number":"1000","name":"CI Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"tags":[{"id":1,"name":"tag1","taggings_count":1}],"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteCatalogItemById","description":"Delete catalog item","tags":["Catalog Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted catalog item's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/catalog_items":{"get":{"operationId":"getCatalogItems","description":"List of catalog items","tags":["Catalog Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of catalog items","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}}},"example":[{"catalog_item":{"id":"10000","number":"1000","name":"CI Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"tags":[{"id":1,"name":"tag1","taggings_count":1}],"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}]},"application/xml":{"schema":{"description":"List of catalog items","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createCatalogItem","description":"Create new catalog item","tags":["Catalog Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Catalog Item fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"catalog_item":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","example":"CI Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"anyOf":[{"type":"string","example":"1"},{"type":"boolean","example":true}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}},"example":{"catalog_item":{"name":"CI Name","site_id":1,"department_id":1,"description":"description","state":"Approved","default_assignee_id":"1","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"add_to_tag_list":"tag1","remove_from_tag_list":"tag2","tag_list":"tag1"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"catalog_item":{"type":"object","required":["name","category"],"properties":{"name":{"type":"string","example":"CI Name"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"description":{"type":"string","example":"description"},"state":{"type":"string","example":"Approved"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"anyOf":[{"type":"string","example":"1"},{"type":"boolean","example":true}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}},"example":{"catalog_item":{"id":"10000","number":"1000","name":"CI Name","description":"description","created_at":"2025-01-01T00:00:00.000+01:00","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"expected_delivery_time":"1 day","currency":"USD","price":"1","show_price":true,"tags":[{"id":1,"name":"tag1","taggings_count":1}],"origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"catalog_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"expected_delivery_time":{"type":"string","example":"1 day"},"currency":{"type":"string","example":"USD"},"price":{"type":"string","example":"1"},"show_price":{"type":"boolean","example":true},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/catalog_items/{id}/service_requests":{"post":{"operationId":"createServiceRequest","description":"Request a Service","tags":["Service Request"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"description":"Service Request fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","properties":{"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester_name":{"type":"string","format":"email","example":"john.doe@email.com"},"priority":{"type":"string","example":"High"},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"request_variables_attributes":{"anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}},{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}}]}}}}},"example":{"incident":{"site_id":"1","department_id":"1","requester_name":"john.doe@email.com","priority":"High","due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","request_variables_attributes":[{"name":"Variable name","value":"Content"},{"name":"User Variable","user_value":{"email":"john.doe@email.com"}},{"name":"MultyPickList variable","value":"option1#dlmtr#option2"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"incident":{"type":"object","properties":{"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"requester_name":{"type":"string","format":"email","example":"john.doe@email.com"},"priority":{"type":"string","example":"High"},"due_at":{"type":"string","example":"Jan 01,2025"},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"request_variables_attributes":{"anyOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}},{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Variable name"},"value":{"type":"string","example":"Content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"requester":{"id":"1","account_id":"1","user_id":"1","email":"john.doe@email.com","name":"John Doe","disabled":false,"avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"10","custom_field_id":"1","name":"Text custom field","value":"content","options":"","type_name":"Text"},{"id":"100","custom_field_id":"1","name":"User custom field","value":"1","options":"","type_name":"User","user":{"group_id":1,"is_user":true,"id":1,"name":"John Doe","email":"john.doe@email.com"}}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}],"is_service_request":false,"cc":["jane.doe@email.com"]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Incident Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"New"},"priority":{"type":"string","example":"High"},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Category / Subcategory name"},"default_tags":{"type":"string","example":"tag1, tag2"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"due_at":{"type":"string","example":"Jan 01,2025"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"origin":{"type":"string","example":"api"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"is_service_request":{"type":"boolean","example":true},"cc":{"type":"array","items":{"type":"string","format":"email","example":"john.doe@email.com"},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\</cc\\> \\</cc\\>\""}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/configuration_items/{id}":{"get":{"operationId":"getConfigurationItemById","description":"Get configuration item","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}},"example":{"configuration_item":{"id":"10000","number":"1000","name":"Configuration Item Name","description":"description","asset_tag":"ConfigurationItemTag","type":{"id":1,"name":"Building","description":"Configuration Item - Building","parent_id":1,"custom":false,"updated_at":"2025-01-01T00:00:00.000+01:00","icon_name":"BUILDING"},"type_id":1,"state":"Active","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"manager_id":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"user_id":{"group_id":"1","is_user":"true","id":"1","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"updated_at":"2025-01-01T00:00:00.000+01:00","created_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateConfigurationItemById","description":"Update configuration item with specified fields","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Configuration Item fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","properties":{"type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"asset_tag":{"type":"string","example":"Configuration Item Tag"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Active"},"manager":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"problem_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"purchase_order_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"release_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"configuration_item":{"name":"Configuration Item Name","description":"Description","type":{"name":"Building"},"type_id":1,"asset_tag":"ConfigurationItemTag","site_id":1,"department_id":1,"state":"Active","manager":{"email":"john.doe@email.com"},"user":{"email":"jane.doe@email.com"},"add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values_attributes":[{"id":"1","custom_field_id":1,"value":"content"}],"incident_ids":[100],"problem_ids":[100],"itsm_change_ids":[100],"release_ids":[100],"purchase_order_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","properties":{"type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"asset_tag":{"type":"string","example":"Configuration Item Tag"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Active"},"manager":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"problem_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"purchase_order_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"release_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}},"example":{"configuration_item":{"id":"10000","number":"1000","name":"Configuration Item Name","description":"description","asset_tag":"ConfigurationItemTag","type":{"id":1,"name":"Building","description":"Configuration Item - Building","parent_id":1,"custom":false,"updated_at":"2025-01-01T00:00:00.000+01:00","icon_name":"BUILDING"},"type_id":1,"state":"Active","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"manager_id":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"user_id":{"group_id":"1","is_user":"true","id":"1","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"updated_at":"2025-01-01T00:00:00.000+01:00","created_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteConfigurationItemById","description":"Delete configurationitem","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted configuration item's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/configuration_items":{"get":{"operationId":"getConfigurationItems","description":"List of configuration items","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of configuration items","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}}},"example":[{"configuration_item":{"id":"10000","number":"1000","name":"Configuration Item Name","description":"description","asset_tag":"ConfigurationItemTag","type":{"id":1,"name":"Building","description":"Configuration Item - Building","parent_id":1,"custom":false,"updated_at":"2025-01-01T00:00:00.000+01:00","icon_name":"BUILDING"},"type_id":1,"state":"Active","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"manager_id":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"user_id":{"group_id":"1","is_user":"true","id":"1","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"updated_at":"2025-01-01T00:00:00.000+01:00","created_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}]},"application/xml":{"schema":{"description":"List of configuration items","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createConfigurationItem","description":"Create new configurationitem","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Configuration Item fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","required":["name"],"properties":{"type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"asset_tag":{"type":"string","example":"Configuration Item Tag"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Active"},"manager":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"problem_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"purchase_order_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"release_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}},"example":{"configuration_item":{"name":"Configuration Item Name","description":"Description","type":{"name":"Building"},"type_id":1,"asset_tag":"ConfigurationItemTag","site_id":1,"department_id":1,"state":"Active","manager":{"email":"john.doe@email.com"},"user":{"email":"jane.doe@email.com"},"add_to_tag_list":"tag1, tag2","remove_from_tag_list":"tag3","tag_list":"tag1, tag2","custom_fields_values_attributes":[{"id":"1","custom_field_id":1,"value":"content"}],"incident_ids":[100],"problem_ids":[100],"itsm_change_ids":[100],"release_ids":[100],"purchase_order_ids":[100],"configuration_item_ids":[100]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"configuration_item":{"type":"object","required":["name"],"properties":{"type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"asset_tag":{"type":"string","example":"Configuration Item Tag"},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"state":{"type":"string","example":"Active"},"manager":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"add_to_tag_list":{"type":"string","example":"tag1, tag2"},"remove_from_tag_list":{"type":"string","example":"tag3"},"tag_list":{"type":"string","example":"tag1, tag2"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"incident_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"itsm_change_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"problem_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"purchase_order_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"release_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"configuration_item_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}},"example":{"configuration_item":{"id":"10000","number":"1000","name":"Configuration Item Name","description":"description","asset_tag":"ConfigurationItemTag","type":{"id":1,"name":"Building","description":"Configuration Item - Building","parent_id":1,"custom":false,"updated_at":"2025-01-01T00:00:00.000+01:00","icon_name":"BUILDING"},"type_id":1,"state":"Active","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"manager_id":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"user_id":{"group_id":"1","is_user":"true","id":"1","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"JD"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"updated_at":"2025-01-01T00:00:00.000+01:00","created_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/100"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/100"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/100"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/100"}],"purchase_orders":[{"id":"100","href":"https://mydomain.com/releases/100"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/100"}]}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"configuration_item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"CI Name"},"description":{"type":"string","example":"description"},"type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Building"},"description":{"type":"string","example":"Configuration Item - Building"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom":{"type":"boolean","example":false},"icon_name":{"type":"string","example":"BUILDING"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}},"type_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"state":{"type":"string","example":"Active"},"manager_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"user_id":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"purchase_orders":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"configuration_items":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"href":{"type":"string","example":"https://mydomain.com/object_type/1"}}}},"origin":{"type":"string","example":"api"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/configuration_items/{id}/append_multiple_dependent_assets":{"put":{"operationId":"appendDependentAssets","description":"Append multiple dependent assets","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"description":"Dependencies fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"additionalProperties":{"type":"object","properties":{"selected_ids":{"type":"object","properties":{"configuration_items":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"mobiles":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"hardwares":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"discovery_hardwares":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"other_assets":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"example":{"Child Of":{"selected_ids":{"configuration_items":[1]}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"additionalProperties":{"type":"object","properties":{"selected_ids":{"type":"object","properties":{"configuration_items":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"mobiles":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"hardwares":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"discovery_hardwares":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}},"other_assets":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"example":{"Child Of":{"selected_ids":{"configuration_items":[1]}}}}}}},"responses":{"200":{"description":"Dependency added successfully"},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/asset_links/delete_asset_link_by_id":{"put":{"operationId":"deleteAssetLink","description":"Delete dpendency by id","tags":["Configuration Item"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"description":"Dependencies fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"assetLinkId":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"The id of the dependency between the assets"},"sourceId":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"The id of the configuration item"},"sourceType":{"type":"string","example":"ConfigurationItem"}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"assetLinkId":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"The id of the dependency between the assets"},"sourceId":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"The id of the configuration item"},"sourceType":{"type":"string","example":"ConfigurationItem"}}}}}},"responses":{"200":{"description":"Dependency removed successfully"},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/users/{id}":{"get":{"operationId":"getUserById","description":"Get user","tags":["User"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":{"user":{"id":"10000","name":"John Doe","title":"Support Agent","disabled":false,"email":"john.doe@email.com","created_at":"2030-01-01T00:00:00.000+00:00","phone":"+10000000","mobile_phone":"+10000000","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"role":{"id":1,"name":"Requester","description":"Requester role.","portal":true,"show_my_tasks":true},"group_ids":[1],"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{"group_id":"1","is_user":"true","id":"100","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JD"}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateUserById","description":"Update user with specified fields","tags":["User"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"User fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"disabled":{"type":"boolean","example":false},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}}}}}},"example":{"user":{"name":"John Doe","email":"john.doe@email.com","title":"Support Agent","site":{"name":"AUS"},"department":{"name":"Support"},"role":{"name":"Requester"},"phone":"+10000000","mobile_phone":"+10000000","reports_to":{"email":"jane.doe@email.com"},"custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"user":{"type":"object","properties":{"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"disabled":{"type":"boolean","example":false},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":{"user":{"id":"10000","name":"John Doe","title":"Support Agent","disabled":false,"email":"john.doe@email.com","created_at":"2030-01-01T00:00:00.000+00:00","phone":"+10000000","mobile_phone":"+10000000","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"role":{"id":1,"name":"Requester","description":"Requester role.","portal":true,"show_my_tasks":true},"group_ids":[1],"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{"group_id":"1","is_user":"true","id":"100","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JD"}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteUserById","description":"Delete user","tags":["User"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted user"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/users":{"get":{"operationId":"getUsers","description":"List of Users","tags":["User"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of users","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}]}},"example":[{"user":{"id":"10000","name":"John Doe","title":"Support Agent","disabled":false,"email":"john.doe@email.com","created_at":"2030-01-01T00:00:00.000+00:00","phone":"+10000000","mobile_phone":"+10000000","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"role":{"id":1,"name":"Requester","description":"Requester role.","portal":true,"show_my_tasks":true},"group_ids":[1],"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{"group_id":"1","is_user":"true","id":"100","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JD"}}}}]},"application/xml":{"schema":{"description":"List of users","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createUser","description":"Create new user","tags":["User"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"User fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"user":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"disabled":{"type":"boolean","example":false},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}}}}}},"example":{"user":{"name":"John Doe","email":"john.doe@email.com","title":"Support Agent","site":{"name":"AUS"},"department":{"name":"Support"},"role":{"name":"Requester"},"phone":"+10000000","mobile_phone":"+10000000","reports_to":{"email":"jane.doe@email.com"},"custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"user":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"disabled":{"type":"boolean","example":false},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"reports_to":{"oneOf":[{"type":"object","required":["id"],"properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}},"example":{"user":{"id":"10000","name":"John Doe","title":"Support Agent","disabled":false,"email":"john.doe@email.com","created_at":"2030-01-01T00:00:00.000+00:00","phone":"+10000000","mobile_phone":"+10000000","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"role":{"id":1,"name":"Requester","description":"Requester role.","portal":true,"show_my_tasks":true},"group_ids":[1],"avatar":{"type":"initials","color":"#fd4165","initials":"JD"},"reports_to":{"group_id":"1","is_user":"true","id":"100","name":"Jane Doe","email":"jane.doe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JD"}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"title":{"type":"string","example":"Support Agent"},"email":{"type":"string","format":"email","example":"john.doe@email.com"},"phone":{"type":"string","example":"+10000000"},"mobile_phone":{"type":"string","example":"+10000000"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Requester"},"description":{"type":"string","example":"Requester role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":true}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"group_ids":{"type":"array","items":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"xml":{"wrapped":true},"description":"for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+00:00"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/sites/{id}":{"get":{"operationId":"getSiteById","description":"Get site","tags":["Site"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateSiteById","description":"Update site with specified fields","tags":["Site"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Site fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"site":{"type":"object","properties":{"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"manager_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"user only, not group"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"business_record":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"site":{"type":"object","properties":{"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"manager_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"user only, not group"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"business_record":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteSiteById","description":"Delete site","tags":["Site"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted site"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/sites":{"get":{"operationId":"getSites","description":"List of Sites","tags":["Site"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of sites","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}]}}},"application/xml":{"schema":{"description":"List of sites","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createSite","description":"Create new site","tags":["Site"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Site fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"site":{"type":"object","required":["name","location"],"properties":{"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"manager_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"user only, not group"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"business_record":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"site":{"type":"object","required":["name","location"],"properties":{"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"manager_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}],"description":"user only, not group"},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"business_record":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"site":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"location":{"type":"string","example":"AUS"},"description":{"type":"string","example":"Description Austin TX, USA"},"time_zone":{"type":"string","example":"Texas"},"language":{"type":"string","minLength":2,"maxLength":2,"example":"en"},"business_record":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/departments/{id}":{"get":{"operationId":"getDepartmentById","description":"Get department","tags":["Department"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateDepartmentById","description":"Update department with specified fields","tags":["Department"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Department fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","properties":{"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","properties":{"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteDepartmentById","description":"Delete department","tags":["Department"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted department"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/departments":{"get":{"operationId":"getDepartments","description":"List of Departments","tags":["Department"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of departments","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}]}}},"application/xml":{"schema":{"description":"List of departments","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createDepartment","description":"Create new department","tags":["Department"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Department fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"department":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"department":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/roles/{id}":{"get":{"operationId":"getRoleById","description":"Get role","tags":["Role"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateRoleById","description":"Update role with specified fields","tags":["Role"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Role fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"role":{"type":"object","properties":{"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteRoleById","description":"Delete role","tags":["Role"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted role"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/roles":{"get":{"operationId":"getRoles","description":"List of roles","tags":["Role"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of roles","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}]}}},"application/xml":{"schema":{"description":"List of role","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createRole","description":"Create new role","tags":["Role"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Role fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"role":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"role":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"role":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support Agent"},"description":{"type":"string","example":"Support Agent role"},"portal":{"type":"boolean","example":true},"show_my_tasks":{"type":"boolean","example":false}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/groups/{id}":{"get":{"operationId":"getGroupById","description":"Get group","tags":["Group"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateGroupById","description":"Update group with specified fields","tags":["Group"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Group fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"superviser_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"group":{"type":"object","properties":{"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"superviser_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteGroupById","description":"Delete group","tags":["Group"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted group"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/groups":{"get":{"operationId":"getGroups","description":"List of groups","tags":["Group"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of groups","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}]}}},"application/xml":{"schema":{"description":"List of groups","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createGroup","description":"Create new group","tags":["Group"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Group fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"group":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"superviser_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"group":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"superviser_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"group":{"type":"object","required":["name"],"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Group Name"},"description":{"type":"string","example":"Group Description"},"is_user":{"type":"boolean","example":false},"reports_to":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}},"send_notifications":{"type":"boolean","example":true},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"string","example":"John Doe"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/categories/{id}":{"get":{"operationId":"getCategoryById","description":"Get category","tags":["Category"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateCategoryById","description":"Update category with specified fields","tags":["Category"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Category fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"category":{"type":"object","properties":{"name":{"type":"string","example":"Equipment"},"parent":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Facilities"}},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"category":{"type":"object","properties":{"name":{"type":"string","example":"Equipment"},"parent":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Facilities"}},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteCategoryById","description":"Delete category","tags":["Category"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted category"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/categories":{"get":{"operationId":"getCategories","description":"List of categories","tags":["Category"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of categories","type":"array","items":{"allOf":[{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}]}}},"application/xml":{"schema":{"description":"List of categories","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createCategory","description":"Create new category","tags":["Category"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Category fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"category":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Equipment"},"parent":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Facilities"}},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"category":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Equipment"},"parent":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Facilities"}},"default_assignee_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Equipment"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"default_tags":{"type":"string","example":"equipment"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/hardwares/{id}":{"get":{"operationId":"getHardwareById","description":"Get hardware","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}},"example":{"hardware":{"id":1,"name":"Hardware Name","description":"description","category":{"id":1,"name":"Laptop"},"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"ip":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bioses":[{"id":1,"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00","reported_at":"2020-01-01 00:00"}],"tag":"tag","asset_tag":"1"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateHardwareById","description":"Update hardware with specified fields","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Hardware fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"hardware":{"type":"object","properties":{"name":{"type":"string","example":"Hardware Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"ip_address":{"type":"string","example":"0.0.0.0"},"external_ip":{"type":"string","example":"0.0.0.0"},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"memory":{"anyOf":[{"type":"string","example":"1024"},{"type":"integer","example":1024}]},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"bio":{"type":"object","properties":{"manufacturer":{"type":"string","example":"Dell"},"ssn":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"model":{"type":"string","example":"model description"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"bios_date":{"type":"string","example":"2020-01-01 00:00"}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":{"hardware":{"name":"Hardware Name","description":"description","category":{"name":"Laptop"},"site_id":1,"department_id":1,"ip_address":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bio":{"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00"},"tag":"tag","asset_tag":1}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"hardware":{"type":"object","properties":{"name":{"type":"string","example":"Hardware Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"ip_address":{"type":"string","example":"0.0.0.0"},"external_ip":{"type":"string","example":"0.0.0.0"},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"memory":{"anyOf":[{"type":"string","example":"1024"},{"type":"integer","example":1024}]},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"bio":{"type":"object","properties":{"manufacturer":{"type":"string","example":"Dell"},"ssn":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"model":{"type":"string","example":"model description"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"bios_date":{"type":"string","example":"2020-01-01 00:00"}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}},"example":{"hardware":{"id":1,"name":"Hardware Name","description":"description","category":{"id":1,"name":"Laptop"},"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"ip":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bioses":[{"id":1,"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00","reported_at":"2020-01-01 00:00"}],"tag":"tag","asset_tag":"1"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteHardwareById","description":"Delete hardware","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted hardware's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/hardwares":{"get":{"operationId":"getHardwares","description":"List of hardwares","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of hardwares","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}}},"example":[{"hardware":{"id":1,"name":"Hardware Name","description":"description","category":{"id":1,"name":"Laptop"},"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"ip":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bioses":[{"id":1,"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00","reported_at":"2020-01-01 00:00"}],"tag":"tag","asset_tag":"1"}}]},"application/xml":{"schema":{"description":"List of hardwares","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createHardware","description":"Create new hardware","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Hardware fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"hardware":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Hardware Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"ip_address":{"type":"string","example":"0.0.0.0"},"external_ip":{"type":"string","example":"0.0.0.0"},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"memory":{"anyOf":[{"type":"string","example":"1024"},{"type":"integer","example":1024}]},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"bio":{"type":"object","properties":{"manufacturer":{"type":"string","example":"Dell"},"ssn":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"model":{"type":"string","example":"model description"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"bios_date":{"type":"string","example":"2020-01-01 00:00"}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}},"example":{"hardware":{"name":"Hardware Name","description":"description","category":{"name":"Laptop"},"site_id":1,"department_id":1,"ip_address":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bio":{"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00"},"tag":"tag","asset_tag":1}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"hardware":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Hardware Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"ip_address":{"type":"string","example":"0.0.0.0"},"external_ip":{"type":"string","example":"0.0.0.0"},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"memory":{"anyOf":[{"type":"string","example":"1024"},{"type":"integer","example":1024}]},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"bio":{"type":"object","properties":{"manufacturer":{"type":"string","example":"Dell"},"ssn":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"model":{"type":"string","example":"model description"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"bios_date":{"type":"string","example":"2020-01-01 00:00"}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}},"example":{"hardware":{"id":1,"name":"Hardware Name","description":"description","category":{"id":1,"name":"Laptop"},"site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"ip":"0.0.0.0","external_ip":"0.0.0.0","status":{"name":"Operational"},"technical_contact":{"email":"john.doe@email.com"},"owner":{"email":"john.doe@email.com"},"notes":"Hardware notes","barcode_encoding_format":"Code1A","cpu":"hardware_cpu","processor_speed":"processor_speed","memory":1024,"swap":"MB","operating_system":"Windows 10","domain":"domain description","active_directory":"Workgroup of the OS","address":"Site 1, Building 1, Department 1","longitude":"0.000","latitude":"0.000","product_number":"1","custom_fields_values":{"custom_fields_value":[{"name":"Name of custom text field","value":"content"}]},"bioses":[{"id":1,"manufacturer":"Dell","ssn":"1","model":"model description","version":"1","bios_date":"2020-01-01 00:00","reported_at":"2020-01-01 00:00"}],"tag":"tag","asset_tag":"1"}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"hardware":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Hardware Name"},"ip":{"type":"string","example":"0.0.0.0"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Laptop"}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"notes":{"type":"string","example":"Hardware notes"},"barcode_encoding_format":{"type":"string","example":"Code1A"},"cpu":{"type":"string","example":"hardware_cpu"},"processor_speed":{"type":"string","example":"processor_speed"},"memory":{"type":"string","example":"1024"},"swap":{"type":"string","example":"MB"},"domain":{"type":"string","example":"domain description"},"operating_system":{"type":"string","example":"Windows 10"},"active_directory":{"type":"string","example":"Workgroup of the OS"},"address":{"type":"string","example":"Site 1, Building 1, Department 1"},"longitude":{"type":"string","example":"0.000"},"latitude":{"type":"string","example":"0.000"},"product_number":{"type":"integer","example":1},"bio":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"manufacturer":{"type":"string","example":"Dell"},"ssn":{"type":"string","example":"1"},"model":{"type":"string","example":"model description"},"version":{"type":"string","example":"1"},"bios_date":{"type":"string","example":"2020-01-01 00:00"},"reported_at":{"type":"string","example":"2020-01-01 00:00"}}}},"tag":{"type":"string","example":"hardware tag"},"asset_tag":{"type":"string","example":"1"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/mobiles/{id}":{"get":{"operationId":"getMobileById","description":"Get mobile device","tags":["Mobile Device"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateMobileById","description":"Update mobile device with specified fields","tags":["Mobile Device"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Mobile device fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"mobile":{"type":"object","properties":{"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"mobile":{"type":"object","properties":{"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteMobileById","description":"Delete mobile device","tags":["Mobile Device"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted mobile's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/mobiles":{"get":{"operationId":"getMobiles","description":"List of mobile devices","tags":["Mobile Device"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of mobile devices","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}},"application/xml":{"schema":{"description":"List of mobile devices","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createMobile","description":"Create new mobile device","tags":["Mobile Device"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Mobile Device fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"mobile":{"type":"object","required":["model","manufacturer","serial_number"],"properties":{"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"mobile":{"type":"object","required":["model","manufacturer","serial_number"],"properties":{"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"mobile":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"device_type":{"type":"string","example":"Mobile Device"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"company_issued":{"type":"boolean","example":true},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"imei":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/other_assets/{id}":{"get":{"operationId":"getAssetById","description":"Get other asset","tags":["Other Asset"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateAssetById","description":"Update other asset with specified fields","tags":["Other Asset"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Other asset fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"other_asset":{"type":"object","properties":{"name":{"type":"string","example":"Asset Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip_address":{"type":"string","example":"0.0.0.0"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"other_asset":{"type":"object","properties":{"name":{"type":"string","example":"Asset Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip_address":{"type":"string","example":"0.0.0.0"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteAssetById","description":"Delete other asset","tags":["Other Asset"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted other_asset's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/other_assets":{"get":{"operationId":"getAssets","description":"List of other assets","tags":["Other Asset"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of other assets","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}},"application/xml":{"schema":{"description":"List of other asset","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createAsset","description":"Create new asset","tags":["Other Asset"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Other Asset fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"other_asset":{"type":"object","required":["name","manufacturer","asset_type"],"properties":{"name":{"type":"string","example":"Asset Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip_address":{"type":"string","example":"0.0.0.0"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"other_asset":{"type":"object","required":["name","manufacturer","asset_type"],"properties":{"name":{"type":"string","example":"Asset Name"},"description":{"type":"string","example":"description"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"asset_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Printer"}},"status":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"Operational"}},"manufacturer":{"type":"string","example":"Apple"},"ip_address":{"type":"string","example":"0.0.0.0"},"model":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"owner":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"other_asset":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Apple 1"},"description":{"type":"string","example":"description"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"status":{"type":"string","example":"Operational"},"asset_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"parent_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Asset Type"}}},"asset_id":{"type":"string","example":"1"},"manufacturer":{"type":"string","example":"Apple"},"model":{"type":"string","example":"1"},"ip":{"type":"string","example":"0.0.0.0"},"serial_number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"owner":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/softwares/{id}":{"get":{"operationId":"getSoftwareById","description":"Get software","tags":["Software"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"software":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google Chrome"},"tag":{"type":"string","example":"software tag"},"manufacturer":{"type":"string","example":"Google LLC"},"version":{"type":"string","example":"0.0.0"},"category":{"type":"string","example":"Google softwares"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}},"installs":{"type":"integer","example":1},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"software":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google Chrome"},"tag":{"type":"string","example":"software tag"},"manufacturer":{"type":"string","example":"Google LLC"},"version":{"type":"string","example":"0.0.0"},"category":{"type":"string","example":"Google softwares"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}},"installs":{"type":"integer","example":1},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/softwares":{"get":{"operationId":"getSoftwares","description":"List of softwares","tags":["Software"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of softwares","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"software":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google Chrome"},"tag":{"type":"string","example":"software tag"},"manufacturer":{"type":"string","example":"Google LLC"},"version":{"type":"string","example":"0.0.0"},"category":{"type":"string","example":"Google softwares"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}},"installs":{"type":"integer","example":1},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}},"application/xml":{"schema":{"description":"List of softwares","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"software":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google Chrome"},"tag":{"type":"string","example":"software tag"},"manufacturer":{"type":"string","example":"Google LLC"},"version":{"type":"string","example":"0.0.0"},"category":{"type":"string","example":"Google softwares"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}},"installs":{"type":"integer","example":1},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/printers/{id}":{"get":{"operationId":"getPrinterById","description":"Get printer","tags":["Printer"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updatePrinterById","description":"Update printer with specified fields","tags":["Printer"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Printer fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"printer":{"type":"object","properties":{"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"address":{"type":"string","example":"address description","description":"Building/Floor/Room"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"printer":{"type":"object","properties":{"site_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"department_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"technical_contact":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"address":{"type":"string","example":"address description","description":"Building/Floor/Room"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/printers":{"get":{"operationId":"getPrinters","description":"List of printers","tags":["Printer"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of printers","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}},"application/xml":{"schema":{"description":"List of printers","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"printer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"HP Color Printer"},"driver":{"type":"string","example":"Driver description"},"port":{"type":"string","example":"Port description"},"shared":{"type":"boolean","example":true},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"technical_contact":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/contracts/{id}":{"get":{"operationId":"getContractById","description":"Get contract","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateContractById","description":"Update contract with specified fields","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Contract fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"contract":{"type":"object","properties":{"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"name":{"type":"string","example":"Contract Name"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"contract":{"type":"object","properties":{"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"name":{"type":"string","example":"Contract Name"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteContractById","description":"Delete contract","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted contract's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/contracts":{"get":{"operationId":"getContracts","description":"List of contracts","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of contracts","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}},"application/xml":{"schema":{"description":"List of contracts","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createContract","description":"Create new contract","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Contract fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"contract":{"type":"object","required":["name","manufacturer_name"],"properties":{"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"name":{"type":"string","example":"Contract Name"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"contract":{"type":"object","required":["name","manufacturer_name"],"properties":{"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"name":{"type":"string","example":"Contract Name"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tag_list":{"type":"string","example":"tag1, tag2"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"contract":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Contract Name"},"type":{"type":"string","example":"Software License"},"manufacturer_name":{"type":"string","example":"Apple"},"note":{"type":"string","example":"Contract Note"},"status":{"type":"string","example":"Active"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"start_date":{"type":"string","example":"2020-01-01T00:00:00-00:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00-00:00"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"tag name"},"taggings_count":{"type":"integer","example":1}}}},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/purchase_orders/{id}":{"get":{"operationId":"getPurchaseOrderById","description":"Get purchase order","tags":["Purchase Order"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updatePurchaseOrderById","description":"Update purchase order with specified fields","tags":["Purchase Order"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Purchase Order fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase_order":{"type":"object","properties":{"name":{"type":"string","example":"Purchase order Name"},"buyer_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase_order":{"type":"object","properties":{"name":{"type":"string","example":"Purchase order Name"},"buyer_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deletePurchaseOrderById","description":"Delete purchase order","tags":["Purchase Order"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted purchase order's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/purchase_orders":{"get":{"operationId":"getCPurchaseOrders","description":"List of purchase orders","tags":["Purchase Order"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of purchase orders","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}},"application/xml":{"schema":{"description":"List of purchase orders","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createPurchaseOrder","description":"Create new purchase order","tags":["Purchase Order"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Purchase order fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase_order":{"type":"object","required":["name","vendor"],"properties":{"name":{"type":"string","example":"Purchase order Name"},"buyer_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase_order":{"type":"object","required":["name","vendor"],"properties":{"name":{"type":"string","example":"Purchase order Name"},"buyer_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"order_date":{"type":"string","example":"Jan 01, 2025"},"due_date":{"type":"string","example":"Jan 01, 2030"},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"anyOf":[{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}},{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Name of custom text field"},"value":{"type":"string","example":"content"},"user_value":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]}}}]}}},"custom_fields_values_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"type":"string","example":"1"},"custom_field_id":{"type":"integer","example":1},"value":{"type":"string","example":"content"}}}}]},"approval_levels_attributes":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}},{"type":"object","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"approver_ids":{"type":"string","example":"1, 2"},"approval_condition":{"type":"string","example":"1"}}}}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase_order":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Purchase order Name"},"order_date":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"due_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"buyer":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"state":{"type":"string","example":"Approved"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}},"example":{"id":"1","name":"John Doe","href":"/users/1"}},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Object Name"},"href":{"type":"string","example":"/objects/1"}}},"billing_address":{"type":"string","example":"Billing address"},"shiping_address":{"type":"string","example":"Shiping address"},"payment_terms":{"type":"string","example":"Purchase terms"},"terms_conditions":{"type":"string","example":"Terms conditions"},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":" Name of custom text field"},"value":{"type":"string","example":"content"},"type_name":{"type":"string","example":"Text"}}}},"purchase_order_items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"0.0.0"},"quantity":{"type":"string","example":"1"},"notes":{"type":"string","example":"Item notes"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"},"tag":{"type":"string","example":"example tag"}}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/vendors/{id}":{"get":{"operationId":"getVendorById","description":"Get vendor","tags":["Vendor"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateVendorById","description":"Update vendor with specified fields","tags":["Vendor"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Vendor fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"vendor":{"type":"object","properties":{"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"General Business Vendor"}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"vendor":{"type":"object","properties":{"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"General Business Vendor"}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteVendorById","description":"Delete vendor","tags":["Vendor"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Returns the deleted vendor's id","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/vendors":{"get":{"operationId":"getVendors","description":"List of vendors","tags":["Vendor"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of vendors","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}},"application/xml":{"schema":{"description":"List of vendors","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createVendor","description":"Create new vendor","tags":["Vendor"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Vendor fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"vendor":{"type":"object","required":["name","vendor_type"],"properties":{"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"General Business Vendor"}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"vendor":{"type":"object","required":["name","vendor_type"],"properties":{"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}],"example":{"name":"General Business Vendor"}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"SolarWinds"},"vendor_type":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"General Business Vendor"}}},"url":{"type":"string","example":"www.solarwinds.com"},"contact_name":{"type":"string","example":"Support"},"contact_email":{"type":"string","example":"support@solarwinds.com"},"contact_phone":{"type":"string","example":"+000000000"},"note":{"type":"string","example":"Notes"},"address":{"type":"string","example":"Address description"},"city":{"type":"string","example":"Cary"},"state":{"type":"string","example":"NC"},"zip":{"type":"string","example":"USA 11111"},"telephone":{"type":"string","example":"+000000000"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/contracts/{id}/items":{"post":{"operationId":"createItem","description":"Create new contract's Item","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Item fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"item":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Item Name"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"qty":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tag":{"type":"string","example":"Item tag"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"item":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Item Name"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"qty":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tag":{"type":"string","example":"Item tag"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"1"},"qty":{"type":"string","example":"1"},"tag":{"type":"string","example":"Item tag"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"1"},"qty":{"type":"string","example":"1"},"tag":{"type":"string","example":"Item tag"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/contracts/{contract_id}/items/{item_id}":{"put":{"operationId":"updateItemById","description":"Update contract's item with specified fields","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"contract_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the contract"},{"name":"item_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the item"}],"requestBody":{"required":true,"description":"Contract's Item fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"item":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"qty":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tag":{"type":"string","example":"Item tag"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"item":{"type":"object","properties":{"name":{"type":"string","example":"Item Name"},"version":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"qty":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"tag":{"type":"string","example":"Item tag"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"1"},"qty":{"type":"string","example":"1"},"tag":{"type":"string","example":"Item tag"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"item":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Item Name"},"version":{"type":"string","example":"1"},"qty":{"type":"string","example":"1"},"tag":{"type":"string","example":"Item tag"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteitemById","description":"Delete contract's item","tags":["Contract"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"contract_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the contract"},{"name":"item_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the item"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted item"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/{object_type}/{id}/tasks":{"post":{"operationId":"createTask","description":"Create new Task","tags":["Task"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"}],"requestBody":{"required":true,"description":"Task fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"task":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Task Name"},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01, 2030"},"is_complete":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"task":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Task Name"},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01, 2030"},"is_complete":{"type":"boolean","example":false}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"task":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Task Name"},"due_at":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"task":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Task Name"},"due_at":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/{object_type}/{id}/tasks/{task_id}":{"put":{"operationId":"updateTaskById","description":"Update task with specified fields","tags":["Task"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"task_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the task"}],"requestBody":{"required":true,"description":"Task fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"task":{"type":"object","properties":{"name":{"type":"string","example":"Task Name"},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01, 2030"},"is_complete":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"task":{"type":"object","properties":{"name":{"type":"string","example":"Task Name"},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email","example":"john.doe@email.com"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string","example":"Jan 01, 2030"},"is_complete":{"type":"boolean","example":false}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"task":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Task Name"},"due_at":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"task":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Task Name"},"due_at":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"requester":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"assignee":{"type":"object","properties":{"group_id":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"is_user":{"oneOf":[{"type":"string","example":"true"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"john.doe@email.com"},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteTaskById","description":"Delete task","tags":["Task"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"task_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the task"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted task"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/{object_type}/{id}/comments":{"post":{"operationId":"createComment","description":"Create new Comment","tags":["Comment"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"}],"requestBody":{"required":true,"description":"Comment fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"comment":{"type":"object","required":["body"],"properties":{"body":{"type":"string","example":"Comment body"},"is_private":{"anyOf":[{"type":"string","example":"true"},{"type":"boolean","example":true}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"comment":{"type":"object","required":["body"],"properties":{"body":{"type":"string","example":"Comment body"},"is_private":{"anyOf":[{"type":"string","example":"true"},{"type":"boolean","example":true}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"comment":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"body":{"type":"string","example":"Comment body"},"is_private":{"type":"string","example":"true"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"commenter_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"commenter_type":{"type":"string","example":"Incident"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"comment":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"body":{"type":"string","example":"Comment body"},"is_private":{"type":"string","example":"true"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"commenter_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"commenter_type":{"type":"string","example":"Incident"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/{object_type}/{id}/comments/{comment_id}":{"put":{"operationId":"updateCommentById","description":"Update comment with specified fields","tags":["Comment"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"comment_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the comment"}],"requestBody":{"required":true,"description":"Comment fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"comment":{"type":"object","properties":{"body":{"type":"string","example":"Comment body"},"is_private":{"anyOf":[{"type":"string","example":"true"},{"type":"boolean","example":true}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"comment":{"type":"object","properties":{"body":{"type":"string","example":"Comment body"},"is_private":{"anyOf":[{"type":"string","example":"true"},{"type":"boolean","example":true}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"comment":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"body":{"type":"string","example":"Comment body"},"is_private":{"type":"string","example":"true"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"commenter_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"commenter_type":{"type":"string","example":"Incident"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"comment":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"body":{"type":"string","example":"Comment body"},"is_private":{"type":"string","example":"true"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"commenter_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"commenter_type":{"type":"string","example":"Incident"}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteCommentById","description":"Delete comment","tags":["Comment"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"comment_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the comment"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted comment"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/hardwares/{id}/warranties":{"get":{"operationId":"getWarranties","description":"List of warranties","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of warranties","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}}},"application/xml":{"schema":{"description":"List of warranties","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createWarranty","description":"Create new Warranty","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Warranty fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"warranty":{"type":"object","properties":{"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"Jan 01, 2020"},"end_date":{"type":"string","example":"Jan 01, 2030"},"status":{"type":"string","example":"Active"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"warranty":{"type":"object","properties":{"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"Jan 01, 2020"},"end_date":{"type":"string","example":"Jan 01, 2030"},"status":{"type":"string","example":"Active"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/hardwares/{hardware_id}/warranties/{warranty_id}":{"put":{"operationId":"updateWarrantyById","description":"Update warranty with specified fields","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"hardware_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the hardware"},{"name":"warranty_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the warranty"}],"requestBody":{"required":true,"description":"Warranty fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"warranty":{"type":"object","properties":{"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"Jan 01, 2020"},"end_date":{"type":"string","example":"Jan 01, 2030"},"status":{"type":"string","example":"Active"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"warranty":{"type":"object","properties":{"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"Jan 01, 2020"},"end_date":{"type":"string","example":"Jan 01, 2030"},"status":{"type":"string","example":"Active"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"warranty":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"service":{"type":"string","example":"Warranty service description"},"provider":{"type":"string","example":"SolarWinds"},"start_date":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"end_date":{"type":"string","example":"2030-01-01T00:00:00.000+01:00"},"status":{"type":"string","example":"Active"},"manual":{"type":"boolean","example":false}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteWarrantyById","description":"Delete warranty","tags":["Hardware"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"hardware_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the hardware"},{"name":"warranty_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the warranty"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted warranty"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/{object_type}/{id}/time_tracks":{"get":{"operationId":"getTimeTracks","description":"List of time tracks","tags":["Time Track"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of time tracks","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}},"application/xml":{"schema":{"description":"List of time tracks","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createTimeTrack","description":"Create new time track","tags":["Time Track"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"}],"requestBody":{"required":true,"description":"Time track fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"time_track":{"type":"object","properties":{"name":{"type":"string","example":"Time Track Name"},"minutes_parsed":{"type":"string","example":"2h"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"time_track":{"type":"object","properties":{"name":{"type":"string","example":"Time Track Name"},"minutes_parsed":{"type":"string","example":"2h"}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/{object_type}/{id}/time_tracks/{time_track_id}":{"put":{"operationId":"updateTimeTrackyById","description":"Update time track with specified fields","tags":["Time Track"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"time_track_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the time track"}],"requestBody":{"required":true,"description":"Time track fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"time_track":{"type":"object","properties":{"name":{"type":"string","example":"Time Track Name"},"minutes_parsed":{"type":"string","example":"2h"}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"time_track":{"type":"object","properties":{"name":{"type":"string","example":"Time Track Name"},"minutes_parsed":{"type":"string","example":"2h"}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"time_track":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Time Track Name"},"minutes":{"type":"string","example":"120"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"creator":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"parent":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"class":{"type":"string","example":"Incident"}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteTimeTrackyById","description":"Delete time track","tags":["Time Track"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"},{"name":"time_track_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the time track"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted time track"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/{object_type}/{id}/purchases":{"post":{"operationId":"createPurchase","description":"Create new purchase","tags":["Purchase"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"contracts"}],"requestBody":{"required":true,"description":"Purchase fields to fill","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase":{"type":"object","required":["name"],"properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase":{"type":"object","required":["name"],"properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"string","example":"1"},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"string","example":"1"},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/{object_type}/{id}/purchases/{purchase_id}":{"put":{"operationId":"updatePurchaseById","description":"Update purchase with specified fields","tags":["Purchase"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"contracts / other_assets"},{"name":"purchase_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the purchase"}],"requestBody":{"required":true,"description":"Purchase fields to update","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/"},"properties":{"purchase":{"type":"object","properties":{"number":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"anyOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Object Name"}}},{"enum":["nil","",null]}]}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"string","example":"1"},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}},"application/xml":{"schema":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"purchase":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"number":{"type":"string","example":"1"},"date":{"type":"string","example":"Jan 01, 2025"},"recurrence":{"type":"string","example":"Monthly"},"total_cost":{"type":"string","example":"1"},"currency":{"type":"string","example":"USD"},"notes":{"type":"string","example":"Purchase notes"},"vendor":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Google"},"address":{"type":"string","example":"address description"},"country":{"type":"string","example":"US"},"city":{"type":"string","example":"Texas"},"zip":{"type":"string","example":"1"},"tech_support":{"type":"string","example":"+000000000","description":"support phone number"},"business_phone":{"type":"string","example":"+000000000","description":"business phone"},"url":{"type":"string","example":"www.google.com"},"created_at":{"type":"string","example":"2020-01-01T00:00:00.000+01:00"},"updated_at":{"type":"string","example":"2020-10-01T00:00:00.000+01:00"}}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deletePurchaseById","description":"Delete purchase","tags":["Purchase"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"contracts"},{"name":"purchase_id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the purchase"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted purchase"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/memberships":{"post":{"operationId":"createMembership","description":"Create new Membership. Memberships are used to relate a user to a group.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X POST https://api.samanage.com/memberships.xml?group_id=1&user_ids=1","tags":["Membership"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"group_id","in":"query","schema":{"type":"string"},"required":true,"description":"Numeric ID of the group"},{"name":"user_ids","in":"query","schema":{"type":"string"},"required":true,"description":"Numeric IDs of the users"}],"responses":{"200":{"description":"membership created and returned correctly"},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/memberships/{id}":{"delete":{"operationId":"deleteMemebershipById","description":"Delete membership.\nExample: curl -H \"X-Samanage-Authorization: Bearer TOKEN\" -H 'Accept: application/xml' -H 'Content-Type:text/xml' -X DELETE https://api.samanage.com/memberships/1.xml","tags":["Membership"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Message regarding a successful operation","content":{"application/json":{"example":{"messages":{"message":"Deleted membership"}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/audits":{"get":{"operationId":"getAudits","description":"List of audits","tags":["Audit"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of audits","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"audit":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"message":{"type":"string","example":"State changed from New to On Hold"},"action":{"type":"string","example":"Update"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"source_type":{"type":"string","example":"Incident"},"source_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}}},"application/xml":{"schema":{"description":"List of audits","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"audit":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"message":{"type":"string","example":"State changed from New to On Hold"},"action":{"type":"string","example":"Update"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"source_type":{"type":"string","example":"Incident"},"source_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}}},"/{object_type}/{id}/audits":{"get":{"operationId":"getAuditById","description":"Get audits of a specific object. Example: curl -X GET \"https://api.samanage.com/incidents/1/audits\" -H \"accept: application/json\" -H \"X-Samanage-Authorization: Bearer TOKEN\"","tags":["Audit"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"},{"name":"object_type","in":"path","schema":{"type":"string"},"required":true,"description":"Source object type","example":"incidents"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of audits of a specific object","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"audit":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"message":{"type":"string","example":"State changed from New to On Hold"},"action":{"type":"string","example":"Update"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"source_type":{"type":"string","example":"Incident"},"source_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}}},"application/xml":{"schema":{"description":"List of audits of a specific object","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"audit":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"message":{"type":"string","example":"State changed from New to On Hold"},"action":{"type":"string","example":"Update"},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"source_type":{"type":"string","example":"Incident"},"source_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"email":{"type":"string","example":"john.doe@email.com"},"name":{"type":"string","example":"John Doe"},"disabled":{"type":"boolean","example":false},"avatar":{"type":"object","properties":{"type":{"type":"string","example":"initials"},"color":{"type":"string","example":"#1000"},"initials":{"type":"string","minLength":2,"maxLength":2,"example":"JD"}}}}},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Austin TX, USA"},"description":{"type":"string","example":"AUS"},"location":{"type":"string","example":"AUS"},"timezone":{"type":"string","example":"UTC-6h"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Support"},"description":{"type":"string","example":"Support Department"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]}}},"note":{"type":"string","example":"Audit note"}}}}}}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/risks":{"get":{"operationId":"getRisks","description":"List of risks","tags":["Risk"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of risks","type":"array","items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Risk name"},"severity":{"type":"string","example":"Medium"},"category":{"type":"string","example":"Inventory"},"discarded":{"type":"boolean","example":false},"resolved":{"type":"boolean","example":false},"affected_assets":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Computer name"},"type":{"type":"string","example":"Hardware"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}}}},"application/xml":{"schema":{"description":"List of risks","type":"array","xml":{"name":"/","wrapped":true},"items":{"type":"object","xml":{"name":"/","wrapped":true},"properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Risk name"},"severity":{"type":"string","example":"Medium"},"category":{"type":"string","example":"Inventory"},"discarded":{"type":"boolean","example":false},"resolved":{"type":"boolean","example":false},"affected_assets":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string","example":"1"},{"type":"integer","example":1}]},"name":{"type":"string","example":"Computer name"},"type":{"type":"string","example":"Hardware"}}},"created_at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"},"updated at":{"type":"string","example":"2025-01-01T00:00:00.000+01:00"}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}},"/attachments":{"post":{"operationId":"createAttachment","description":"Create a new attachment: <p>curl -H 'X-Samanage-Authorization: Bearer TOKEN' <br>-F 'file[attachable_type]=PARENT_OBJECT_TYPE' <br>-F 'file[attachable_id]=PARENT_OBJECT_ID' <br>-F 'file[attachment]=@/PATH/TO/FILE' <br>-H 'Accept: application/vnd.samanage.v1.3+xml' <br>-H 'Content-Type: multipart/form-data' <br>-X POST https://api.samanage.com/attachments.xml/json </p>","tags":["Attachment"],"responses":{"200":{"description":"File successfully attached"},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}}},"tags":[{"name":"Incident","description":"Incident operations"},{"name":"Problem","description":"Problem operations"},{"name":"Change","description":"Change operations"},{"name":"Change Catalog","description":"Change catalog operations"},{"name":"Release","description":"Release operations"},{"name":"Solution","description":"Solution operations"},{"name":"Catalog Item","description":"Catalog Item operations"},{"name":"Service Request","description":"Requesting a service"},{"name":"Configuration Item","description":"Configuration Item operations"},{"name":"User","description":"User operations"},{"name":"Site","description":"Site operations"},{"name":"Department","description":"Department operations"},{"name":"Role","description":"Role operations"},{"name":"Group","description":"Group operations"},{"name":"Membership","description":"Membership operations"},{"name":"Category","description":"Category operations"},{"name":"Hardware","description":"Hardware operations"},{"name":"Mobile Device","description":"Mobile device operations"},{"name":"Other Asset","description":"Other asset operations"},{"name":"Software","description":"Software operations"},{"name":"Printer","description":"Printer operations"},{"name":"Contract","description":"Contract operations"},{"name":"Purchase Order","description":"Purchase order operations"},{"name":"Vendor","description":"Vendor operations"},{"name":"Task","description":"Task operations"},{"name":"Comment","description":"Comment operations"},{"name":"Time Track","description":"Time Track operations"},{"name":"Purchase","description":"Purchase operations"},{"name":"Audit","description":"Audit operations"},{"name":"Risk","description":"Risk operations"},{"name":"Attachment","description":"Attachment operations"}]}
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: solarwinds-itsm-api-definitions
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.9
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonathan Goldstein
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2020-12-03 00:00:00.000000000 Z
13
+ date: 2021-02-28 00:00:00.000000000 Z
14
14
  dependencies: []
15
15
  description: SolarWinds ITSM OpenAPI definitions gem
16
16
  email:
@@ -21,11 +21,114 @@ extensions: []
21
21
  extra_rdoc_files: []
22
22
  files:
23
23
  - lib/definitions/common/components.json
24
+ - lib/definitions/common/examples/catalog_item.json
25
+ - lib/definitions/common/examples/change.json
26
+ - lib/definitions/common/examples/change_catalog.json
27
+ - lib/definitions/common/examples/configuration_item.json
28
+ - lib/definitions/common/examples/hardware.json
24
29
  - lib/definitions/common/examples/incident.json
25
- - lib/definitions/common/schemas/incident.json
30
+ - lib/definitions/common/examples/problem.json
31
+ - lib/definitions/common/examples/release.json
32
+ - lib/definitions/common/examples/service_request.json
33
+ - lib/definitions/common/examples/solution.json
34
+ - lib/definitions/common/examples/user.json
35
+ - lib/definitions/common/schemas/analytics/audit.json
36
+ - lib/definitions/common/schemas/analytics/risk.json
37
+ - lib/definitions/common/schemas/inventory/hardware.json
38
+ - lib/definitions/common/schemas/inventory/mobile.json
39
+ - lib/definitions/common/schemas/inventory/other_asset.json
40
+ - lib/definitions/common/schemas/inventory/printer.json
41
+ - lib/definitions/common/schemas/inventory/software.json
42
+ - lib/definitions/common/schemas/inventory/warranty.json
43
+ - lib/definitions/common/schemas/procurement/contract.json
44
+ - lib/definitions/common/schemas/procurement/item.json
45
+ - lib/definitions/common/schemas/procurement/purchase.json
46
+ - lib/definitions/common/schemas/procurement/purchase_order.json
47
+ - lib/definitions/common/schemas/procurement/vendor.json
48
+ - lib/definitions/common/schemas/service_desk/catalog_item.json
49
+ - lib/definitions/common/schemas/service_desk/change.json
50
+ - lib/definitions/common/schemas/service_desk/change_catalog.json
51
+ - lib/definitions/common/schemas/service_desk/comment.json
52
+ - lib/definitions/common/schemas/service_desk/configuration_item.json
53
+ - lib/definitions/common/schemas/service_desk/incident.json
54
+ - lib/definitions/common/schemas/service_desk/problem.json
55
+ - lib/definitions/common/schemas/service_desk/release.json
56
+ - lib/definitions/common/schemas/service_desk/service_request.json
57
+ - lib/definitions/common/schemas/service_desk/solution.json
58
+ - lib/definitions/common/schemas/service_desk/time_track.json
59
+ - lib/definitions/common/schemas/setup/category.json
60
+ - lib/definitions/common/schemas/setup/department.json
61
+ - lib/definitions/common/schemas/setup/group.json
62
+ - lib/definitions/common/schemas/setup/role.json
63
+ - lib/definitions/common/schemas/setup/site.json
64
+ - lib/definitions/common/schemas/setup/user.json
65
+ - lib/definitions/common/schemas/tasks/task.json
26
66
  - lib/definitions/openapi.json
67
+ - lib/definitions/paths/attachments/attachments.json
68
+ - lib/definitions/paths/audits/audits.json
69
+ - lib/definitions/paths/audits/audits_by_id.json
70
+ - lib/definitions/paths/catalog_items/catalog_item_by_id.json
71
+ - lib/definitions/paths/catalog_items/catalog_items.json
72
+ - lib/definitions/paths/categories/categories.json
73
+ - lib/definitions/paths/categories/category_by_id.json
74
+ - lib/definitions/paths/change_catalogs/change_catalog_by_id.json
75
+ - lib/definitions/paths/change_catalogs/change_catalogs.json
76
+ - lib/definitions/paths/changes/change_by_id.json
77
+ - lib/definitions/paths/changes/changes.json
78
+ - lib/definitions/paths/comments/comment_by_id.json
79
+ - lib/definitions/paths/comments/comments.json
80
+ - lib/definitions/paths/configuration_items/append_dependent_assets.json
81
+ - lib/definitions/paths/configuration_items/configuration_item_by_id.json
82
+ - lib/definitions/paths/configuration_items/configuration_items.json
83
+ - lib/definitions/paths/configuration_items/delete_asset_link.json
84
+ - lib/definitions/paths/contracts/contract_by_id.json
85
+ - lib/definitions/paths/contracts/contracts.json
86
+ - lib/definitions/paths/contracts/item_by_id.json
87
+ - lib/definitions/paths/contracts/items.json
88
+ - lib/definitions/paths/departments/department_by_id.json
89
+ - lib/definitions/paths/departments/departments.json
90
+ - lib/definitions/paths/groups/group_by_id.json
91
+ - lib/definitions/paths/groups/groups.json
92
+ - lib/definitions/paths/hardwares/hardware_by_id.json
93
+ - lib/definitions/paths/hardwares/hardwares.json
94
+ - lib/definitions/paths/hardwares/warranties.json
95
+ - lib/definitions/paths/hardwares/warranty_by_id.json
27
96
  - lib/definitions/paths/incidents/incident_by_id.json
28
97
  - lib/definitions/paths/incidents/incidents.json
98
+ - lib/definitions/paths/memberships/membership_by_id.json
99
+ - lib/definitions/paths/memberships/memberships.json
100
+ - lib/definitions/paths/mobiles/mobile_by_id.json
101
+ - lib/definitions/paths/mobiles/mobiles.json
102
+ - lib/definitions/paths/other_assets/other_asset_by_id.json
103
+ - lib/definitions/paths/other_assets/other_assets.json
104
+ - lib/definitions/paths/printers/printer_by_id.json
105
+ - lib/definitions/paths/printers/printers.json
106
+ - lib/definitions/paths/problems/problem_by_id.json
107
+ - lib/definitions/paths/problems/problems.json
108
+ - lib/definitions/paths/purchase_orders/purchase_order_by_id.json
109
+ - lib/definitions/paths/purchase_orders/purchase_orders.json
110
+ - lib/definitions/paths/purchases/purchase_by_id.json
111
+ - lib/definitions/paths/purchases/purchases.json
112
+ - lib/definitions/paths/releases/release_by_id.json
113
+ - lib/definitions/paths/releases/releases.json
114
+ - lib/definitions/paths/risks/risks.json
115
+ - lib/definitions/paths/roles/role_by_id.json
116
+ - lib/definitions/paths/roles/roles.json
117
+ - lib/definitions/paths/service_requests/request_by_id.json
118
+ - lib/definitions/paths/sites/site_by_id.json
119
+ - lib/definitions/paths/sites/sites.json
120
+ - lib/definitions/paths/softwares/software_by_id.json
121
+ - lib/definitions/paths/softwares/softwares.json
122
+ - lib/definitions/paths/solutions/solution_by_id.json
123
+ - lib/definitions/paths/solutions/solutions.json
124
+ - lib/definitions/paths/tasks/task_by_id.json
125
+ - lib/definitions/paths/tasks/tasks.json
126
+ - lib/definitions/paths/time_tracks/time_track_by_id.json
127
+ - lib/definitions/paths/time_tracks/time_tracks.json
128
+ - lib/definitions/paths/users/user_by_id.json
129
+ - lib/definitions/paths/users/users.json
130
+ - lib/definitions/paths/vendors/vendor_by_id.json
131
+ - lib/definitions/paths/vendors/vendors.json
29
132
  - lib/resolved_schema/resolved_schema.json
30
133
  - lib/solarwinds/itsm/api/definitions.rb
31
134
  homepage: https://rubygems.org/gems/solarwinds-itsm-api-definitions
data/lib/definitions/common/schemas/incident.json DELETED
@@ -1,106 +0,0 @@
1
- {
2
- "components": {
3
- "schemas": {
4
- "incident": {
5
- "request": {
6
- "type": "object",
7
- "properties": {
8
- "incident": {
9
- "type": "object",
10
- "properties": {
11
- "name": { "type": "string" },
12
- "site_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
13
- "department_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
14
- "description": { "type": "string" },
15
- "state_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
16
- "assignee": { "$ref": "../components.json#/components/schemas/association_by_email" },
17
- "assignee_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
18
- "priority": { "$ref": "../components.json#/components/schemas/association_by_id" },
19
- "requester": { "$ref": "../components.json#/components/schemas/association_by_email" },
20
- "category": { "$ref": "../components.json#/components/schemas/association_by_name" },
21
- "subcategory": { "$ref": "../components.json#/components/schemas/association_by_name" },
22
- "due_at": { "type": "string" },
23
- "add_to_tag_list": { "type": "string" },
24
- "custom_field_values": { "$ref": "../components.json#/components/schemas/custom_field_values" },
25
- "incidents": { "$ref": "../components.json#/components/schemas/numbers_array" },
26
- "solutions": { "$ref": "../components.json#/components/schemas/numbers_array" },
27
- "changes": { "$ref": "../components.json#/components/schemas/numbers_array" },
28
- "problems": { "$ref": "../components.json#/components/schemas/numbers_array" },
29
- "releases": { "$ref": "../components.json#/components/schemas/numbers_array" },
30
- "configuration_item_ids": { "$ref": "../components.json#/components/schemas/ids_array" }
31
- }
32
- }
33
- }
34
- },
35
- "response": {
36
- "type": "object",
37
- "properties": {
38
- "incident": {
39
- "type": "object",
40
- "properties": {
41
- "id": { "$ref": "../components.json#/components/schemas/id" },
42
- "name": { "type": "string" },
43
- "description": { "type": "string" },
44
- "site": { "$ref": "../components.json#/components/schemas/site_response" },
45
- "department": { "$ref": "../components.json#/components/schemas/department_response" },
46
- "state": { "type": "string" },
47
- "priority": { "type": "string" },
48
- "assignee": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
49
- "requester": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
50
- "category": { "$ref": "../components.json#/components/schemas/category_subcategory" },
51
- "subcategory": { "$ref": "../components.json#/components/schemas/category_subcategory" },
52
- "due_at": { "type": "string" },
53
- "custom_field_values": { "$ref": "../components.json#/components/schemas/custom_field_values" },
54
- "created_by": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
55
- "origin": { "type": "string" },
56
- "incidents": { "$ref": "../components.json#/components/schemas/response_attachments" },
57
- "solutions": { "$ref": "../components.json#/components/schemas/response_attachments" },
58
- "changes": { "$ref": "../components.json#/components/schemas/response_attachments" },
59
- "problems": { "$ref": "../components.json#/components/schemas/response_attachments" },
60
- "releases": { "$ref": "../components.json#/components/schemas/response_attachments" },
61
- "configuration_item_ids": { "$ref": "../components.json#/components/schemas/response_attachments" }
62
- }
63
- }
64
- }
65
- }
66
- },
67
- "incidents": {
68
- "description": "List of incidents",
69
- "type": "array",
70
- "items": {
71
- "allOf": [{ "$ref": "incident.json#/components/schemas/incident/response" }]
72
- }
73
- },
74
- "incident_request_content": {
75
- "application/json": {
76
- "schema": { "$ref": "incident.json#/components/schemas/incident/request" },
77
- "example": { "$ref": "../examples/incident.json#/examples/request/json" }
78
- },
79
- "application/xml": {
80
- "schema": { "$ref": "incident.json#/components/schemas/incident/request" },
81
- "example": { "$ref": "../examples/incident.json#/examples/request/xml" }
82
- }
83
- },
84
- "many_incidents_content": {
85
- "application/json": {
86
- "schema": { "$ref": "incident.json#/components/schemas/incidents" },
87
- "example": [{ "$ref": "../examples/incident.json#/examples/response/json" }]
88
- },
89
- "application/xml": {
90
- "schema": { "$ref": "incident.json#/components/schemas/incidents" },
91
- "example": [{ "$ref": "../examples/incident.json#/examples/response/xml" }]
92
- }
93
- },
94
- "incident_response_content": {
95
- "application/json": {
96
- "schema": { "$ref": "incident.json#/components/schemas/incident/response" },
97
- "example": { "$ref": "../examples/incident.json#/examples/response/json" }
98
- },
99
- "application/xml": {
100
- "schema": { "$ref": "incident.json#/components/schemas/incident/response" },
101
- "example": { "$ref": "../examples/incident.json#/examples/response/xml" }
102
- }
103
- }
104
- }
105
- }
106
- }