solarwinds-itsm-api-definitions 0.0.4 → 0.0.9
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 +111 -1
- data/lib/definitions/common/examples/incident.json +122 -0
- data/lib/definitions/common/schemas/incident.json +95 -13
- data/lib/definitions/openapi.json +10 -3
- data/lib/definitions/paths/incidents/incident_by_id.json +39 -18
- data/lib/definitions/paths/incidents/incidents.json +41 -0
- data/lib/resolved_schema/resolved_schema.json +1 -1
- metadata +12 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d7bc09e2ccbe271486652a5b1353e148a4133f26bcea8fa73626c679ce87b544
|
|
4
|
+
data.tar.gz: f1795539a386deee43a2a1f1cccc93fdf5bec29328354f3ebae1b6c4e21147a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 43fe7ac8fc5c0c8fb6d5739798473bbd905c84e4143ca6302d7e16bd95e310f4cf416ab11bcab38da11405bc4c00e2a53ab947129c11ee2dbf79a44d3f826f97
|
|
7
|
+
data.tar.gz: 3e31bdf9ac3a641e3a8d77173678caf65d6cc73bdc4388129cf81397aa236ca9160e1c7bef2fa749d0edecb31b7025c0b40af78f2174377fbfe340093b9a3734
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"id_param": {
|
|
11
11
|
"name": "id",
|
|
12
12
|
"in": "path",
|
|
13
|
-
"schema": { "
|
|
13
|
+
"schema": { "type": "string" },
|
|
14
14
|
"required": true,
|
|
15
15
|
"description": "Numeric ID of the object to get or update"
|
|
16
16
|
}
|
|
@@ -40,6 +40,116 @@
|
|
|
40
40
|
}
|
|
41
41
|
},
|
|
42
42
|
{ "enum": ["nil", "", null] }]
|
|
43
|
+
},
|
|
44
|
+
"id": {
|
|
45
|
+
"readOnly": true,
|
|
46
|
+
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
47
|
+
},
|
|
48
|
+
"custom_field": {
|
|
49
|
+
"type": "object",
|
|
50
|
+
"oneOf": [{
|
|
51
|
+
"type": "object",
|
|
52
|
+
"required": ["name", "value"],
|
|
53
|
+
"properties": {
|
|
54
|
+
"name": { "type": "string" },
|
|
55
|
+
"value": { "type": "string" }
|
|
56
|
+
}
|
|
57
|
+
}]
|
|
58
|
+
},
|
|
59
|
+
"custom_field_value": {
|
|
60
|
+
"type": "array",
|
|
61
|
+
"items": {
|
|
62
|
+
"allOf": [{ "$ref": "components.json#/components/schemas/custom_field" }]
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
"custom_field_values": {
|
|
66
|
+
"type": "object",
|
|
67
|
+
"oneOf": [{
|
|
68
|
+
"type": "object",
|
|
69
|
+
"required": ["custom_field_value"],
|
|
70
|
+
"properties": {
|
|
71
|
+
"custom_field_value": { "$ref": "components.json#/components/schemas/custom_field_value" }
|
|
72
|
+
}
|
|
73
|
+
}]
|
|
74
|
+
},
|
|
75
|
+
"category_subcategory": {
|
|
76
|
+
"type": "object",
|
|
77
|
+
"properties": {
|
|
78
|
+
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
79
|
+
"name": { "type": "string" },
|
|
80
|
+
"default_tags": { "type": "string" },
|
|
81
|
+
"parent_id": { "$ref": "components.json#/components/schemas/id" },
|
|
82
|
+
"default_assignee_id": { "$ref": "components.json#/components/schemas/id" }
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"avatar": {
|
|
86
|
+
"type": "object",
|
|
87
|
+
"properties": {
|
|
88
|
+
"type": { "type": "string" },
|
|
89
|
+
"color": { "type": "string" },
|
|
90
|
+
"initials": {
|
|
91
|
+
"type": "string",
|
|
92
|
+
"minLength": 2,
|
|
93
|
+
"maxLength": 2
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"requester_assignee_details": {
|
|
98
|
+
"type": "object",
|
|
99
|
+
"properties": {
|
|
100
|
+
"group_id": { "$ref": "components.json#/components/schemas/association_by_id" },
|
|
101
|
+
"is_user": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] },
|
|
102
|
+
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
103
|
+
"name": { "type": "string" },
|
|
104
|
+
"email": { "type": "string" },
|
|
105
|
+
"avatar": { "$ref": "components.json#/components/schemas/avatar" }
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"site_response": {
|
|
109
|
+
"type": "object",
|
|
110
|
+
"properties": {
|
|
111
|
+
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
112
|
+
"name": { "type": "string" },
|
|
113
|
+
"description": { "type": "string" },
|
|
114
|
+
"location": { "type": "string" },
|
|
115
|
+
"timezone": { "type": "string" }
|
|
116
|
+
}
|
|
117
|
+
},
|
|
118
|
+
"department_response": {
|
|
119
|
+
"type": "object",
|
|
120
|
+
"properties": {
|
|
121
|
+
"id": { "$ref": "components.json#/components/schemas/id" },
|
|
122
|
+
"name": { "type": "string" },
|
|
123
|
+
"description": { "type": "string" },
|
|
124
|
+
"default_assignee_id": { "$ref": "components.json#/components/schemas/id" }
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"ids_array": {
|
|
128
|
+
"type": "array",
|
|
129
|
+
"items": {
|
|
130
|
+
"$ref": "components.json#/components/schemas/association_by_id"
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"numbers_array": {
|
|
134
|
+
"type": "array",
|
|
135
|
+
"items": {
|
|
136
|
+
"type": "object",
|
|
137
|
+
"properties": {
|
|
138
|
+
"number": {
|
|
139
|
+
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
"response_attachments": {
|
|
145
|
+
"type": "array",
|
|
146
|
+
"items": {
|
|
147
|
+
"type": "object",
|
|
148
|
+
"properties": {
|
|
149
|
+
"id": { "$ref": "components.json#/components/schemas/association_by_id" },
|
|
150
|
+
"href": { "type": "string" }
|
|
151
|
+
}
|
|
152
|
+
}
|
|
43
153
|
}
|
|
44
154
|
}
|
|
45
155
|
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
{
|
|
2
|
+
"examples": {
|
|
3
|
+
"request": {
|
|
4
|
+
"json": {
|
|
5
|
+
"incident": {
|
|
6
|
+
"name": "Incident Name",
|
|
7
|
+
"site_id": 1,
|
|
8
|
+
"department_id": 1,
|
|
9
|
+
"description": "description",
|
|
10
|
+
"state_id": 1,
|
|
11
|
+
"assignee": { "email": "john.doe@email.com" },
|
|
12
|
+
"requester": { "email": "john.doe@email.com" },
|
|
13
|
+
"priority": "High",
|
|
14
|
+
"category": { "name": "Facilities" },
|
|
15
|
+
"subcategory": { "name": "Equipment" },
|
|
16
|
+
"due_at": "Jan 01,2025",
|
|
17
|
+
"add_to_tag_list": "tag1, tag2",
|
|
18
|
+
"custom_fields_values": {
|
|
19
|
+
"custom_fields_value": [
|
|
20
|
+
{ "name": "field name", "value": "content" }
|
|
21
|
+
]
|
|
22
|
+
},
|
|
23
|
+
"incidents": [{ "number": "100" }],
|
|
24
|
+
"problems": [{ "number": "100" }],
|
|
25
|
+
"changes": [{ "number": "100" }],
|
|
26
|
+
"solutions": [{ "number" :"100" }],
|
|
27
|
+
"releases": [{ "number": "100" }],
|
|
28
|
+
"configuration_item_ids":["100"]
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"xml": {
|
|
32
|
+
"description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
|
|
33
|
+
"xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
"response": {
|
|
37
|
+
"json": {
|
|
38
|
+
"incident": {
|
|
39
|
+
"id": "10000",
|
|
40
|
+
"number": "1000",
|
|
41
|
+
"name": "Incident Name",
|
|
42
|
+
"description": "description",
|
|
43
|
+
"state": "New",
|
|
44
|
+
"site": {
|
|
45
|
+
"id": "1",
|
|
46
|
+
"name": "Austin TX, USA",
|
|
47
|
+
"location": "AUS",
|
|
48
|
+
"description": "",
|
|
49
|
+
"time_zone": ""
|
|
50
|
+
},
|
|
51
|
+
"department": {
|
|
52
|
+
"id": "1",
|
|
53
|
+
"name": "Support",
|
|
54
|
+
"description": "",
|
|
55
|
+
"default_assignee_id": "1"
|
|
56
|
+
},
|
|
57
|
+
"category": {
|
|
58
|
+
"id": "10000",
|
|
59
|
+
"name": "Facilities",
|
|
60
|
+
"default_tags": "tagA, tagB",
|
|
61
|
+
"parent_id": "null",
|
|
62
|
+
"default_assignee_id": "1"
|
|
63
|
+
},
|
|
64
|
+
"subcategory": {
|
|
65
|
+
"id": "1000",
|
|
66
|
+
"name": "Equipment",
|
|
67
|
+
"default_tags": "",
|
|
68
|
+
"parent_id": "10000",
|
|
69
|
+
"default_assignee_id": "1"
|
|
70
|
+
},
|
|
71
|
+
"priority": "High",
|
|
72
|
+
"assignee": {
|
|
73
|
+
"group_id": "1",
|
|
74
|
+
"is_user": "true",
|
|
75
|
+
"id": "1",
|
|
76
|
+
"name": "Jogn Doe",
|
|
77
|
+
"email": "john.doe@email.com",
|
|
78
|
+
"avatar": {
|
|
79
|
+
"type": "initials",
|
|
80
|
+
"color": "#fd4165",
|
|
81
|
+
"initials": "AA"
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"requester": {
|
|
85
|
+
"group_id": "1",
|
|
86
|
+
"is_user": "true",
|
|
87
|
+
"id": "1",
|
|
88
|
+
"name": "John Doe",
|
|
89
|
+
"email": "john.doe@email.com",
|
|
90
|
+
"avatar": {
|
|
91
|
+
"type": "initials",
|
|
92
|
+
"color": "#fd4165",
|
|
93
|
+
"initials": "AA"
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"custom_fields_values": [
|
|
97
|
+
{
|
|
98
|
+
"id": "1000",
|
|
99
|
+
"custom_field_id": "1",
|
|
100
|
+
"name": "field name",
|
|
101
|
+
"value": "content",
|
|
102
|
+
"options": "",
|
|
103
|
+
"type_name": "Text"
|
|
104
|
+
}
|
|
105
|
+
],
|
|
106
|
+
"due_at": "2025-01-01T00:00:00.000+01:00",
|
|
107
|
+
"origin": "api",
|
|
108
|
+
"incidents": [{ "id": "100", "href": "https://mydomain.com/incidents/123"}],
|
|
109
|
+
"problems": [{ "id": "100", "href": "https://mydomain.com/problems/123"}],
|
|
110
|
+
"changes": [{ "id": "100", "href": "https://mydomain.com/changes/123"}],
|
|
111
|
+
"solutions": [{ "id": "100", "href": "https://mydomain.com/solutions/123"}],
|
|
112
|
+
"releases": [{ "id": "100", "href": "https://mydomain.com/releases/123"}],
|
|
113
|
+
"configuration_items": [{ "id": "100", "href": "https://mydomain.com/configuration_items/123"}]
|
|
114
|
+
}
|
|
115
|
+
},
|
|
116
|
+
"xml": {
|
|
117
|
+
"description": "shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719",
|
|
118
|
+
"xml": "<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
@@ -2,21 +2,103 @@
|
|
|
2
2
|
"components": {
|
|
3
3
|
"schemas": {
|
|
4
4
|
"incident": {
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
"
|
|
8
|
-
"
|
|
9
|
-
|
|
10
|
-
"
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
5
|
+
"request": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"incident": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"name": { "type": "string" },
|
|
12
|
+
"site_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
|
|
13
|
+
"department_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
|
|
14
|
+
"description": { "type": "string" },
|
|
15
|
+
"state_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
|
|
16
|
+
"assignee": { "$ref": "../components.json#/components/schemas/association_by_email" },
|
|
17
|
+
"assignee_id": { "$ref": "../components.json#/components/schemas/association_by_id" },
|
|
18
|
+
"priority": { "$ref": "../components.json#/components/schemas/association_by_id" },
|
|
19
|
+
"requester": { "$ref": "../components.json#/components/schemas/association_by_email" },
|
|
20
|
+
"category": { "$ref": "../components.json#/components/schemas/association_by_name" },
|
|
21
|
+
"subcategory": { "$ref": "../components.json#/components/schemas/association_by_name" },
|
|
22
|
+
"due_at": { "type": "string" },
|
|
23
|
+
"add_to_tag_list": { "type": "string" },
|
|
24
|
+
"custom_field_values": { "$ref": "../components.json#/components/schemas/custom_field_values" },
|
|
25
|
+
"incidents": { "$ref": "../components.json#/components/schemas/numbers_array" },
|
|
26
|
+
"solutions": { "$ref": "../components.json#/components/schemas/numbers_array" },
|
|
27
|
+
"changes": { "$ref": "../components.json#/components/schemas/numbers_array" },
|
|
28
|
+
"problems": { "$ref": "../components.json#/components/schemas/numbers_array" },
|
|
29
|
+
"releases": { "$ref": "../components.json#/components/schemas/numbers_array" },
|
|
30
|
+
"configuration_item_ids": { "$ref": "../components.json#/components/schemas/ids_array" }
|
|
31
|
+
}
|
|
18
32
|
}
|
|
19
33
|
}
|
|
34
|
+
},
|
|
35
|
+
"response": {
|
|
36
|
+
"type": "object",
|
|
37
|
+
"properties": {
|
|
38
|
+
"incident": {
|
|
39
|
+
"type": "object",
|
|
40
|
+
"properties": {
|
|
41
|
+
"id": { "$ref": "../components.json#/components/schemas/id" },
|
|
42
|
+
"name": { "type": "string" },
|
|
43
|
+
"description": { "type": "string" },
|
|
44
|
+
"site": { "$ref": "../components.json#/components/schemas/site_response" },
|
|
45
|
+
"department": { "$ref": "../components.json#/components/schemas/department_response" },
|
|
46
|
+
"state": { "type": "string" },
|
|
47
|
+
"priority": { "type": "string" },
|
|
48
|
+
"assignee": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
|
|
49
|
+
"requester": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
|
|
50
|
+
"category": { "$ref": "../components.json#/components/schemas/category_subcategory" },
|
|
51
|
+
"subcategory": { "$ref": "../components.json#/components/schemas/category_subcategory" },
|
|
52
|
+
"due_at": { "type": "string" },
|
|
53
|
+
"custom_field_values": { "$ref": "../components.json#/components/schemas/custom_field_values" },
|
|
54
|
+
"created_by": { "$ref": "../components.json#/components/schemas/requester_assignee_details" },
|
|
55
|
+
"origin": { "type": "string" },
|
|
56
|
+
"incidents": { "$ref": "../components.json#/components/schemas/response_attachments" },
|
|
57
|
+
"solutions": { "$ref": "../components.json#/components/schemas/response_attachments" },
|
|
58
|
+
"changes": { "$ref": "../components.json#/components/schemas/response_attachments" },
|
|
59
|
+
"problems": { "$ref": "../components.json#/components/schemas/response_attachments" },
|
|
60
|
+
"releases": { "$ref": "../components.json#/components/schemas/response_attachments" },
|
|
61
|
+
"configuration_item_ids": { "$ref": "../components.json#/components/schemas/response_attachments" }
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"incidents": {
|
|
68
|
+
"description": "List of incidents",
|
|
69
|
+
"type": "array",
|
|
70
|
+
"items": {
|
|
71
|
+
"allOf": [{ "$ref": "incident.json#/components/schemas/incident/response" }]
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
"incident_request_content": {
|
|
75
|
+
"application/json": {
|
|
76
|
+
"schema": { "$ref": "incident.json#/components/schemas/incident/request" },
|
|
77
|
+
"example": { "$ref": "../examples/incident.json#/examples/request/json" }
|
|
78
|
+
},
|
|
79
|
+
"application/xml": {
|
|
80
|
+
"schema": { "$ref": "incident.json#/components/schemas/incident/request" },
|
|
81
|
+
"example": { "$ref": "../examples/incident.json#/examples/request/xml" }
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"many_incidents_content": {
|
|
85
|
+
"application/json": {
|
|
86
|
+
"schema": { "$ref": "incident.json#/components/schemas/incidents" },
|
|
87
|
+
"example": [{ "$ref": "../examples/incident.json#/examples/response/json" }]
|
|
88
|
+
},
|
|
89
|
+
"application/xml": {
|
|
90
|
+
"schema": { "$ref": "incident.json#/components/schemas/incidents" },
|
|
91
|
+
"example": [{ "$ref": "../examples/incident.json#/examples/response/xml" }]
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
"incident_response_content": {
|
|
95
|
+
"application/json": {
|
|
96
|
+
"schema": { "$ref": "incident.json#/components/schemas/incident/response" },
|
|
97
|
+
"example": { "$ref": "../examples/incident.json#/examples/response/json" }
|
|
98
|
+
},
|
|
99
|
+
"application/xml": {
|
|
100
|
+
"schema": { "$ref": "incident.json#/components/schemas/incident/response" },
|
|
101
|
+
"example": { "$ref": "../examples/incident.json#/examples/response/xml" }
|
|
20
102
|
}
|
|
21
103
|
}
|
|
22
104
|
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "SolarWinds ITSM API",
|
|
5
5
|
"description": "All SolarWinds ITSM API definitions",
|
|
6
|
-
"version": "0.0.
|
|
6
|
+
"version": "0.0.9",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "API Support",
|
|
9
9
|
"url": "samanage.com/support",
|
|
@@ -15,6 +15,13 @@
|
|
|
15
15
|
{ "url": "https://apieu.samanage.com" }
|
|
16
16
|
],
|
|
17
17
|
"paths": {
|
|
18
|
-
"/incidents/{id}": { "$ref": "paths/incidents/incident_by_id.json" }
|
|
19
|
-
|
|
18
|
+
"/incidents/{id}": { "$ref": "paths/incidents/incident_by_id.json" },
|
|
19
|
+
"/incidents": { "$ref": "paths/incidents/incidents.json" }
|
|
20
|
+
},
|
|
21
|
+
"tags": [
|
|
22
|
+
{
|
|
23
|
+
"name": "Incident",
|
|
24
|
+
"description": "Incident operations"
|
|
25
|
+
}
|
|
26
|
+
]
|
|
20
27
|
}
|
|
@@ -2,18 +2,25 @@
|
|
|
2
2
|
"get": {
|
|
3
3
|
"operationId": "getIncidentById",
|
|
4
4
|
"description": "Get incident",
|
|
5
|
+
"tags": ["Incident"],
|
|
5
6
|
"parameters": [
|
|
6
7
|
{ "$ref": "../../common/components.json#/components/parameters/token_param" },
|
|
7
8
|
{ "$ref": "../../common/components.json#/components/parameters/id_param" }
|
|
8
9
|
],
|
|
9
10
|
"responses": {
|
|
10
|
-
"200": {
|
|
11
|
-
|
|
11
|
+
"200": {
|
|
12
|
+
"description": "Object was returned correctly",
|
|
13
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
|
|
14
|
+
},
|
|
15
|
+
"400": { "description": "Bad request" },
|
|
16
|
+
"404": { "description": "Not found" },
|
|
17
|
+
"500": { "description": "Internal Server Error" }
|
|
12
18
|
}
|
|
13
19
|
},
|
|
14
20
|
"put": {
|
|
15
21
|
"operationId": "updateIncidentById",
|
|
16
22
|
"description": "Update incident with specified fields",
|
|
23
|
+
"tags": ["Incident"],
|
|
17
24
|
"parameters": [
|
|
18
25
|
{ "$ref": "../../common/components.json#/components/parameters/token_param" },
|
|
19
26
|
{ "$ref": "../../common/components.json#/components/parameters/id_param" }
|
|
@@ -21,24 +28,38 @@
|
|
|
21
28
|
"requestBody": {
|
|
22
29
|
"required": true,
|
|
23
30
|
"description": "Incident fields to update",
|
|
24
|
-
"content": {
|
|
25
|
-
"application/json": {
|
|
26
|
-
"schema": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident" },
|
|
27
|
-
"example": {
|
|
28
|
-
"value": "{\"incident\":{\"site\":{\"name\":\"SITE NAME\"},\"department_id\":DEPARTMENT-ID,\"description\":\"SOME DESCRIPTION\",\"state\":\"STATE NAME\",\"assignee\":{\"email\":\"EMAIL\"}}}"
|
|
29
|
-
}
|
|
30
|
-
},
|
|
31
|
-
"application/xml": {
|
|
32
|
-
"schema": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident" },
|
|
33
|
-
"example": {
|
|
34
|
-
"value": "<incident><site><name>SITE NAME</name></site><department_id>DEPARTMENT-ID</department_id><description>SOME DESCRIPTION</description><state>STATE NAME</state><assignee><email>EMAIL</email></assignee></incident>"
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
}
|
|
31
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_request_content" }
|
|
38
32
|
},
|
|
39
33
|
"responses": {
|
|
40
|
-
"200": {
|
|
41
|
-
|
|
34
|
+
"200": {
|
|
35
|
+
"description": "Object was updated correctly",
|
|
36
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
|
|
37
|
+
},
|
|
38
|
+
"400": { "description": "Bad request" },
|
|
39
|
+
"404": { "description": "Not found" },
|
|
40
|
+
"500": { "description": "Internal Server Error" }
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"delete": {
|
|
44
|
+
"operationId": "deleteIncidentById",
|
|
45
|
+
"description": "Delete incident",
|
|
46
|
+
"tags": ["Incident"],
|
|
47
|
+
"parameters": [
|
|
48
|
+
{ "$ref": "../../common/components.json#/components/parameters/token_param" },
|
|
49
|
+
{ "$ref": "../../common/components.json#/components/parameters/id_param" }
|
|
50
|
+
],
|
|
51
|
+
"responses": {
|
|
52
|
+
"200": {
|
|
53
|
+
"description": "Object was returned correctly",
|
|
54
|
+
"content": {
|
|
55
|
+
"application/json": {
|
|
56
|
+
"example": { "deleted_ids": ["1"] }
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"400": { "description": "Bad request" },
|
|
61
|
+
"404": { "description": "Not found" },
|
|
62
|
+
"500": { "description": "Internal Server Error" }
|
|
42
63
|
}
|
|
43
64
|
}
|
|
44
65
|
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"get": {
|
|
3
|
+
"operationId": "getIncidents",
|
|
4
|
+
"description": "List of incidents",
|
|
5
|
+
"tags": ["Incident"],
|
|
6
|
+
"parameters": [
|
|
7
|
+
{ "$ref": "../../common/components.json#/components/parameters/token_param" }
|
|
8
|
+
],
|
|
9
|
+
"responses": {
|
|
10
|
+
"200": {
|
|
11
|
+
"description": "Object was returned correctly",
|
|
12
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/many_incidents_content" }
|
|
13
|
+
},
|
|
14
|
+
"400": { "description": "Bad request" },
|
|
15
|
+
"404": { "description": "Not found" },
|
|
16
|
+
"500": { "description": "Server error" }
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"post": {
|
|
20
|
+
"operationId": "createIncident",
|
|
21
|
+
"description": "Create new incident",
|
|
22
|
+
"tags": ["Incident"],
|
|
23
|
+
"parameters": [
|
|
24
|
+
{ "$ref": "../../common/components.json#/components/parameters/token_param" }
|
|
25
|
+
],
|
|
26
|
+
"requestBody": {
|
|
27
|
+
"required": true,
|
|
28
|
+
"description": "Incident fields to fill",
|
|
29
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_request_content" }
|
|
30
|
+
},
|
|
31
|
+
"responses": {
|
|
32
|
+
"200": {
|
|
33
|
+
"description": "Object created and returned correctly",
|
|
34
|
+
"content": { "$ref": "../../common/schemas/incident.json#/components/schemas/incident_response_content" }
|
|
35
|
+
},
|
|
36
|
+
"400": { "description": "Bad request" },
|
|
37
|
+
"500": { "description": "Server error" }
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.0.4","contact":{"name":"API Support","url":"samanage.com/support","email":"support@samanage.com"}},"servers":[{"url":"https://api.samanage.com"},{"url":"https://apieu.samanage.com"}],"paths":{"/incidents/{id}":{"get":{"operationId":"getIncidentById","description":"Get incident","parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"oneOf":[{"type":"string"},{"type":"integer"}]},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly"},"404":{"description":"Not found"}}},"put":{"operationId":"updateIncidentById","description":"Update incident with specified fields","parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"oneOf":[{"type":"string"},{"type":"integer"}]},"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":{"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state":{"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"}]}}}}},"example":{"value":"{\"incident\":{\"site\":{\"name\":\"SITE NAME\"},\"department_id\":DEPARTMENT-ID,\"description\":\"SOME DESCRIPTION\",\"state\":\"STATE NAME\",\"assignee\":{\"email\":\"EMAIL\"}}}"}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"site":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state":{"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"}]}}}}},"example":{"value":"<incident><site><name>SITE NAME</name></site><department_id>DEPARTMENT-ID</department_id><description>SOME DESCRIPTION</description><state>STATE NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"responses":{"200":{"description":"Object was updated correctly"},"404":{"description":"Not found"}}}}}}
|
|
1
|
+
{"openapi":"3.0.1","info":{"title":"SolarWinds ITSM API","description":"All SolarWinds ITSM API definitions","version":"0.0.9","contact":{"name":"API Support","url":"samanage.com/support","email":"support@samanage.com"}},"servers":[{"url":"https://api.samanage.com"},{"url":"https://apieu.samanage.com"}],"paths":{"/incidents/{id}":{"get":{"operationId":"getIncidentById","description":"Get incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"put":{"operationId":"updateIncidentById","description":"Update incident with specified fields","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"requestBody":{"required":true,"description":"Incident fields to update","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"responses":{"200":{"description":"Object was updated correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}},"delete":{"operationId":"deleteIncidentById","description":"Delete incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"},{"name":"id","in":"path","schema":{"type":"string"},"required":true,"description":"Numeric ID of the object to get or update"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"example":{"deleted_ids":["1"]}}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Internal Server Error"}}}},"/incidents":{"get":{"operationId":"getIncidents","description":"List of incidents","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"responses":{"200":{"description":"Object was returned correctly","content":{"application/json":{"schema":{"description":"List of incidents","type":"array","items":{"allOf":[{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}]}},"example":[{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}]},"application/xml":{"schema":{"description":"List of incidents","type":"array","items":{"allOf":[{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}}]}},"example":[{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}]}}},"400":{"description":"Bad request"},"404":{"description":"Not found"},"500":{"description":"Server error"}}},"post":{"operationId":"createIncident","description":"Create new incident","tags":["Incident"],"parameters":[{"name":"X-Samanage-Authorization","in":"header","schema":{"type":"string"},"example":"Bearer TOKEN"}],"requestBody":{"required":true,"description":"Incident fields to fill","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"incident":{"name":"Incident Name","site_id":1,"department_id":1,"description":"description","state_id":1,"assignee":{"email":"john.doe@email.com"},"requester":{"email":"john.doe@email.com"},"priority":"High","category":{"name":"Facilities"},"subcategory":{"name":"Equipment"},"due_at":"Jan 01,2025","add_to_tag_list":"tag1, tag2","custom_fields_values":{"custom_fields_value":[{"name":"field name","value":"content"}]},"incidents":[{"number":"100"}],"problems":[{"number":"100"}],"changes":[{"number":"100"}],"solutions":[{"number":"100"}],"releases":[{"number":"100"}],"configuration_item_ids":["100"]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"name":{"type":"string"},"site_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"department_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"description":{"type":"string"},"state_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"assignee":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"assignee_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"priority":{"oneOf":[{"type":"string"},{"type":"integer"}]},"requester":{"type":"object","oneOf":[{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}},{"enum":["nil","",null]}]},"category":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"subcategory":{"type":"object","oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}},{"enum":["nil","",null]}]},"due_at":{"type":"string"},"add_to_tag_list":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"incidents":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"changes":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"problems":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"releases":{"type":"array","items":{"type":"object","properties":{"number":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}},"configuration_item_ids":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"integer"}]}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"responses":{"200":{"description":"Object created and returned correctly","content":{"application/json":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"incident":{"id":"10000","number":"1000","name":"Incident Name","description":"description","state":"New","site":{"id":"1","name":"Austin TX, USA","location":"AUS","description":"","time_zone":""},"department":{"id":"1","name":"Support","description":"","default_assignee_id":"1"},"category":{"id":"10000","name":"Facilities","default_tags":"tagA, tagB","parent_id":"null","default_assignee_id":"1"},"subcategory":{"id":"1000","name":"Equipment","default_tags":"","parent_id":"10000","default_assignee_id":"1"},"priority":"High","assignee":{"group_id":"1","is_user":"true","id":"1","name":"Jogn Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"requester":{"group_id":"1","is_user":"true","id":"1","name":"John Doe","email":"john.doe@email.com","avatar":{"type":"initials","color":"#fd4165","initials":"AA"}},"custom_fields_values":[{"id":"1000","custom_field_id":"1","name":"field name","value":"content","options":"","type_name":"Text"}],"due_at":"2025-01-01T00:00:00.000+01:00","origin":"api","incidents":[{"id":"100","href":"https://mydomain.com/incidents/123"}],"problems":[{"id":"100","href":"https://mydomain.com/problems/123"}],"changes":[{"id":"100","href":"https://mydomain.com/changes/123"}],"solutions":[{"id":"100","href":"https://mydomain.com/solutions/123"}],"releases":[{"id":"100","href":"https://mydomain.com/releases/123"}],"configuration_items":[{"id":"100","href":"https://mydomain.com/configuration_items/123"}]}}},"application/xml":{"schema":{"type":"object","properties":{"incident":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"site":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"location":{"type":"string"},"timezone":{"type":"string"}}},"department":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"description":{"type":"string"},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"state":{"type":"string"},"priority":{"type":"string"},"assignee":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"requester":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"category":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"subcategory":{"type":"object","properties":{"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"default_tags":{"type":"string"},"parent_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"default_assignee_id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]}}},"due_at":{"type":"string"},"custom_field_values":{"type":"object","oneOf":[{"type":"object","required":["custom_field_value"],"properties":{"custom_field_value":{"type":"array","items":{"allOf":[{"type":"object","oneOf":[{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}]}]}}}}]},"created_by":{"type":"object","properties":{"group_id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"is_user":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"id":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"integer"}]},"name":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"object","properties":{"type":{"type":"string"},"color":{"type":"string"},"initials":{"type":"string","minLength":2,"maxLength":2}}}}},"origin":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"solutions":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"changes":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"problems":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"releases":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}},"configuration_item_ids":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"integer"}]},"href":{"type":"string"}}}}}}}},"example":{"description":"shouldn't work due to bug in openApi - https://github.com/springdoc/springdoc-openapi/issues/719","xml":"<incident><site><name>NAME</name></site><department_id>0</department_id><description>DESCRIPTION</description><state>NAME</state><assignee><email>EMAIL</email></assignee></incident>"}}}},"400":{"description":"Bad request"},"500":{"description":"Server error"}}}}},"tags":[{"name":"Incident","description":"Incident operations"}]}
|
metadata
CHANGED
|
@@ -1,33 +1,38 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: solarwinds-itsm-api-definitions
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jonathan Goldstein
|
|
8
8
|
- Darth Vader
|
|
9
|
-
|
|
9
|
+
- Sagi Gold
|
|
10
|
+
autorequire:
|
|
10
11
|
bindir: bin
|
|
11
12
|
cert_chain: []
|
|
12
|
-
date: 2020-
|
|
13
|
+
date: 2020-12-03 00:00:00.000000000 Z
|
|
13
14
|
dependencies: []
|
|
14
15
|
description: SolarWinds ITSM OpenAPI definitions gem
|
|
15
|
-
email:
|
|
16
|
+
email:
|
|
17
|
+
- jonsgold@gmail.com
|
|
18
|
+
- sagi.gold@solarwinds.com
|
|
16
19
|
executables: []
|
|
17
20
|
extensions: []
|
|
18
21
|
extra_rdoc_files: []
|
|
19
22
|
files:
|
|
20
23
|
- lib/definitions/common/components.json
|
|
24
|
+
- lib/definitions/common/examples/incident.json
|
|
21
25
|
- lib/definitions/common/schemas/incident.json
|
|
22
26
|
- lib/definitions/openapi.json
|
|
23
27
|
- lib/definitions/paths/incidents/incident_by_id.json
|
|
28
|
+
- lib/definitions/paths/incidents/incidents.json
|
|
24
29
|
- lib/resolved_schema/resolved_schema.json
|
|
25
30
|
- lib/solarwinds/itsm/api/definitions.rb
|
|
26
31
|
homepage: https://rubygems.org/gems/solarwinds-itsm-api-definitions
|
|
27
32
|
licenses:
|
|
28
33
|
- MIT
|
|
29
34
|
metadata: {}
|
|
30
|
-
post_install_message:
|
|
35
|
+
post_install_message:
|
|
31
36
|
rdoc_options: []
|
|
32
37
|
require_paths:
|
|
33
38
|
- lib
|
|
@@ -42,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
42
47
|
- !ruby/object:Gem::Version
|
|
43
48
|
version: '0'
|
|
44
49
|
requirements: []
|
|
45
|
-
rubygems_version: 3.0.
|
|
46
|
-
signing_key:
|
|
50
|
+
rubygems_version: 3.0.8
|
|
51
|
+
signing_key:
|
|
47
52
|
specification_version: 4
|
|
48
53
|
summary: OpenAPI definitions
|
|
49
54
|
test_files: []
|