solarwinds-itsm-api-definitions 0.1.1 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (114) hide show
  1. checksums.yaml +4 -4
  2. data/lib/definitions/common/components.json +298 -49
  3. data/lib/definitions/common/examples/catalog_item.json +70 -0
  4. data/lib/definitions/common/examples/change.json +127 -0
  5. data/lib/definitions/common/examples/change_catalog.json +92 -0
  6. data/lib/definitions/common/examples/configuration_item.json +108 -0
  7. data/lib/definitions/common/examples/hardware.json +125 -0
  8. data/lib/definitions/common/examples/incident.json +134 -109
  9. data/lib/definitions/common/examples/problem.json +132 -0
  10. data/lib/definitions/common/examples/release.json +150 -0
  11. data/lib/definitions/common/examples/service_request.json +28 -0
  12. data/lib/definitions/common/examples/solution.json +49 -0
  13. data/lib/definitions/common/examples/user.json +106 -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 +85 -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 +117 -0
  32. data/lib/definitions/common/schemas/service_desk/incident.json +99 -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 +105 -10
  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 +7 -7
  76. data/lib/definitions/paths/incidents/incidents.json +11 -11
  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/solarwinds/itsm/api/definitions.rb +52 -3
  112. metadata +106 -4
  113. data/lib/definitions/common/schemas/incident.json +0 -78
  114. data/lib/resolved_schema/resolved_schema.json +0 -1
