solarwinds-itsm-api-definitions 0.1.2 → 0.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/definitions/common/components.json +286 -56
- data/lib/definitions/common/examples/catalog_item.json +70 -0
- data/lib/definitions/common/examples/change.json +127 -0
- data/lib/definitions/common/examples/change_catalog.json +92 -0
- data/lib/definitions/common/examples/configuration_item.json +108 -0
- data/lib/definitions/common/examples/hardware.json +125 -0
- data/lib/definitions/common/examples/incident.json +134 -109
- data/lib/definitions/common/examples/problem.json +132 -0
- data/lib/definitions/common/examples/release.json +150 -0
- data/lib/definitions/common/examples/service_request.json +28 -0
- data/lib/definitions/common/examples/solution.json +49 -0
- data/lib/definitions/common/examples/user.json +100 -70
- data/lib/definitions/common/schemas/analytics/audit.json +28 -0
- data/lib/definitions/common/schemas/analytics/risk.json +28 -0
- data/lib/definitions/common/schemas/inventory/hardware.json +104 -0
- data/lib/definitions/common/schemas/inventory/mobile.json +73 -0
- data/lib/definitions/common/schemas/inventory/other_asset.json +74 -0
- data/lib/definitions/common/schemas/inventory/printer.json +41 -0
- data/lib/definitions/common/schemas/inventory/software.json +28 -0
- data/lib/definitions/common/schemas/inventory/warranty.json +40 -0
- data/lib/definitions/common/schemas/procurement/contract.json +67 -0
- data/lib/definitions/common/schemas/procurement/item.json +51 -0
- data/lib/definitions/common/schemas/procurement/purchase.json +57 -0
- data/lib/definitions/common/schemas/procurement/purchase_order.json +85 -0
- data/lib/definitions/common/schemas/procurement/vendor.json +67 -0
- data/lib/definitions/common/schemas/service_desk/catalog_item.json +71 -0
- data/lib/definitions/common/schemas/service_desk/change.json +88 -0
- data/lib/definitions/common/schemas/service_desk/change_catalog.json +77 -0
- data/lib/definitions/common/schemas/service_desk/comment.json +52 -0
- data/lib/definitions/common/schemas/service_desk/configuration_item.json +117 -0
- data/lib/definitions/common/schemas/service_desk/incident.json +99 -0
- data/lib/definitions/common/schemas/service_desk/problem.json +81 -0
- data/lib/definitions/common/schemas/service_desk/release.json +86 -0
- data/lib/definitions/common/schemas/service_desk/service_request.json +31 -0
- data/lib/definitions/common/schemas/service_desk/solution.json +61 -0
- data/lib/definitions/common/schemas/service_desk/time_track.json +37 -0
- data/lib/definitions/common/schemas/setup/category.json +54 -0
- data/lib/definitions/common/schemas/setup/department.json +48 -0
- data/lib/definitions/common/schemas/setup/group.json +65 -0
- data/lib/definitions/common/schemas/setup/role.json +51 -0
- data/lib/definitions/common/schemas/setup/site.json +64 -0
- data/lib/definitions/common/schemas/setup/user.json +67 -0
- data/lib/definitions/common/schemas/tasks/task.json +52 -0
- data/lib/definitions/openapi.json +102 -7
- data/lib/definitions/paths/attachments/attachments.json +12 -0
- data/lib/definitions/paths/audits/audits.json +35 -0
- data/lib/definitions/paths/audits/audits_by_id.json +37 -0
- data/lib/definitions/paths/catalog_items/catalog_item_by_id.json +83 -0
- data/lib/definitions/paths/catalog_items/catalog_items.json +69 -0
- data/lib/definitions/paths/categories/categories.json +62 -0
- data/lib/definitions/paths/categories/category_by_id.json +70 -0
- data/lib/definitions/paths/change_catalogs/change_catalog_by_id.json +83 -0
- data/lib/definitions/paths/change_catalogs/change_catalogs.json +69 -0
- data/lib/definitions/paths/changes/change_by_id.json +83 -0
- data/lib/definitions/paths/changes/changes.json +69 -0
- data/lib/definitions/paths/comments/comment_by_id.json +65 -0
- data/lib/definitions/paths/comments/comments.json +31 -0
- data/lib/definitions/paths/configuration_items/append_dependent_assets.json +24 -0
- data/lib/definitions/paths/configuration_items/configuration_item_by_id.json +83 -0
- data/lib/definitions/paths/configuration_items/configuration_items.json +69 -0
- data/lib/definitions/paths/configuration_items/delete_asset_link.json +24 -0
- data/lib/definitions/paths/contracts/contract_by_id.json +74 -0
- data/lib/definitions/paths/contracts/contracts.json +62 -0
- data/lib/definitions/paths/contracts/item_by_id.json +75 -0
- data/lib/definitions/paths/contracts/items.json +30 -0
- data/lib/definitions/paths/departments/department_by_id.json +70 -0
- data/lib/definitions/paths/departments/departments.json +62 -0
- data/lib/definitions/paths/groups/group_by_id.json +70 -0
- data/lib/definitions/paths/groups/groups.json +62 -0
- data/lib/definitions/paths/hardwares/hardware_by_id.json +83 -0
- data/lib/definitions/paths/hardwares/hardwares.json +69 -0
- data/lib/definitions/paths/hardwares/warranties.json +64 -0
- data/lib/definitions/paths/hardwares/warranty_by_id.json +75 -0
- data/lib/definitions/paths/incidents/incident_by_id.json +7 -7
- data/lib/definitions/paths/incidents/incidents.json +11 -11
- data/lib/definitions/paths/memberships/membership_by_id.json +20 -0
- data/lib/definitions/paths/memberships/memberships.json +29 -0
- data/lib/definitions/paths/mobiles/mobile_by_id.json +74 -0
- data/lib/definitions/paths/mobiles/mobiles.json +62 -0
- data/lib/definitions/paths/other_assets/other_asset_by_id.json +74 -0
- data/lib/definitions/paths/other_assets/other_assets.json +62 -0
- data/lib/definitions/paths/printers/printer_by_id.json +53 -0
- data/lib/definitions/paths/printers/printers.json +36 -0
- data/lib/definitions/paths/problems/problem_by_id.json +83 -0
- data/lib/definitions/paths/problems/problems.json +69 -0
- data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +74 -0
- data/lib/definitions/paths/purchase_orders/purchase_orders.json +62 -0
- data/lib/definitions/paths/purchases/purchase_by_id.json +65 -0
- data/lib/definitions/paths/purchases/purchases.json +31 -0
- data/lib/definitions/paths/releases/release_by_id.json +83 -0
- data/lib/definitions/paths/releases/releases.json +69 -0
- data/lib/definitions/paths/risks/risks.json +34 -0
- data/lib/definitions/paths/roles/role_by_id.json +70 -0
- data/lib/definitions/paths/roles/roles.json +62 -0
- data/lib/definitions/paths/service_requests/request_by_id.json +37 -0
- data/lib/definitions/paths/sites/site_by_id.json +74 -0
- data/lib/definitions/paths/sites/sites.json +62 -0
- data/lib/definitions/paths/softwares/software_by_id.json +24 -0
- data/lib/definitions/paths/softwares/softwares.json +36 -0
- data/lib/definitions/paths/solutions/solution_by_id.json +83 -0
- data/lib/definitions/paths/solutions/solutions.json +69 -0
- data/lib/definitions/paths/tasks/task_by_id.json +65 -0
- data/lib/definitions/paths/tasks/tasks.json +31 -0
- data/lib/definitions/paths/time_tracks/time_track_by_id.json +65 -0
- data/lib/definitions/paths/time_tracks/time_tracks.json +66 -0
- data/lib/definitions/paths/users/user_by_id.json +8 -9
- data/lib/definitions/paths/users/users.json +11 -11
- data/lib/definitions/paths/vendors/vendor_by_id.json +74 -0
- data/lib/definitions/paths/vendors/vendors.json +62 -0
- data/lib/solarwinds/itsm/api/definitions.rb +52 -3
- metadata +103 -5
- data/lib/definitions/common/schemas/incident.json +0 -69
- data/lib/definitions/common/schemas/user.json +0 -53
- data/lib/resolved_schema/resolved_schema.json +0 -1
@@ -0,0 +1,62 @@
|
|
1
|
+
{
|
2
|
+
"get": {
|
3
|
+
"operationId": "getVendors",
|
4
|
+
"description": "List of vendors",
|
5
|
+
"tags": ["Vendor"],
|
6
|
+
"parameters": [
|
7
|
+
{ "$ref": "../../common/components.json#/components/request/parameters/token_param" }
|
8
|
+
],
|
9
|
+
"responses": {
|
10
|
+
"200": {
|
11
|
+
"description": "Object was returned correctly",
|
12
|
+
"content": {
|
13
|
+
"application/json": {
|
14
|
+
"schema": {
|
15
|
+
"description": "List of vendors",
|
16
|
+
"type": "array",
|
17
|
+
"items": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/response" }
|
18
|
+
}
|
19
|
+
},
|
20
|
+
"application/xml": {
|
21
|
+
"schema": {
|
22
|
+
"description": "List of vendors",
|
23
|
+
"type": "array",
|
24
|
+
"xml": { "name": "/", "wrapped": true },
|
25
|
+
"items": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/response" }
|
26
|
+
}
|
27
|
+
}
|
28
|
+
}
|
29
|
+
},
|
30
|
+
"400": { "description": "Bad request" },
|
31
|
+
"404": { "description": "Not found" },
|
32
|
+
"500": { "description": "Server error" }
|
33
|
+
}
|
34
|
+
},
|
35
|
+
"post": {
|
36
|
+
"operationId": "createVendor",
|
37
|
+
"description": "Create new vendor",
|
38
|
+
"tags": ["Vendor"],
|
39
|
+
"parameters": [
|
40
|
+
{ "$ref": "../../common/components.json#/components/request/parameters/token_param" }
|
41
|
+
],
|
42
|
+
"requestBody": {
|
43
|
+
"required": true,
|
44
|
+
"description": "Vendor fields to fill",
|
45
|
+
"content": {
|
46
|
+
"application/json": { "schema": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/request/post" } },
|
47
|
+
"application/xml": { "schema": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/request/post" } }
|
48
|
+
}
|
49
|
+
},
|
50
|
+
"responses": {
|
51
|
+
"200": {
|
52
|
+
"description": "Object created and returned correctly",
|
53
|
+
"content": {
|
54
|
+
"application/json": { "schema": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/response" } },
|
55
|
+
"application/xml": { "schema": { "$ref": "../../common/schemas/procurement/vendor.json#/components/schemas/response" } }
|
56
|
+
}
|
57
|
+
},
|
58
|
+
"400": { "description": "Bad request" },
|
59
|
+
"500": { "description": "Server error" }
|
60
|
+
}
|
61
|
+
}
|
62
|
+
}
|
@@ -6,7 +6,7 @@ module Solarwinds
|
|
6
6
|
module Api
|
7
7
|
module Definitions
|
8
8
|
LIB_DIR = Pathname.new(File.join(__dir__, '../../..')).cleanpath.to_s
|
9
|
-
|
9
|
+
REDOC_DIR = Pathname.new(File.join(__dir__, '../../../../Redocly/redoc/schema')).cleanpath.to_s
|
10
10
|
|
11
11
|
def self.base_schema
|
12
12
|
path = File.join(LIB_DIR, 'definitions/openapi.json')
|
@@ -18,10 +18,10 @@ module Solarwinds
|
|
18
18
|
end
|
19
19
|
|
20
20
|
def self.resolved_schema_path
|
21
|
-
File.join(
|
21
|
+
File.join(REDOC_DIR, 'resolved_schema.json')
|
22
22
|
end
|
23
23
|
|
24
|
-
def self.write_resolved_schema(path =
|
24
|
+
def self.write_resolved_schema(path = REDOC_DIR, name = 'resolved_schema.json')
|
25
25
|
File.write(File.join(path, name), resolved_schema.to_json)
|
26
26
|
end
|
27
27
|
|
@@ -31,6 +31,9 @@ module Solarwinds
|
|
31
31
|
return schema unless schema.is_a?(Array) || schema.is_a?(Hash)
|
32
32
|
|
33
33
|
schema.each_with_object({}) do |(key, value), resolved_schema|
|
34
|
+
if key == 'application/xml'
|
35
|
+
value['example'] = generate_xml_example(value, resolved_schema)
|
36
|
+
end
|
34
37
|
if key == '$ref'
|
35
38
|
reference = [*value].each_with_object({}) do |referred_path, result|
|
36
39
|
split_path = referred_path.split('#/')
|
@@ -53,6 +56,52 @@ module Solarwinds
|
|
53
56
|
end
|
54
57
|
end
|
55
58
|
end
|
59
|
+
|
60
|
+
def self.generate_xml_example(value, resolved_schema)
|
61
|
+
if value['schema']['type'] == 'array'
|
62
|
+
items = resolved_schema['application/json']['schema']['items']
|
63
|
+
properties = (items['allOf'] && items['allOf'][0]['properties']) || items['properties']
|
64
|
+
return "<>\n\t#{recursive_xml_properties(properties, 1)}\n<>"
|
65
|
+
end
|
66
|
+
|
67
|
+
properties = resolved_schema['application/json']['schema']['properties']
|
68
|
+
recursive_xml_properties(properties)
|
69
|
+
end
|
70
|
+
|
71
|
+
def self.recursive_xml_properties(properties, levels = 0)
|
72
|
+
return unless properties
|
73
|
+
|
74
|
+
xml_example = ''
|
75
|
+
tabs = tabs_count(levels)
|
76
|
+
|
77
|
+
properties.each do |k, val|
|
78
|
+
value_example = case val['type']
|
79
|
+
when 'object'
|
80
|
+
items = val['oneOf'] || val['anyOf']
|
81
|
+
properties = items && items.first['properties'] || val['properties']
|
82
|
+
"\n\t#{tabs}#{recursive_xml_properties(properties, levels + 1)}"
|
83
|
+
when 'string'
|
84
|
+
val['example'] || 'string example'
|
85
|
+
when 'integer'
|
86
|
+
val['example'] || '1'
|
87
|
+
when 'boolean'
|
88
|
+
val['example'] || 'true'
|
89
|
+
else
|
90
|
+
types_array = val['anyOf'] || val['oneOf']
|
91
|
+
next unless types_array
|
92
|
+
types_array.first['example'] || '1'
|
93
|
+
end
|
94
|
+
|
95
|
+
xml_example = "#{xml_example}<#{k}>#{value_example}</#{k}>\n#{tabs}"
|
96
|
+
end
|
97
|
+
xml_example.chop
|
98
|
+
end
|
99
|
+
|
100
|
+
def self.tabs_count(levels)
|
101
|
+
tabs = ''
|
102
|
+
levels.times { tabs = "#{tabs}\t" }
|
103
|
+
tabs
|
104
|
+
end
|
56
105
|
end
|
57
106
|
end
|
58
107
|
end
|
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.1.
|
4
|
+
version: 0.1.7
|
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:
|
13
|
+
date: 2021-05-11 00:00:00.000000000 Z
|
14
14
|
dependencies: []
|
15
15
|
description: SolarWinds ITSM OpenAPI definitions gem
|
16
16
|
email:
|
@@ -21,16 +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
|
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
|
25
34
|
- lib/definitions/common/examples/user.json
|
26
|
-
- lib/definitions/common/schemas/
|
27
|
-
- lib/definitions/common/schemas/
|
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
|
28
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
|
29
96
|
- lib/definitions/paths/incidents/incident_by_id.json
|
30
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
|
31
128
|
- lib/definitions/paths/users/user_by_id.json
|
32
129
|
- lib/definitions/paths/users/users.json
|
33
|
-
- lib/
|
130
|
+
- lib/definitions/paths/vendors/vendor_by_id.json
|
131
|
+
- lib/definitions/paths/vendors/vendors.json
|
34
132
|
- lib/solarwinds/itsm/api/definitions.rb
|
35
133
|
homepage: https://rubygems.org/gems/solarwinds-itsm-api-definitions
|
36
134
|
licenses:
|
@@ -1,69 +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/common/schemas/association_by_id" },
|
13
|
-
"department_id": { "$ref": "../components.json#/components/common/schemas/association_by_id" },
|
14
|
-
"description": { "type": "string" },
|
15
|
-
"state_id": { "$ref": "../components.json#/components/common/schemas/association_by_id" },
|
16
|
-
"assignee": { "$ref": "../components.json#/components/request/schemas/association_by_email" },
|
17
|
-
"assignee_id": { "$ref": "../components.json#/components/common/schemas/association_by_id" },
|
18
|
-
"priority": { "$ref": "../components.json#/components/common/schemas/association_by_id" },
|
19
|
-
"requester": { "$ref": "../components.json#/components/request/schemas/association_by_email" },
|
20
|
-
"category": { "$ref": "../components.json#/components/request/schemas/association_by_name" },
|
21
|
-
"subcategory": { "$ref": "../components.json#/components/request/schemas/association_by_name" },
|
22
|
-
"due_at": { "type": "string" },
|
23
|
-
"add_to_tag_list": { "type": "string" },
|
24
|
-
"custom_field_values": { "$ref": "../components.json#/components/request/schemas/custom_field_values" },
|
25
|
-
"incidents": { "$ref": "../components.json#/components/request/schemas/numbers_array" },
|
26
|
-
"solutions": { "$ref": "../components.json#/components/request/schemas/numbers_array" },
|
27
|
-
"changes": { "$ref": "../components.json#/components/request/schemas/numbers_array" },
|
28
|
-
"problems": { "$ref": "../components.json#/components/request/schemas/numbers_array" },
|
29
|
-
"releases": { "$ref": "../components.json#/components/request/schemas/numbers_array" },
|
30
|
-
"configuration_item_ids": { "$ref": "../components.json#/components/common/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/response/schemas/id" },
|
42
|
-
"name": { "type": "string" },
|
43
|
-
"description": { "type": "string" },
|
44
|
-
"site": { "$ref": "../components.json#/components/response/schemas/site_response" },
|
45
|
-
"department": { "$ref": "../components.json#/components/response/schemas/department_response" },
|
46
|
-
"state": { "type": "string" },
|
47
|
-
"priority": { "type": "string" },
|
48
|
-
"assignee": { "$ref": "../components.json#/components/response/schemas/assignee_details" },
|
49
|
-
"requester": { "$ref": "../components.json#/components/response/schemas/requester_details" },
|
50
|
-
"category": { "$ref": "../components.json#/components/response/schemas/category_subcategory" },
|
51
|
-
"subcategory": { "$ref": "../components.json#/components/response/schemas/category_subcategory" },
|
52
|
-
"due_at": { "type": "string" },
|
53
|
-
"custom_field_values": { "$ref": "../components.json#/components/response/schemas/custom_field_values" },
|
54
|
-
"created_by": { "$ref": "../components.json#/components/response/schemas/requester_details" },
|
55
|
-
"origin": { "type": "string" },
|
56
|
-
"incidents": { "$ref": "../components.json#/components/response/schemas/response_attachments" },
|
57
|
-
"solutions": { "$ref": "../components.json#/components/response/schemas/response_attachments" },
|
58
|
-
"changes": { "$ref": "../components.json#/components/response/schemas/response_attachments" },
|
59
|
-
"problems": { "$ref": "../components.json#/components/response/schemas/response_attachments" },
|
60
|
-
"releases": { "$ref": "../components.json#/components/response/schemas/response_attachments" },
|
61
|
-
"configuration_items": { "$ref": "../components.json#/components/response/schemas/response_attachments" }
|
62
|
-
}
|
63
|
-
}
|
64
|
-
}
|
65
|
-
}
|
66
|
-
}
|
67
|
-
}
|
68
|
-
}
|
69
|
-
}
|
@@ -1,53 +0,0 @@
|
|
1
|
-
{
|
2
|
-
"components": {
|
3
|
-
"schemas": {
|
4
|
-
"user": {
|
5
|
-
"request": {
|
6
|
-
"type": "object",
|
7
|
-
"properties": {
|
8
|
-
"user": {
|
9
|
-
"type": "object",
|
10
|
-
"properties": {
|
11
|
-
"name": { "type": "string" },
|
12
|
-
"title": { "type": "string" },
|
13
|
-
"email": { "type": "string", "format": "email" },
|
14
|
-
"disabled": { "type": "boolean" },
|
15
|
-
"phone": { "type": "string" },
|
16
|
-
"mobile_phone": { "type": "string" },
|
17
|
-
"role": { "$ref": "../components.json#/components/request/schemas/association_by_name" },
|
18
|
-
"site": { "$ref": "../components.json#/components/request/schemas/association_by_name" },
|
19
|
-
"department": { "$ref": "../components.json#/components/request/schemas/association_by_name" },
|
20
|
-
"reports_to": { "$ref": "../components.json#/components/request/schemas/association_by_email" },
|
21
|
-
"custom_fields_values": { "$ref": "../components.json#/components/request/schemas/custom_fields_values" }
|
22
|
-
}
|
23
|
-
}
|
24
|
-
}
|
25
|
-
},
|
26
|
-
"response": {
|
27
|
-
"type": "object",
|
28
|
-
"properties": {
|
29
|
-
"user": {
|
30
|
-
"type": "object",
|
31
|
-
"properties": {
|
32
|
-
"id": { "$ref": "../components.json#/components/response/schemas/id" },
|
33
|
-
"name": { "type": "string" },
|
34
|
-
"title": { "type": "string" },
|
35
|
-
"email": { "type": "string", "format": "email" },
|
36
|
-
"phone": { "type": "string" },
|
37
|
-
"mobile_phone": { "type": "string" },
|
38
|
-
"role": { "$ref": "../components.json#/components/response/schemas/role" },
|
39
|
-
"site": { "$ref": "../components.json#/components/response/schemas/site_response" },
|
40
|
-
"department": { "$ref": "../components.json#/components/response/schemas/department_response" },
|
41
|
-
"custom_fields_values": { "$ref": "../components.json#/components/response/schemas/custom_field_values" },
|
42
|
-
"avatar": { "$ref": "../components.json#/components/response/schemas/avatar" },
|
43
|
-
"reports_to": { "$ref": "../components.json#/components/response/schemas/assignee_details" },
|
44
|
-
"group_ids": { "$ref": "../components.json#/components/common/schemas/ids_array" },
|
45
|
-
"created_at": { "type": "string" }
|
46
|
-
}
|
47
|
-
}
|
48
|
-
}
|
49
|
-
}
|
50
|
-
}
|
51
|
-
}
|
52
|
-
}
|
53
|
-
}
|
@@ -1 +0,0 @@
|
|
1
|
-
{"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.1.2","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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"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":"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":"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}}}},"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","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"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","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"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"}]}}}}}}}}},"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"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":"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":"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}}}},"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"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":"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":"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}]}}}}},"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","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"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","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"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"}]}}}}}}}}},"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"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":"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":"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":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"created_by":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"account_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"user_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"email":{"type":"string"},"name":{"type":"string"},"disabled":{"type":"boolean"},"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_items":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}}}},"400":{"description":"Bad request"},"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","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}},"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":"John Boe","email":"john.boe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JB"}}}}},"application/xml":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}}}}},"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","properties":{"user":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"disabled":{"type":"boolean"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"reports_to":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}},"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":"john.boe@email.com"},"custom_field_values":{"custom_field_value":[{"name":"field name","value":"content"}]}}}},"application/xml":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"disabled":{"type":"boolean"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"reports_to":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}},"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":"John Boe","email":"john.boe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JB"}}}}},"application/xml":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}}}}},"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":"Object was returned correctly","content":{"application/json":{"example":{"messages":{"message":"Deleted user Test update"}}}}},"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","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}}]}},"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":"John Boe","email":"john.boe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JB"}}}}]},"application/xml":{"schema":{"description":"List of users","type":"array","items":{"allOf":[{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}}]}}}}},"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","properties":{"user":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"disabled":{"type":"boolean"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"reports_to":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}},"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":"john.boe@email.com"},"custom_field_values":{"custom_field_value":[{"name":"field name","value":"content"}]}}}},"application/xml":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"disabled":{"type":"boolean"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"reports_to":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"custom_fields_values":{"type":"object","required":["custom_fields_value"],"properties":{"custom_fields_value":{"type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}}}}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}},"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":"John Boe","email":"john.boe@email.com","avatar":{"type":"initials","color":"#fd4166","initials":"JB"}}}}},"application/xml":{"schema":{"type":"object","properties":{"user":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"title":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"mobile_phone":{"type":"string"},"role":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"portal":{"type":"boolean"},"show_my_tasks":{"type":"boolean"}}},"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"}]}}},"custom_fields_values":{"type":"array","items":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"custom_field_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"value":{"type":"string"},"options":{"type":"string"},"type_name":{"type":"string"}}}},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}},"reports_to":{"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}}}}},"group_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}},"created_at":{"type":"string"}}}}}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}}},"tags":[{"name":"Incident","description":"Incident operations"},{"name":"User","description":"User operations"}]}
|