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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 311db7b1987f9e6263413e067baf752411404832e14780d726b0dadf49cd65e0
|
|
4
|
+
data.tar.gz: 5243363f8fec50522fbb1503a135252ee99f2dd337ab1adbb9be3d09d822b9d1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '09f8437c37b007a7cc6ed244fde07cefbe49208718a52e8c7d91d2cc96cc6f8bf30c1edbeb37903623d9b8e2f8a6e613c6650bf51ca513e19f376e5ae60d4e72'
|
|
7
|
+
data.tar.gz: 90f7d3fc27b93dd220e504fb1bc5d4b1b21a810658f64e3132f750151ffae57c811379d54c596aa6e13107797c9f1a1bf0f63b13b11644dbf6a8085c53e2b299
|
|
@@ -14,6 +14,14 @@
|
|
|
14
14
|
"schema": { "type": "string" },
|
|
15
15
|
"required": true,
|
|
16
16
|
"description": "Numeric ID of the object to get or update"
|
|
17
|
+
},
|
|
18
|
+
"object_param": {
|
|
19
|
+
"name": "object_type",
|
|
20
|
+
"in": "path",
|
|
21
|
+
"schema": { "type": "string" },
|
|
22
|
+
"required": true,
|
|
23
|
+
"description": "Source object type",
|
|
24
|
+
"example": "incidents"
|
|
17
25
|
}
|
|
18
26
|
},
|
|
19
27
|
"schemas": {
|
|
@@ -23,7 +31,7 @@
|
|
|
23
31
|
"type": "object",
|
|
24
32
|
"required": ["name"],
|
|
25
33
|
"properties": {
|
|
26
|
-
"name": { "type": "string" }
|
|
34
|
+
"name": { "type": "string", "example": "Object Name" }
|
|
27
35
|
}
|
|
28
36
|
},
|
|
29
37
|
{ "enum": ["nil", "", null] }]
|
|
@@ -34,49 +42,140 @@
|
|
|
34
42
|
"type": "object",
|
|
35
43
|
"required": ["email"],
|
|
36
44
|
"properties": {
|
|
37
|
-
"email": {
|
|
45
|
+
"email": {
|
|
46
|
+
"type": "string",
|
|
47
|
+
"format": "email",
|
|
48
|
+
"example": "john.doe@email.com"
|
|
49
|
+
}
|
|
38
50
|
}
|
|
39
51
|
},
|
|
40
52
|
{ "enum": ["nil", "", null] }]
|
|
41
53
|
},
|
|
42
|
-
"
|
|
43
|
-
"
|
|
44
|
-
|
|
45
|
-
"
|
|
46
|
-
|
|
47
|
-
"number": {
|
|
48
|
-
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
}
|
|
54
|
+
"attachment_numbers": {
|
|
55
|
+
"anyOf": [
|
|
56
|
+
{ "$ref": "components.json#/components/request/schemas/numbers_array" },
|
|
57
|
+
{ "$ref": "components.json#/components/request/schemas/number_property" }
|
|
58
|
+
]
|
|
52
59
|
},
|
|
53
|
-
"
|
|
60
|
+
"number_property": {
|
|
54
61
|
"type": "object",
|
|
55
|
-
"required": ["name", "value"],
|
|
56
62
|
"properties": {
|
|
57
|
-
"
|
|
58
|
-
"value": { "type": "string" }
|
|
63
|
+
"number": { "anyOf": [ { "type": "string", "example": "1" }, { "type": "integer", "example": 1 }] }
|
|
59
64
|
}
|
|
60
65
|
},
|
|
61
|
-
"
|
|
66
|
+
"numbers_array": {
|
|
62
67
|
"type": "array",
|
|
63
|
-
"items": { "$ref": "components.json#/components/request/schemas/
|
|
68
|
+
"items": { "$ref": "components.json#/components/request/schemas/number_property" }
|
|
69
|
+
},
|
|
70
|
+
"value_of_custom_field": {
|
|
71
|
+
"anyOf":[
|
|
72
|
+
{ "type": "string", "example": "content" }, { "type": "integer", "example": 1 }, { "type": "null" },
|
|
73
|
+
{ "content": { "application/octet-stream": {} }, "description": "attachment custom field" }
|
|
74
|
+
]
|
|
64
75
|
},
|
|
65
|
-
"
|
|
76
|
+
"custom_field": {
|
|
66
77
|
"type": "object",
|
|
67
|
-
"required": ["
|
|
78
|
+
"required": ["name"],
|
|
68
79
|
"properties": {
|
|
69
|
-
"
|
|
80
|
+
"name": { "type": "string", "example": "Name of custom text field" },
|
|
81
|
+
"value": { "$ref": "components.json#/components/request/schemas/value_of_custom_field" },
|
|
82
|
+
"user_value": { "$ref": "components.json#/components/request/schemas/association_by_email" }
|
|
70
83
|
}
|
|
71
84
|
},
|
|
72
85
|
"custom_fields_value": {
|
|
73
|
-
"
|
|
74
|
-
|
|
86
|
+
"anyOf": [
|
|
87
|
+
{ "type": "array", "items": { "$ref": "components.json#/components/request/schemas/custom_field" } },
|
|
88
|
+
{ "$ref": "components.json#/components/request/schemas/custom_field" }
|
|
89
|
+
]
|
|
75
90
|
},
|
|
76
91
|
"custom_fields_values": {
|
|
77
92
|
"type": "object",
|
|
78
93
|
"required": ["custom_fields_value"],
|
|
79
94
|
"properties": { "custom_fields_value": { "$ref": "components.json#/components/request/schemas/custom_fields_value" } }
|
|
95
|
+
},
|
|
96
|
+
"custom_field_by_id": {
|
|
97
|
+
"type": "object",
|
|
98
|
+
"properties": {
|
|
99
|
+
"id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
100
|
+
"custom_field_id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
101
|
+
"value": { "$ref": "components.json#/components/request/schemas/value_of_custom_field" }
|
|
102
|
+
}
|
|
103
|
+
},
|
|
104
|
+
"custom_fields_values_attributes": {
|
|
105
|
+
"anyOf": [
|
|
106
|
+
{ "type": "array", "items": { "$ref": "components.json#/components/request/schemas/custom_field_by_id" } },
|
|
107
|
+
{ "type": "object", "items": { "$ref": "components.json#/components/request/schemas/custom_field_by_id" } }
|
|
108
|
+
]
|
|
109
|
+
},
|
|
110
|
+
"approval_levels_attributes": {
|
|
111
|
+
"anyOf": [
|
|
112
|
+
{ "type": "array", "items": { "$ref": "components.json#/components/request/schemas/approval_level" } },
|
|
113
|
+
{ "type": "object", "items": { "$ref": "components.json#/components/request/schemas/approval_level" } }
|
|
114
|
+
]
|
|
115
|
+
},
|
|
116
|
+
"approval_level": {
|
|
117
|
+
"type": "object",
|
|
118
|
+
"properties": {
|
|
119
|
+
"id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
120
|
+
"approver_ids": { "type": "string", "example": "1, 2" },
|
|
121
|
+
"approval_condition": { "type": "string", "example": "1" }
|
|
122
|
+
}
|
|
123
|
+
},
|
|
124
|
+
"bio": {
|
|
125
|
+
"type": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"manufacturer": { "type": "string", "example": "Dell" },
|
|
128
|
+
"ssn": { "anyOf": [{ "type": "string", "example": "1" },{ "type": "integer", "example": 1 }] },
|
|
129
|
+
"model": { "type": "string", "example": "model description" },
|
|
130
|
+
"version": { "anyOf": [{ "type": "string", "example": "1" },{ "type": "integer", "example": 1 }] },
|
|
131
|
+
"bios_date": { "type": "string", "example": "2020-01-01 00:00" }
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"variable": {
|
|
135
|
+
"type": "object",
|
|
136
|
+
"required": ["name"],
|
|
137
|
+
"properties": {
|
|
138
|
+
"name": { "type": "string", "example": "Variable name" },
|
|
139
|
+
"value": { "type": "string", "example": "Content" },
|
|
140
|
+
"user_value": { "$ref": "components.json#/components/request/schemas/association_by_email" }
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"cc_array": {
|
|
144
|
+
"type": "array",
|
|
145
|
+
"items": { "type": "string", "format": "email", "example": "john.doe@email.com" },
|
|
146
|
+
"xml": { "wrapped": true },
|
|
147
|
+
"description": "for xml requests, please add: type=\"array\". for example: \"\\<cc type='array'\\> \\<cc\\>john.doe@email.com\\<\/cc\\> \\<\/cc\\>\""
|
|
148
|
+
},
|
|
149
|
+
"reports_to": {
|
|
150
|
+
"oneOf": [
|
|
151
|
+
{
|
|
152
|
+
"type": "object",
|
|
153
|
+
"required": ["id"],
|
|
154
|
+
"properties": { "id": { "$ref": "components.json#/components/common/schemas/association_by_id" } }
|
|
155
|
+
},
|
|
156
|
+
{ "$ref": "components.json#/components/request/schemas/association_by_email" }
|
|
157
|
+
]
|
|
158
|
+
},
|
|
159
|
+
"purchase_order_items_attributes": {
|
|
160
|
+
"type": "array",
|
|
161
|
+
"items": { "$ref": "components.json#/components/request/schemas/purchase_order_items_attribute" }
|
|
162
|
+
},
|
|
163
|
+
"purchase_order_items_attribute": {
|
|
164
|
+
"type": "object",
|
|
165
|
+
"properties": {
|
|
166
|
+
"id": {
|
|
167
|
+
"$ref": "components.json#/components/common/schemas/association_by_id",
|
|
168
|
+
"description": "Required field for update operations"
|
|
169
|
+
},
|
|
170
|
+
"name": { "type": "string", "example": "Item Name" },
|
|
171
|
+
"description": { "type": "string", "example": "Item Decription" },
|
|
172
|
+
"serial_number": { "type": "string", "example": "XXXXX" },
|
|
173
|
+
"part_number": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
174
|
+
"price": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
175
|
+
"quantity": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
176
|
+
"discount": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
177
|
+
"tax": { "$ref": "components.json#/components/common/schemas/number_or_string" }
|
|
178
|
+
}
|
|
80
179
|
}
|
|
81
180
|
}
|
|
82
181
|
},
|
|
@@ -84,20 +183,19 @@
|
|
|
84
183
|
"schemas": {
|
|
85
184
|
"id": {
|
|
86
185
|
"readOnly": true,
|
|
87
|
-
"oneOf": [{ "type": "string" }, { "type": "integer" }]
|
|
186
|
+
"oneOf": [{ "type": "string", "example": "1" }, { "type": "integer", "example": 1 }]
|
|
88
187
|
},
|
|
89
188
|
"custom_field": {
|
|
90
189
|
"type": "object",
|
|
91
190
|
"properties": {
|
|
92
191
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
93
192
|
"custom_field_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
94
|
-
"name": { "type": "string" },
|
|
95
|
-
"value": { "type": "string" },
|
|
96
|
-
"
|
|
97
|
-
"type_name": { "type": "string" }
|
|
193
|
+
"name": { "type": "string", "example": " Name of custom text field" },
|
|
194
|
+
"value": { "type": "string", "example": "content" },
|
|
195
|
+
"type_name": { "type": "string", "example": "Text" }
|
|
98
196
|
}
|
|
99
197
|
},
|
|
100
|
-
"
|
|
198
|
+
"custom_fields_values": {
|
|
101
199
|
"type": "array",
|
|
102
200
|
"items": { "$ref": "components.json#/components/response/schemas/custom_field" }
|
|
103
201
|
},
|
|
@@ -105,8 +203,8 @@
|
|
|
105
203
|
"type": "object",
|
|
106
204
|
"properties": {
|
|
107
205
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
108
|
-
"name": { "type": "string" },
|
|
109
|
-
"default_tags": { "type": "string" },
|
|
206
|
+
"name": { "type": "string", "example": "Category / Subcategory name" },
|
|
207
|
+
"default_tags": { "type": "string", "example": "tag1, tag2" },
|
|
110
208
|
"parent_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
111
209
|
"default_assignee_id": { "$ref": "components.json#/components/response/schemas/id" }
|
|
112
210
|
}
|
|
@@ -114,35 +212,36 @@
|
|
|
114
212
|
"avatar": {
|
|
115
213
|
"type": "object",
|
|
116
214
|
"properties": {
|
|
117
|
-
"type": { "type": "string" },
|
|
118
|
-
"color": { "type": "string" },
|
|
215
|
+
"type": { "type": "string", "example": "initials" },
|
|
216
|
+
"color": { "type": "string", "example": "#1000" },
|
|
119
217
|
"initials": {
|
|
120
218
|
"type": "string",
|
|
121
219
|
"minLength": 2,
|
|
122
|
-
"maxLength": 2
|
|
220
|
+
"maxLength": 2,
|
|
221
|
+
"example": "JD"
|
|
123
222
|
}
|
|
124
223
|
}
|
|
125
224
|
},
|
|
126
|
-
"
|
|
225
|
+
"group_details": {
|
|
127
226
|
"type": "object",
|
|
128
227
|
"properties": {
|
|
129
228
|
"group_id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
130
|
-
"is_user": { "oneOf": [{ "type": "string" }, { "type": "boolean" }] },
|
|
229
|
+
"is_user": { "oneOf": [{ "type": "string", "example": "true" }, { "type": "boolean" }] },
|
|
131
230
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
132
|
-
"name": { "type": "string" },
|
|
133
|
-
"email": { "type": "string" },
|
|
231
|
+
"name": { "type": "string", "example": "John Doe" },
|
|
232
|
+
"email": { "type": "string", "example": "john.doe@email.com" },
|
|
134
233
|
"avatar": { "$ref": "components.json#/components/response/schemas/avatar" }
|
|
135
234
|
}
|
|
136
235
|
},
|
|
137
|
-
"
|
|
236
|
+
"user_details": {
|
|
138
237
|
"type": "object",
|
|
139
238
|
"properties": {
|
|
140
239
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
141
240
|
"account_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
142
241
|
"user_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
143
|
-
"email": { "type": "string" },
|
|
144
|
-
"name": { "type": "string" },
|
|
145
|
-
"disabled": { "type": "boolean" },
|
|
242
|
+
"email": { "type": "string", "example": "john.doe@email.com" },
|
|
243
|
+
"name": { "type": "string", "example": "John Doe" },
|
|
244
|
+
"disabled": { "type": "boolean", "example": false },
|
|
146
245
|
"avatar": { "$ref": "components.json#/components/response/schemas/avatar" }
|
|
147
246
|
}
|
|
148
247
|
},
|
|
@@ -150,18 +249,18 @@
|
|
|
150
249
|
"type": "object",
|
|
151
250
|
"properties": {
|
|
152
251
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
153
|
-
"name": { "type": "string" },
|
|
154
|
-
"description": { "type": "string" },
|
|
155
|
-
"location": { "type": "string" },
|
|
156
|
-
"timezone": { "type": "string" }
|
|
252
|
+
"name": { "type": "string", "example": "Austin TX, USA" },
|
|
253
|
+
"description": { "type": "string", "example": "AUS" },
|
|
254
|
+
"location": { "type": "string", "example": "AUS" },
|
|
255
|
+
"timezone": { "type": "string", "example": "UTC-6h" }
|
|
157
256
|
}
|
|
158
257
|
},
|
|
159
258
|
"department_response": {
|
|
160
259
|
"type": "object",
|
|
161
260
|
"properties": {
|
|
162
261
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
163
|
-
"name": { "type": "string" },
|
|
164
|
-
"description": { "type": "string" },
|
|
262
|
+
"name": { "type": "string", "example": "Support" },
|
|
263
|
+
"description": { "type": "string", "example": "Support Department" },
|
|
165
264
|
"default_assignee_id": { "$ref": "components.json#/components/response/schemas/id" }
|
|
166
265
|
}
|
|
167
266
|
},
|
|
@@ -171,7 +270,7 @@
|
|
|
171
270
|
"type": "object",
|
|
172
271
|
"properties": {
|
|
173
272
|
"id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
174
|
-
"href": { "type": "string" }
|
|
273
|
+
"href": { "type": "string", "example": "https://mydomain.com/object_type/1" }
|
|
175
274
|
}
|
|
176
275
|
}
|
|
177
276
|
},
|
|
@@ -179,10 +278,136 @@
|
|
|
179
278
|
"type": "object",
|
|
180
279
|
"properties": {
|
|
181
280
|
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
182
|
-
"name": { "type": "string" },
|
|
183
|
-
"description": { "type": "string" },
|
|
184
|
-
"portal": { "type": "boolean" },
|
|
185
|
-
"show_my_tasks": { "type": "boolean" }
|
|
281
|
+
"name": { "type": "string", "example": "Requester" },
|
|
282
|
+
"description": { "type": "string", "example": "Requester role" },
|
|
283
|
+
"portal": { "type": "boolean", "example": true },
|
|
284
|
+
"show_my_tasks": { "type": "boolean", "example": true }
|
|
285
|
+
}
|
|
286
|
+
},
|
|
287
|
+
"tag": {
|
|
288
|
+
"type": "object",
|
|
289
|
+
"properties": {
|
|
290
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
291
|
+
"name": { "type": "string", "example": "tag name" },
|
|
292
|
+
"taggings_count": { "type": "integer", "example": 1 }
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
"tags": {
|
|
296
|
+
"type": "array",
|
|
297
|
+
"items": { "$ref": "components.json#/components/response/schemas/tag" }
|
|
298
|
+
},
|
|
299
|
+
"approvers": {
|
|
300
|
+
"type": "array",
|
|
301
|
+
"items": { "$ref": "components.json#/components/response/schemas/group_details" }
|
|
302
|
+
},
|
|
303
|
+
"creator": {
|
|
304
|
+
"type": "object",
|
|
305
|
+
"properties": {
|
|
306
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
307
|
+
"name": { "type": "string", "example": "tag name" },
|
|
308
|
+
"email": { "type": "string", "format": "email", "example": "john.doe@email.com" }
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"ci_type": {
|
|
312
|
+
"type": "object",
|
|
313
|
+
"properties": {
|
|
314
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
315
|
+
"name": { "type": "string", "example": "Building" },
|
|
316
|
+
"description": { "type": "string", "example": "Configuration Item - Building" },
|
|
317
|
+
"parent_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
318
|
+
"custom": { "type": "boolean", "example": false },
|
|
319
|
+
"icon_name": { "type": "string", "example": "BUILDING" },
|
|
320
|
+
"updated_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" }
|
|
321
|
+
}
|
|
322
|
+
},
|
|
323
|
+
"bioses": {
|
|
324
|
+
"type": "array",
|
|
325
|
+
"items": {
|
|
326
|
+
"type": "object",
|
|
327
|
+
"properties": {
|
|
328
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
329
|
+
"manufacturer": { "type": "string", "example": "Dell" },
|
|
330
|
+
"ssn": { "type": "string", "example": "1" },
|
|
331
|
+
"model": { "type": "string", "example": "model description" },
|
|
332
|
+
"version": { "type": "string", "example": "1" },
|
|
333
|
+
"bios_date": { "type": "string", "example": "2020-01-01 00:00" },
|
|
334
|
+
"reported_at": { "type": "string", "example": "2020-01-01 00:00" }
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
},
|
|
338
|
+
"asset_type": {
|
|
339
|
+
"type": "object",
|
|
340
|
+
"properties": {
|
|
341
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
342
|
+
"account_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
343
|
+
"parent_id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
344
|
+
"name": { "type": "string", "example": "Asset Type" }
|
|
345
|
+
}
|
|
346
|
+
},
|
|
347
|
+
"vendor": {
|
|
348
|
+
"type": "object",
|
|
349
|
+
"properties": {
|
|
350
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
351
|
+
"name": { "type": "string", "example": "Google" },
|
|
352
|
+
"address": { "type": "string", "example": "address description" },
|
|
353
|
+
"country": { "type": "string", "example": "US" },
|
|
354
|
+
"city": { "type": "string", "example": "Texas" },
|
|
355
|
+
"zip": { "type": "string", "example": "1" },
|
|
356
|
+
"tech_support": { "type": "string", "example": "+000000000", "description": "support phone number" },
|
|
357
|
+
"business_phone": { "type": "string", "example": "+000000000", "description": "business phone" },
|
|
358
|
+
"url": { "type": "string", "example": "www.google.com" },
|
|
359
|
+
"created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" },
|
|
360
|
+
"updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" }
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"procurement_items": {
|
|
364
|
+
"type": "array",
|
|
365
|
+
"items": {
|
|
366
|
+
"type": "object",
|
|
367
|
+
"properties": {
|
|
368
|
+
"name": { "type": "string", "example": "Item Name" },
|
|
369
|
+
"version": { "type": "string", "example": "0.0.0" },
|
|
370
|
+
"quantity": { "type": "string", "example": "1" },
|
|
371
|
+
"notes": { "type": "string", "example": "Item notes" },
|
|
372
|
+
"created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" },
|
|
373
|
+
"updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" },
|
|
374
|
+
"tag": { "type": "string", "example": "example tag" }
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
},
|
|
378
|
+
"id_name_href": {
|
|
379
|
+
"type": "object",
|
|
380
|
+
"properties": {
|
|
381
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
382
|
+
"name": { "type": "string", "example": "Object Name" },
|
|
383
|
+
"href": { "type": "string", "example": "/objects/1" }
|
|
384
|
+
}
|
|
385
|
+
},
|
|
386
|
+
"parent_object": {
|
|
387
|
+
"type": "object",
|
|
388
|
+
"properties": {
|
|
389
|
+
"id": { "$ref": "components.json#/components/response/schemas/id" },
|
|
390
|
+
"class": { "type": "string", "example": "Incident" }
|
|
391
|
+
}
|
|
392
|
+
},
|
|
393
|
+
"purchase_order_items": {
|
|
394
|
+
"type": "array",
|
|
395
|
+
"items": { "$ref": "components.json#/components/response/schemas/purchase_order_item" }
|
|
396
|
+
},
|
|
397
|
+
"purchase_order_item": {
|
|
398
|
+
"type": "object",
|
|
399
|
+
"properties": {
|
|
400
|
+
"created_at": { "type": "string", "example": "2020-01-01T00:00:00.000+01:00" },
|
|
401
|
+
"updated_at": { "type": "string", "example": "2020-10-01T00:00:00.000+01:00" },
|
|
402
|
+
"id": { "$ref": "components.json#/components/common/schemas/association_by_id" },
|
|
403
|
+
"name": { "type": "string", "example": "Item Name" },
|
|
404
|
+
"description": { "type": "string", "example": "Item Decription" },
|
|
405
|
+
"serial_number": { "type": "string", "example": "XXXXX" },
|
|
406
|
+
"part_number": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
407
|
+
"price": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
408
|
+
"quantity": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
409
|
+
"discount": { "$ref": "components.json#/components/common/schemas/number_or_string" },
|
|
410
|
+
"tax": { "$ref": "components.json#/components/common/schemas/number_or_string" }
|
|
186
411
|
}
|
|
187
412
|
}
|
|
188
413
|
}
|
|
@@ -190,13 +415,18 @@
|
|
|
190
415
|
"common": {
|
|
191
416
|
"schemas": {
|
|
192
417
|
"association_by_id": {
|
|
193
|
-
"
|
|
418
|
+
"anyOf": [{ "type": "string", "example": "1" }, { "type": "integer", "example": 1 }]
|
|
194
419
|
},
|
|
195
420
|
"ids_array": {
|
|
196
421
|
"type": "array",
|
|
197
422
|
"items": {
|
|
198
|
-
|
|
199
|
-
}
|
|
423
|
+
"$ref": "components.json#/components/common/schemas/association_by_id"
|
|
424
|
+
},
|
|
425
|
+
"xml": { "wrapped": true },
|
|
426
|
+
"description": "for xml requests, please add: type=\"array\", for example: <incident_ids type=\"array\"><incident_id>1</incident_id></incident_ids>"
|
|
427
|
+
},
|
|
428
|
+
"number_or_string": {
|
|
429
|
+
"anyOf": [{ "type": "string", "example": "1" }, { "type": "integer", "example": 1 }]
|
|
200
430
|
}
|
|
201
431
|
}
|
|
202
432
|
}
|