data/lib/definitions/common/schemas/service_desk/catalog_item.json ADDED
@@ -0,0 +1,71 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "catalog_item": {
10
+ "type": "object",
11
+ "required": ["name", "category"],
12
+ "properties": { "$ref": "catalog_item.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "catalog_item": {
21
+ "type": "object",
22
+ "properties": { "$ref": "catalog_item.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "CI Name" },
29
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
30
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
31
+ "description": { "type": "string", "example": "description" },
32
+ "state": { "type": "string", "example": "Approved" },
33
+ "default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
35
+ "subcategory": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
36
+ "expected_delivery_time": { "type": "string", "example": "1 day" },
37
+ "currency": { "type": "string", "example": "USD" },
38
+ "price": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
39
+ "show_price": { "anyOf": [{ "type": "string", "example": "1" }, { "type": "boolean", "example": true }] },
40
+ "add_to_tag_list": { "type": "string", "example": "tag1, tag2" },
41
+ "remove_from_tag_list": { "type": "string", "example": "tag3" },
42
+ "tag_list": { "type": "string", "example": "tag1, tag2" }
43
+ },
44
+ "response": {
45
+ "type": "object",
46
+ "xml": { "name": "/", "wrapped": true },
47
+ "properties": {
48
+ "catalog_item": {
49
+ "type": "object",
50
+ "properties": {
51
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
52
+ "name": { "type": "string", "example": "CI Name" },
53
+ "description": { "type": "string", "example": "description" },
54
+ "expected_delivery_time": { "type": "string", "example": "1 day" },
55
+ "currency": { "type": "string", "example": "USD" },
56
+ "price": { "type": "string", "example": "1" },
57
+ "show_price": { "type": "boolean", "example": true },
58
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
59
+ "tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
60
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
61
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
62
+ "category": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
63
+ "subcategory": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
64
+ "origin": { "type": "string", "example": "api" }
65
+ }
66
+ }
67
+ }
68
+ }
69
+ }
70
+ }
71
+ }
data/lib/definitions/common/schemas/service_desk/change.json ADDED
@@ -0,0 +1,88 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "change": {
10
+ "type": "object",
11
+ "required": ["name", "change_type"],
12
+ "properties": { "$ref": "change.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "change": {
21
+ "type": "object",
22
+ "properties": { "$ref": "change.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Change Name" },
29
+ "change_type": { "type": "integer", "example": 1 },
30
+ "description": { "type": "string", "example": "description" },
31
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
32
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
33
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
35
+ "state": { "type": "string", "example": "New" },
36
+ "requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
37
+ "assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
38
+ "priority": { "type": "string", "example": "High" },
39
+ "change_plan": { "type": "string", "example": "change plan" },
40
+ "rollback_plan": { "type": "string", "example": "rollback plan" },
41
+ "test_plan": { "type": "string", "example": "test plan" },
42
+ "planned_start_at": { "type": "string", "example": "2025-01-01 00:00" },
43
+ "planned_end_at": { "type": "string", "example": "2025-01-01 05:00" },
44
+ "add_to_tag_list": { "type": "string", "example": "tag1" },
45
+ "remove_from_tag_list": { "type": "string", "example": "tag2" },
46
+ "tag_list": { "type": "string", "example": "tag1" },
47
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
48
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
49
+ "incidents": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
50
+ "problems": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
51
+ "releases": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
52
+ "configuration_item_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" }
53
+ },
54
+ "response": {
55
+ "type": "object",
56
+ "xml": { "name": "/", "wrapped": true },
57
+ "properties": {
58
+ "change": {
59
+ "type": "object",
60
+ "properties": {
61
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
62
+ "name": { "type": "string", "example": "Change Name" },
63
+ "description": { "type": "string", "example": "description" },
64
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
65
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
66
+ "state": { "type": "string", "example": "New" },
67
+ "priority": { "type": "string", "example": "High" },
68
+ "change_plan": { "type": "string", "example": "change plan" },
69
+ "rollback_plan": { "type": "string", "example": "rollback plan" },
70
+ "test_plan": { "type": "string", "example": "test plan" },
71
+ "planned_start_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
72
+ "planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" },
73
+ "created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
74
+ "assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
75
+ "requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
76
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
77
+ "tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
78
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
79
+ "incidents": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
80
+ "changes": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
81
+ "configuration_items": { "$ref": "../../components.json#/components/response/schemas/response_attachments" }
82
+ }
83
+ }
84
+ }
85
+ }
86
+ }
87
+ }
88
+ }
data/lib/definitions/common/schemas/service_desk/change_catalog.json ADDED
@@ -0,0 +1,77 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "change_catalog": {
10
+ "type": "object",
11
+ "required": ["name", "change_type"],
12
+ "properties": { "$ref": "change_catalog.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "change_catalog": {
21
+ "type": "object",
22
+ "properties": { "$ref": "change_catalog.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Change Name" },
29
+ "change_type": { "type": "integer", "example": 1 },
30
+ "description": { "type": "string", "example": "description" },
31
+ "site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
32
+ "department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
33
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
35
+ "state": { "type": "string", "example": "Approved" },
36
+ "default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
37
+ "priority": { "type": "string", "example": "High" },
38
+ "change_plan": { "type": "string", "example": "change plan" },
39
+ "rollback_plan": { "type": "string", "example": "rollback plan" },
40
+ "test_plan": { "type": "string", "example": "test plan" },
41
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
42
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
43
+ "add_to_tag_list": { "type": "string", "example": "tag1" },
44
+ "remove_from_tag_list": { "type": "string", "example": "tag2" },
45
+ "tag_list": { "type": "string", "example": "tag1" },
46
+ "show_in_portal": { "type": "boolean", "example": true }
47
+ },
48
+ "response": {
49
+ "type": "object",
50
+ "xml": { "name": "/", "wrapped": true },
51
+ "properties": {
52
+ "change_catalog": {
53
+ "type": "object",
54
+ "properties": {
55
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
56
+ "name": { "type": "string", "example": "Change Name" },
57
+ "description": { "type": "string", "example": "description" },
58
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
59
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
60
+ "state": { "type": "string", "example": "Approved" },
61
+ "priority": { "type": "string", "example": "High" },
62
+ "change_plan": { "type": "string", "example": "change plan" },
63
+ "rollback_plan": { "type": "string", "example": "rollback plan" },
64
+ "test_plan": { "type": "string", "example": "test plan" },
65
+ "created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
66
+ "default_assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
67
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
68
+ "tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
69
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
70
+ "show_in_portal": { "type": "boolean", "example": true }
71
+ }
72
+ }
73
+ }
74
+ }
75
+ }
76
+ }
77
+ }
data/lib/definitions/common/schemas/service_desk/comment.json ADDED
@@ -0,0 +1,52 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "comment": {
10
+ "type": "object",
11
+ "required": ["body"],
12
+ "properties": { "$ref": "comment.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "comment": {
21
+ "type": "object",
22
+ "properties": { "$ref": "comment.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "body": { "type": "string", "example": "Comment body" },
29
+ "is_private": { "anyOf": [{ "type": "string", "example": "true" }, { "type": "boolean", "example": true }] }
30
+ },
31
+ "response": {
32
+ "type": "object",
33
+ "xml": { "name": "/", "wrapped": true },
34
+ "properties": {
35
+ "comment": {
36
+ "type": "object",
37
+ "properties": {
38
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
39
+ "body": { "type": "string", "example": "Comment body" },
40
+ "is_private": { "type": "string", "example": "true" },
41
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
42
+ "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
43
+ "user": { "$ref": "../../components.json#/components/response/schemas/user_details" },
44
+ "commenter_id": { "$ref": "../../components.json#/components/response/schemas/id" },
45
+ "commenter_type": { "type": "string", "example": "Incident" }
46
+ }
47
+ }
48
+ }
49
+ }
50
+ }
51
+ }
52
+ }
data/lib/definitions/common/schemas/service_desk/configuration_item.json ADDED
@@ -0,0 +1,117 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "configuration_item": {
10
+ "type": "object",
11
+ "required": ["name"],
12
+ "properties": { "$ref": "configuration_item.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "configuration_item": {
21
+ "type": "object",
22
+ "properties": { "$ref": "configuration_item.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "type": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
29
+ "type_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
30
+ "name": { "type": "string", "example": "CI Name" },
31
+ "description": { "type": "string", "example": "description" },
32
+ "asset_tag": { "type": "string", "example": "Configuration Item Tag" },
33
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
34
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
35
+ "state": { "type": "string", "example": "Active" },
36
+ "manager": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
37
+ "user": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
38
+ "add_to_tag_list": { "type": "string", "example": "tag1, tag2" },
39
+ "remove_from_tag_list": { "type": "string", "example": "tag3" },
40
+ "tag_list": { "type": "string", "example": "tag1, tag2" },
41
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
42
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
43
+ "incident_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
44
+ "itsm_change_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
45
+ "problem_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
46
+ "purchase_order_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
47
+ "release_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" }
48
+ },
49
+ "response": {
50
+ "type": "object",
51
+ "xml": { "name": "/", "wrapped": true },
52
+ "properties": {
53
+ "configuration_item": {
54
+ "type": "object",
55
+ "properties": {
56
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
57
+ "name": { "type": "string", "example": "CI Name" },
58
+ "description": { "type": "string", "example": "description" },
59
+ "type": { "$ref": "../../components.json#/components/response/schemas/ci_type" },
60
+ "type_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
61
+ "created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
62
+ "updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
63
+ "tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
64
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
65
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
66
+ "state": { "type": "string", "example": "Active" },
67
+ "manager_id": { "$ref": "../../components.json#/components/response/schemas/group_details" },
68
+ "user_id": { "$ref": "../../components.json#/components/response/schemas/group_details" },
69
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
70
+ "incidents": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
71
+ "changes": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
72
+ "problems": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
73
+ "releases": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
74
+ "purchase_orders": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
75
+ "origin": { "type": "string", "example": "api" }
76
+ }
77
+ }
78
+ }
79
+ },
80
+ "append_multiple_dependent_assets": {
81
+ "type": "object",
82
+ "xml": { "name": "/" },
83
+ "additionalProperties": {
84
+ "type": "object",
85
+ "properties": {
86
+ "selected_ids": {
87
+ "type": "object",
88
+ "properties": {
89
+ "configuration_items": { "type": "array", "items": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } },
90
+ "mobiles": { "type": "array", "items": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } },
91
+ "hardwares": { "type": "array", "items": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } },
92
+ "discovery_hardwares": { "type": "array", "items": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } },
93
+ "other_assets": { "type": "array", "items": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } }
94
+ }
95
+ }
96
+ }
97
+ },
98
+ "example": { "Child Of": { "selected_ids": { "configuration_items": [1] } } }
99
+ },
100
+ "delete_asset_link": {
101
+ "type": "object",
102
+ "xml": { "name": "/" },
103
+ "properties": {
104
+ "assetLinkId": {
105
+ "$ref": "../../components.json#/components/common/schemas/association_by_id",
106
+ "description": "The id of the dependency between the assets"
107
+ },
108
+ "sourceId": {
109
+ "$ref": "../../components.json#/components/common/schemas/association_by_id",
110
+ "description": "The id of the configuration item"
111
+ },
112
+ "sourceType": { "type": "string", "example": "ConfigurationItem" }
113
+ }
114
+ }
115
+ }
116
+ }
117
+ }
data/lib/definitions/common/schemas/service_desk/incident.json ADDED
@@ -0,0 +1,99 @@
1
+ {
2
+ "components": {
3
+ "schemas": {
4
+ "request": {
5
+ "post": {
6
+ "type": "object",
7
+ "xml": { "name": "/" },
8
+ "properties": {
9
+ "incident": {
10
+ "type": "object",
11
+ "required": ["name"],
12
+ "properties": { "$ref": "incident.json#/components/schemas/request_properties" }
13
+ }
14
+ }
15
+ },
16
+ "put": {
17
+ "type": "object",
18
+ "xml": { "name": "/" },
19
+ "properties": {
20
+ "incident": {
21
+ "type": "object",
22
+ "properties": { "$ref": "incident.json#/components/schemas/request_properties" }
23
+ }
24
+ }
25
+ }
26
+ },
27
+ "request_properties": {
28
+ "name": { "type": "string", "example": "Incident Name" },
29
+ "site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
30
+ "department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
31
+ "description": { "type": "string", "example": "description" },
32
+ "state_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
33
+ "assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
34
+ "assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
35
+ "priority": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
36
+ "requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
37
+ "category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
38
+ "subcategory": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
39
+ "due_at": { "type": "string", "example": "Jan 01,2025" },
40
+ "add_to_tag_list": { "type": "string", "example": "tag1, tag2" },
41
+ "remove_from_tag_list": { "type": "string", "example": "tag3" },
42
+ "tag_list": { "type": "string", "example": "tag1, tag2" },
43
+ "custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
44
+ "custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
45
+ "incidents": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
46
+ "solutions": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
47
+ "changes": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
48
+ "problems": {
49
+ "description": "Incident can have only one Problem associated",
50
+ "anyOf": [
51
+ { "$ref": "../../components.json#/components/request/schemas/number_property" },
52
+ {
53
+ "type": "array",
54
+ "maxItems": 1,
55
+ "items": { "$ref": "../../components.json#/components/request/schemas/number_property" }
56
+ }
57
+ ]
58
+ },
59
+ "releases": { "$ref": "../../components.json#/components/request/schemas/attachment_numbers" },
60
+ "configuration_item_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
61
+ "cc": { "$ref": "../../components.json#/components/request/schemas/cc_array" }
62
+ },
63
+ "response": {
64
+ "type": "object",
65
+ "xml": { "name": "/", "wrapped": true },
66
+ "properties": {
67
+ "incident": {
68
+ "type": "object",
69
+ "properties": {
70
+ "id": { "$ref": "../../components.json#/components/response/schemas/id" },
71
+ "name": { "type": "string", "example": "Incident Name" },
72
+ "description": { "type": "string", "example": "description" },
73
+ "site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
74
+ "department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
75
+ "state": { "type": "string", "example": "New" },
76
+ "priority": { "type": "string", "example": "High" },
77
+ "assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
78
+ "requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
79
+ "category": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
80
+ "subcategory": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
81
+ "due_at": { "type": "string", "example": "Jan 01,2025" },
82
+ "custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
83
+ "created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
84
+ "origin": { "type": "string", "example": "api" },
85
+ "incidents": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
86
+ "solutions": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
87
+ "changes": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
88
+ "problems": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
89
+ "releases": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
90
+ "configuration_items": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
91
+ "is_service_request": { "type": "boolean", "example": true },
92
+ "cc": { "$ref": "../../components.json#/components/request/schemas/cc_array" }
93
+ }
94
+ }
95
+ }
96
+ }
97
+ }
98
+ }
99
+ }