solarwinds-itsm-api-definitions 0.2.5 → 0.2.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Redocly/development.html +57 -23
- data/Redocly/index.html +55 -23
- data/Redocly/redoc/schema/resolved_schema.json +1 -1
- data/lib/definitions/common/components.json +293 -13
- data/lib/definitions/common/examples/associations/category.json +12 -0
- data/lib/definitions/common/examples/associations/department.json +9 -0
- data/lib/definitions/common/examples/associations/group_assignee.json +27 -0
- data/lib/definitions/common/examples/associations/site.json +11 -0
- data/lib/definitions/common/examples/associations/sub_category.json +11 -0
- data/lib/definitions/common/examples/catalog_item.json +6 -28
- data/lib/definitions/common/examples/change.json +233 -20
- data/lib/definitions/common/examples/change_catalog.json +5 -15
- data/lib/definitions/common/examples/change_request.json +2 -1
- data/lib/definitions/common/examples/configuration_item.json +17 -18
- data/lib/definitions/common/examples/contract.json +281 -0
- data/lib/definitions/common/examples/hardware.json +235 -71
- data/lib/definitions/common/examples/incident.json +397 -95
- data/lib/definitions/common/examples/other_asset.json +211 -0
- data/lib/definitions/common/examples/problem.json +212 -13
- data/lib/definitions/common/examples/release.json +26 -22
- data/lib/definitions/common/examples/service_request.json +10 -14
- data/lib/definitions/common/examples/solution.json +54 -0
- data/lib/definitions/common/examples/user.json +4 -15
- data/lib/definitions/common/schemas/inventory/mobile.json +2 -0
- data/lib/definitions/common/schemas/inventory/other_asset.json +2 -2
- data/lib/definitions/common/schemas/procurement/purchase_order.json +97 -1
- data/lib/definitions/common/schemas/service_desk/catalog_item.json +1 -0
- data/lib/definitions/common/schemas/service_desk/change.json +2 -0
- data/lib/definitions/common/schemas/service_desk/change_catalog.json +2 -0
- data/lib/definitions/common/schemas/service_desk/change_request.json +1 -0
- data/lib/definitions/common/schemas/service_desk/incident.json +72 -23
- data/lib/definitions/common/schemas/service_desk/problem.json +2 -0
- data/lib/definitions/common/schemas/service_desk/release.json +2 -0
- data/lib/definitions/common/schemas/service_desk/service_request.json +2 -6
- data/lib/definitions/common/schemas/setup/category.json +4 -2
- data/lib/definitions/common/schemas/setup/department.json +3 -1
- data/lib/definitions/common/schemas/setup/group.json +3 -2
- data/lib/definitions/common/schemas/setup/site.json +4 -1
- data/lib/definitions/openapi.json +4 -3
- data/lib/definitions/paths/changes/change_by_id.json +6 -2
- data/lib/definitions/paths/changes/changes.json +6 -2
- data/lib/definitions/paths/contracts/contract_by_id.json +9 -2
- data/lib/definitions/paths/contracts/contracts.json +6 -1
- data/lib/definitions/paths/hardwares/hardware_by_id.json +6 -2
- data/lib/definitions/paths/hardwares/hardwares.json +6 -2
- data/lib/definitions/paths/incidents/incident_by_id.json +6 -2
- data/lib/definitions/paths/incidents/incidents.json +6 -2
- data/lib/definitions/paths/other_assets/other_asset_by_id.json +9 -2
- data/lib/definitions/paths/other_assets/other_assets.json +6 -1
- data/lib/definitions/paths/problems/problem_by_id.json +6 -2
- data/lib/definitions/paths/problems/problems.json +6 -2
- data/lib/definitions/paths/purchase_orders/purchase_order_by_id.json +3 -2
- data/lib/definitions/paths/purchase_orders/purchase_orders.json +3 -2
- data/lib/definitions/paths/solutions/solution_by_id.json +6 -2
- data/lib/definitions/paths/solutions/solutions.json +6 -2
- metadata +15 -6
|
@@ -71,6 +71,60 @@
|
|
|
71
71
|
"shared_attachments": []
|
|
72
72
|
}
|
|
73
73
|
}
|
|
74
|
+
},
|
|
75
|
+
"response_long": {
|
|
76
|
+
"json": {
|
|
77
|
+
"solution": {
|
|
78
|
+
"id": "10000",
|
|
79
|
+
"name": "Solution Name",
|
|
80
|
+
"href": "/solutions/10000.json",
|
|
81
|
+
"number": "1000",
|
|
82
|
+
"description": "description",
|
|
83
|
+
"description_no_html": "description_no_html.",
|
|
84
|
+
"creator": {
|
|
85
|
+
"id": "1",
|
|
86
|
+
"name": "John Doe",
|
|
87
|
+
"email": "john.doe@email.com"
|
|
88
|
+
},
|
|
89
|
+
"created_at": "2025-01-01T00:00:00.000+01:00",
|
|
90
|
+
"isAllowToVote": true,
|
|
91
|
+
"number_of_attachments": 0,
|
|
92
|
+
"attachments": [],
|
|
93
|
+
"number_of_shared_attachments": 0,
|
|
94
|
+
"shared_attachments": [],
|
|
95
|
+
"comments": [
|
|
96
|
+
{
|
|
97
|
+
"id": 10,
|
|
98
|
+
"body": "everybody",
|
|
99
|
+
"user": {
|
|
100
|
+
"id": 4713,
|
|
101
|
+
"name": "Simmy",
|
|
102
|
+
"email": "simmy.dian@mydomain.com",
|
|
103
|
+
"avatar": {
|
|
104
|
+
"type": "image",
|
|
105
|
+
"image_class": "gravatar_image",
|
|
106
|
+
"sso_image_class": "",
|
|
107
|
+
"avatar_url": "https://secure.gravatar.com/avatar/8f6284"
|
|
108
|
+
}
|
|
109
|
+
},
|
|
110
|
+
"created_at": "2024-08-18T22:40:42.000-07:00",
|
|
111
|
+
"updated_at": "2024-08-18T22:40:42.000-07:00",
|
|
112
|
+
"attachments": [],
|
|
113
|
+
"inline_attachments": [],
|
|
114
|
+
"shared_attachments": [],
|
|
115
|
+
"is_private": false,
|
|
116
|
+
"seen_by": [8610546],
|
|
117
|
+
"isTask": false,
|
|
118
|
+
"task_info": {},
|
|
119
|
+
"requester": null,
|
|
120
|
+
"commenter_id": 139207697,
|
|
121
|
+
"commenter_type": "Incident",
|
|
122
|
+
"origin": 0
|
|
123
|
+
}
|
|
124
|
+
],
|
|
125
|
+
"total_time_spent": 10
|
|
126
|
+
}
|
|
127
|
+
}
|
|
74
128
|
}
|
|
75
129
|
}
|
|
76
130
|
}
|
|
@@ -36,19 +36,8 @@
|
|
|
36
36
|
"created_at": "2030-01-01T00:00:00.000+00:00",
|
|
37
37
|
"phone": "+10000000",
|
|
38
38
|
"mobile_phone": "+10000000",
|
|
39
|
-
"site": {
|
|
40
|
-
|
|
41
|
-
"name": "Austin TX, USA",
|
|
42
|
-
"location": "AUS",
|
|
43
|
-
"description": "",
|
|
44
|
-
"time_zone": ""
|
|
45
|
-
},
|
|
46
|
-
"department": {
|
|
47
|
-
"id": "1",
|
|
48
|
-
"name": "Support",
|
|
49
|
-
"description": "",
|
|
50
|
-
"default_assignee_id": "1"
|
|
51
|
-
},
|
|
39
|
+
"site": { "$ref": "./associations/site.json#/site" },
|
|
40
|
+
"department": { "$ref": "./associations/department.json#/department" },
|
|
52
41
|
"role": {
|
|
53
42
|
"id": 1,
|
|
54
43
|
"name": "Requester",
|
|
@@ -65,7 +54,7 @@
|
|
|
65
54
|
"reports_to": {
|
|
66
55
|
"group_id": "1",
|
|
67
56
|
"is_user": "true",
|
|
68
|
-
"id":
|
|
57
|
+
"id": "100",
|
|
69
58
|
"name": "Jane Doe",
|
|
70
59
|
"email": "jane.doe@email.com",
|
|
71
60
|
"avatar": {
|
|
@@ -103,4 +92,4 @@
|
|
|
103
92
|
}
|
|
104
93
|
}
|
|
105
94
|
}
|
|
106
|
-
}
|
|
95
|
+
}
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
"imei": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
40
40
|
"user": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
41
41
|
"technical_contact": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
42
|
+
"phone_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string_phone" },
|
|
42
43
|
"custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
|
|
43
44
|
"custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
|
|
44
45
|
},
|
|
@@ -63,6 +64,7 @@
|
|
|
63
64
|
"imei": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
64
65
|
"user": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
65
66
|
"technical_contact": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
67
|
+
"phone_number": { "type": "string", "example": "12345" },
|
|
66
68
|
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" }
|
|
67
69
|
}
|
|
68
70
|
}
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"asset_type": { "$ref": "../../components.json#/components/request/schemas/association_by_name", "example": { "name": "Printer" } },
|
|
36
36
|
"status": { "$ref": "../../components.json#/components/request/schemas/association_by_name", "example": { "name": "Operational" } },
|
|
37
37
|
"manufacturer": { "type": "string", "example": "Apple" },
|
|
38
|
-
"
|
|
38
|
+
"ip": { "type": "string", "example": "0.0.0.0" },
|
|
39
39
|
"model": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
40
40
|
"serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
41
41
|
"user": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"asset_id": { "type": "string", "example": "1" },
|
|
61
61
|
"manufacturer": { "type": "string", "example": "Apple" },
|
|
62
62
|
"model": { "type": "string", "example": "1" },
|
|
63
|
-
"
|
|
63
|
+
"ip_address": { "type": "string", "example": "0.0.0.0" },
|
|
64
64
|
"serial_number": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
65
65
|
"user": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
66
66
|
"owner": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
@@ -13,13 +13,34 @@
|
|
|
13
13
|
}
|
|
14
14
|
}
|
|
15
15
|
},
|
|
16
|
+
"post_for_xml": {
|
|
17
|
+
"type": "object",
|
|
18
|
+
"xml": { "name": "/" },
|
|
19
|
+
"properties": {
|
|
20
|
+
"purchase_order": {
|
|
21
|
+
"type": "object",
|
|
22
|
+
"required": ["name", "vendor"],
|
|
23
|
+
"properties": { "$ref": "purchase_order.json#/components/schemas/request_properties_for_xml" }
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
},
|
|
16
27
|
"put": {
|
|
17
28
|
"type": "object",
|
|
18
29
|
"xml": { "name": "/" },
|
|
19
30
|
"properties": {
|
|
20
31
|
"purchase_order": {
|
|
21
32
|
"type": "object",
|
|
22
|
-
"properties": { "$ref": "purchase_order.json#/components/schemas/
|
|
33
|
+
"properties": { "$ref": "purchase_order.json#/components/schemas/update_request_properties" }
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"put_for_xml": {
|
|
38
|
+
"type": "object",
|
|
39
|
+
"xml": { "name": "/" },
|
|
40
|
+
"properties": {
|
|
41
|
+
"purchase_order": {
|
|
42
|
+
"type": "object",
|
|
43
|
+
"properties": { "$ref": "purchase_order.json#/components/schemas/update_request_properties_for_xml" }
|
|
23
44
|
}
|
|
24
45
|
}
|
|
25
46
|
}
|
|
@@ -49,6 +70,81 @@
|
|
|
49
70
|
"approval_levels_attributes": { "$ref": "../../components.json#/components/request/schemas/approval_levels_attributes" },
|
|
50
71
|
"purchase_order_items_attributes": { "$ref": "../../components.json#/components/request/schemas/purchase_order_items_attributes" }
|
|
51
72
|
},
|
|
73
|
+
"request_properties_for_xml": {
|
|
74
|
+
"name": { "type": "string", "example": "Purchase order Name" },
|
|
75
|
+
"buyer_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
76
|
+
"buyer": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
77
|
+
"order_date": { "type": "string", "example": "Jan 01, 2025" },
|
|
78
|
+
"due_date": { "type": "string", "example": "Jan 01, 2030" },
|
|
79
|
+
"site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
80
|
+
"department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
81
|
+
"state": { "type": "string", "example": "Approved" },
|
|
82
|
+
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
83
|
+
"recurrence": { "type": "string", "example": "Monthly" },
|
|
84
|
+
"total_cost": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
85
|
+
"currency": { "type": "string", "example": "USD" },
|
|
86
|
+
"tax": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
87
|
+
"notes": { "type": "string", "example": "Purchase notes" },
|
|
88
|
+
"vendor": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
89
|
+
"billing_address": { "type": "string", "example": "Billing address" },
|
|
90
|
+
"shipping_address": { "type": "string", "example": "Shipping address" },
|
|
91
|
+
"payment_terms": { "type": "string", "example": "Purchase terms" },
|
|
92
|
+
"terms_conditions": { "type": "string", "example": "Terms conditions" },
|
|
93
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
|
|
94
|
+
"custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
|
|
95
|
+
"approval_levels_attributes": { "$ref": "../../components.json#/components/request/schemas/approval_levels_attributes_for_xml" },
|
|
96
|
+
"purchase_order_items_attributes": { "$ref": "../../components.json#/components/request/schemas/purchase_order_items_attributes" }
|
|
97
|
+
},
|
|
98
|
+
"update_request_properties": {
|
|
99
|
+
"name": { "type": "string", "example": "Purchase order Name" },
|
|
100
|
+
"buyer_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
101
|
+
"buyer": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
102
|
+
"order_date": { "type": "string", "example": "Jan 01, 2025" },
|
|
103
|
+
"due_date": { "type": "string", "example": "Jan 01, 2030" },
|
|
104
|
+
"site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
105
|
+
"department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
106
|
+
"state": { "type": "string", "example": "Approved" },
|
|
107
|
+
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
108
|
+
"recurrence": { "type": "string", "example": "Monthly" },
|
|
109
|
+
"total_cost": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
110
|
+
"currency": { "type": "string", "example": "USD" },
|
|
111
|
+
"tax": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
112
|
+
"notes": { "type": "string", "example": "Purchase notes" },
|
|
113
|
+
"vendor": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
114
|
+
"billing_address": { "type": "string", "example": "Billing address" },
|
|
115
|
+
"shipping_address": { "type": "string", "example": "Shipping address" },
|
|
116
|
+
"payment_terms": { "type": "string", "example": "Purchase terms" },
|
|
117
|
+
"terms_conditions": { "type": "string", "example": "Terms conditions" },
|
|
118
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
|
|
119
|
+
"custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
|
|
120
|
+
"approval_levels_attributes": { "$ref": "../../components.json#/components/request/schemas/update_approval_levels" },
|
|
121
|
+
"purchase_order_items_attributes": { "$ref": "../../components.json#/components/request/schemas/purchase_order_items_attributes" }
|
|
122
|
+
},
|
|
123
|
+
"update_request_properties_for_xml": {
|
|
124
|
+
"name": { "type": "string", "example": "Purchase order Name" },
|
|
125
|
+
"buyer_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
126
|
+
"buyer": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
127
|
+
"order_date": { "type": "string", "example": "Jan 01, 2025" },
|
|
128
|
+
"due_date": { "type": "string", "example": "Jan 01, 2030" },
|
|
129
|
+
"site": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
130
|
+
"department": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
131
|
+
"state": { "type": "string", "example": "Approved" },
|
|
132
|
+
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
133
|
+
"recurrence": { "type": "string", "example": "Monthly" },
|
|
134
|
+
"total_cost": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
135
|
+
"currency": { "type": "string", "example": "USD" },
|
|
136
|
+
"tax": { "$ref": "../../components.json#/components/common/schemas/number_or_string" },
|
|
137
|
+
"notes": { "type": "string", "example": "Purchase notes" },
|
|
138
|
+
"vendor": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
139
|
+
"billing_address": { "type": "string", "example": "Billing address" },
|
|
140
|
+
"shipping_address": { "type": "string", "example": "Shipping address" },
|
|
141
|
+
"payment_terms": { "type": "string", "example": "Purchase terms" },
|
|
142
|
+
"terms_conditions": { "type": "string", "example": "Terms conditions" },
|
|
143
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
|
|
144
|
+
"custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" },
|
|
145
|
+
"approval_levels_attributes": { "$ref": "../../components.json#/components/request/schemas/update_approval_levels_for_xml" },
|
|
146
|
+
"purchase_order_items_attributes": { "$ref": "../../components.json#/components/request/schemas/purchase_order_items_attributes" }
|
|
147
|
+
},
|
|
52
148
|
"response": {
|
|
53
149
|
"type": "object",
|
|
54
150
|
"xml": { "name": "/", "wrapped": true },
|
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
"description": { "type": "string", "example": "description" },
|
|
32
32
|
"state": { "type": "string", "example": "Approved" },
|
|
33
33
|
"default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
34
|
+
"default_group_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
34
35
|
"category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
35
36
|
"subcategory": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
36
37
|
"expected_delivery_time": { "type": "string", "example": "1 day" },
|
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
"state": { "type": "string", "example": "New" },
|
|
36
36
|
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
37
37
|
"assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
38
|
+
"group_assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
38
39
|
"priority": { "type": "string", "example": "High" },
|
|
39
40
|
"change_plan": { "type": "string", "example": "change plan" },
|
|
40
41
|
"rollback_plan": { "type": "string", "example": "rollback plan" },
|
|
@@ -72,6 +73,7 @@
|
|
|
72
73
|
"planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" },
|
|
73
74
|
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
74
75
|
"assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
76
|
+
"group_assignee": { "$ref": "../../components.json#/components/response/schemas/group_assignee_details" },
|
|
75
77
|
"requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
76
78
|
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
77
79
|
"tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
"department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
35
35
|
"state": { "type": "string", "example": "Approved" },
|
|
36
36
|
"default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
37
|
+
"default_group_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
37
38
|
"priority": { "type": "string", "example": "High" },
|
|
38
39
|
"change_plan": { "type": "string", "example": "change plan" },
|
|
39
40
|
"rollback_plan": { "type": "string", "example": "rollback plan" },
|
|
@@ -64,6 +65,7 @@
|
|
|
64
65
|
"test_plan": { "type": "string", "example": "test plan" },
|
|
65
66
|
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
66
67
|
"default_assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
68
|
+
"default_group_assignee": { "$ref": "../../components.json#/components/response/schemas/group_assignee_details" },
|
|
67
69
|
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
68
70
|
"tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
|
|
69
71
|
"created_at": { "type": "string", "example": "2025-01-01T00:00:00.000+01:00" },
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
"test_plan": { "type": "string", "example": "Test Plan" },
|
|
16
16
|
"rollback_plan": { "type": "string", "example": "Rollback Plan" },
|
|
17
17
|
"assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
18
|
+
"group_assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
18
19
|
"request_variables_attributes": {
|
|
19
20
|
"anyOf": [
|
|
20
21
|
{ "$ref": "../../components.json#/components/request/schemas/variable" },
|
|
@@ -25,13 +25,15 @@
|
|
|
25
25
|
}
|
|
26
26
|
},
|
|
27
27
|
"request_properties": {
|
|
28
|
-
"name": { "type": "string", "example": "Incident Name" },
|
|
28
|
+
"name": { "type": "string", "example": "Incident Name", "description": "The name property accepts a maximum of 255 chars. values exceeding this limit will be truncated with ellipsis" },
|
|
29
29
|
"site_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
30
30
|
"department_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
31
31
|
"description": { "$ref": "../../components.json#/components/common/schemas/string_or_null" },
|
|
32
32
|
"state_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
33
33
|
"assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
34
|
+
"group_assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
34
35
|
"assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
36
|
+
"group_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
35
37
|
"priority": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
36
38
|
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
37
39
|
"category": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
@@ -64,34 +66,81 @@
|
|
|
64
66
|
"type": "object",
|
|
65
67
|
"xml": { "name": "/", "wrapped": true },
|
|
66
68
|
"properties": {
|
|
67
|
-
"
|
|
69
|
+
"id": { "$ref": "../../components.json#/components/response/schemas/id" },
|
|
70
|
+
"number": { "type": "integer", "example": 1 },
|
|
71
|
+
"name": { "type": "string", "example": "Incident Name" },
|
|
72
|
+
"description": { "$ref": "../../components.json#/components/response/schemas/description_field" },
|
|
73
|
+
"description_no_html": { "$ref": "../../components.json#/components/response/schemas/description_field" },
|
|
74
|
+
"state": { "type": "string", "example": "New" },
|
|
75
|
+
"priority": { "type": "string", "example": "High" },
|
|
76
|
+
"category": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
|
|
77
|
+
"subcategory": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
|
|
78
|
+
"assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
79
|
+
"group_assignee": { "$ref": "../../components.json#/components/response/schemas/group_assignee_details" },
|
|
80
|
+
"requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
81
|
+
"created_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
82
|
+
"updated_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
83
|
+
"due_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
84
|
+
"sla_violations": { "$ref": "../../components.json#/components/response/schemas/sla_violations" },
|
|
85
|
+
"number_of_comments": { "type": "integer", "example": 0 },
|
|
86
|
+
"user_saw_all_comments": { "type": "boolean", "example": false },
|
|
87
|
+
"is_service_request": { "type": "boolean", "example": true },
|
|
88
|
+
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
89
|
+
"resolved_by": {
|
|
68
90
|
"type": "object",
|
|
69
91
|
"properties": {
|
|
70
92
|
"id": { "$ref": "../../components.json#/components/response/schemas/id" },
|
|
71
|
-
"name": { "type": "string", "example": "
|
|
72
|
-
"
|
|
93
|
+
"name": { "type": "string", "example": "John Doe" },
|
|
94
|
+
"disabled": { "type": "boolean", "example": false },
|
|
95
|
+
"title": { "type": "string", "example": "title" },
|
|
96
|
+
"email": { "type": "string", "example": "john.doe@email.com" },
|
|
97
|
+
"created_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
98
|
+
"updated_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
99
|
+
"last_login": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
100
|
+
"phone": { "type": "string", "example": "0123-456-789" },
|
|
101
|
+
"mobile_phone": { "type": "string", "example": "0123-456-789" },
|
|
102
|
+
"role": { "$ref": "../../components.json#/components/response/schemas/role" },
|
|
103
|
+
"group_ids": { "$ref": "../../components.json#/components/common/schemas/ids_array" },
|
|
104
|
+
"available_for_assignment": { "type": "boolean", "example": false },
|
|
105
|
+
"can_be_available_for_assignment": { "type": "boolean", "example": false },
|
|
106
|
+
"provider": { "type": "string", "example": "provider" },
|
|
107
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
73
108
|
"site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
|
|
74
109
|
"department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
|
|
75
|
-
"
|
|
76
|
-
"
|
|
77
|
-
"assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
78
|
-
"requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
79
|
-
"category": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
|
|
80
|
-
"subcategory": { "$ref": "../../components.json#/components/response/schemas/category_subcategory" },
|
|
81
|
-
"due_at": { "type": "string", "example": "Jan 01,2025" },
|
|
82
|
-
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
83
|
-
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
84
|
-
"origin": { "type": "string", "example": "api" },
|
|
85
|
-
"incidents": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
86
|
-
"solutions": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
87
|
-
"changes": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
88
|
-
"problems": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
89
|
-
"releases": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
90
|
-
"configuration_items": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
91
|
-
"is_service_request": { "type": "boolean", "example": true },
|
|
92
|
-
"cc": { "$ref": "../../components.json#/components/request/schemas/cc_array" }
|
|
110
|
+
"avatar": { "$ref": "../../components.json#/components/response/schemas/avatar" },
|
|
111
|
+
"reports_to": { "$ref": "../../components.json#/components/response/schemas/group_details" }
|
|
93
112
|
}
|
|
94
|
-
}
|
|
113
|
+
},
|
|
114
|
+
"resolution_description": { "type": "string", "example": "description" },
|
|
115
|
+
"resolution_code": { "type": "string", "example": "Done" },
|
|
116
|
+
"customer_satisfaction_survey_sent_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
117
|
+
"customer_satisfaction_survey_completed_at": { "$ref": "../../components.json#/components/response/schemas/date_field" },
|
|
118
|
+
"custom": { "type": "string", "example": "2023-01-01 00:00:00.000" },
|
|
119
|
+
"href": { "type": "string", "example": "https://mydomain.com/object_type/1" },
|
|
120
|
+
"href_account_domain": { "type": "string", "example": "https://mydomain.com/object_type/1" },
|
|
121
|
+
"site": { "$ref": "../../components.json#/components/response/schemas/site_response" },
|
|
122
|
+
"department": { "$ref": "../../components.json#/components/response/schemas/department_response" },
|
|
123
|
+
"cc": { "$ref": "../../components.json#/components/request/schemas/cc_array" },
|
|
124
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
125
|
+
"origin": { "type": "string", "example": "api" },
|
|
126
|
+
"price": {
|
|
127
|
+
"type": "string",
|
|
128
|
+
"example": "1234.00 USD",
|
|
129
|
+
"description": "(Only For service requests)"
|
|
130
|
+
},
|
|
131
|
+
"releases": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
132
|
+
"problems": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
133
|
+
"incidents": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
134
|
+
"changes": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
135
|
+
"tasks": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
136
|
+
"time_tracks": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
137
|
+
"solutions": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
138
|
+
"assets": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
139
|
+
"mobiles": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
140
|
+
"other_assets": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
141
|
+
"configuration_items": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
142
|
+
"discovery_hardware": { "$ref": "../../components.json#/components/response/schemas/response_attachments" },
|
|
143
|
+
"purchase_order": { "$ref": "../../components.json#/components/response/schemas/response_attachments" }
|
|
95
144
|
}
|
|
96
145
|
}
|
|
97
146
|
}
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
"state": { "type": "string", "example": "New" },
|
|
35
35
|
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
36
36
|
"assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
37
|
+
"group_assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
37
38
|
"priority": { "type": "string", "example": "High" },
|
|
38
39
|
"root_cause": { "type": "string", "example": "Root cause description" },
|
|
39
40
|
"symptoms": { "type": "string", "example": "Symptoms description" },
|
|
@@ -66,6 +67,7 @@
|
|
|
66
67
|
"workaround": { "type": "string", "example": "Workaround description" },
|
|
67
68
|
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
68
69
|
"assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
70
|
+
"group_assignee": { "$ref": "../../components.json#/components/response/schemas/group_assignee_details" },
|
|
69
71
|
"requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
70
72
|
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
71
73
|
"tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
"state": { "type": "string", "example": "New" },
|
|
35
35
|
"requester": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
36
36
|
"assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_email" },
|
|
37
|
+
"group_assignee": { "$ref": "../../components.json#/components/request/schemas/association_by_name" },
|
|
37
38
|
"priority": { "type": "string", "example": "High" },
|
|
38
39
|
"plan": { "type": "string", "example": "plan description" },
|
|
39
40
|
"build": { "type": "string", "example": "build description" },
|
|
@@ -70,6 +71,7 @@
|
|
|
70
71
|
"planned_end_at": { "type": "string", "example": "2025-01-01T05:00:00.000+01:00" },
|
|
71
72
|
"created_by": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
72
73
|
"assignee": { "$ref": "../../components.json#/components/response/schemas/group_details" },
|
|
74
|
+
"group_assignee": { "$ref": "../../components.json#/components/response/schemas/group_assignee_details" },
|
|
73
75
|
"requester": { "$ref": "../../components.json#/components/response/schemas/user_details" },
|
|
74
76
|
"custom_fields_values": { "$ref": "../../components.json#/components/response/schemas/custom_fields_values" },
|
|
75
77
|
"tags": { "$ref": "../../components.json#/components/response/schemas/tags" },
|
|
@@ -16,12 +16,8 @@
|
|
|
16
16
|
"add_to_tag_list": { "type": "string", "example": "tag1, tag2" },
|
|
17
17
|
"remove_from_tag_list": { "type": "string", "example": "tag3" },
|
|
18
18
|
"tag_list": { "type": "string", "example": "tag1, tag2" },
|
|
19
|
-
"
|
|
20
|
-
|
|
21
|
-
{ "$ref": "../../components.json#/components/request/schemas/variable" },
|
|
22
|
-
{ "type": "array", "items": { "$ref": "../../components.json#/components/request/schemas/variable" } }
|
|
23
|
-
]
|
|
24
|
-
}
|
|
19
|
+
"custom_fields_values": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values" },
|
|
20
|
+
"custom_fields_values_attributes": { "$ref": "../../components.json#/components/request/schemas/custom_fields_values_attributes" }
|
|
25
21
|
}
|
|
26
22
|
}
|
|
27
23
|
}
|
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
"example": { "name": "Facilities" }
|
|
32
32
|
},
|
|
33
33
|
"default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
34
|
+
"default_group_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
34
35
|
"default_tags": { "type": "string", "example": "equipment" }
|
|
35
36
|
},
|
|
36
37
|
"response": {
|
|
@@ -44,11 +45,12 @@
|
|
|
44
45
|
"name": { "type": "string", "example": "Equipment" },
|
|
45
46
|
"parent_id": { "$ref": "../../components.json#/components/response/schemas/id" },
|
|
46
47
|
"default_tags": { "type": "string", "example": "equipment" },
|
|
47
|
-
"default_assignee_id": { "$ref": "../../components.json#/components/response/schemas/id" }
|
|
48
|
+
"default_assignee_id": { "$ref": "../../components.json#/components/response/schemas/id" },
|
|
49
|
+
"default_group_assignee_id": { "$ref": "../../components.json#/components/response/schemas/id" }
|
|
48
50
|
}
|
|
49
51
|
}
|
|
50
52
|
}
|
|
51
53
|
}
|
|
52
54
|
}
|
|
53
55
|
}
|
|
54
|
-
}
|
|
56
|
+
}
|
|
@@ -38,7 +38,9 @@
|
|
|
38
38
|
"properties": {
|
|
39
39
|
"id": { "$ref": "../../components.json#/components/response/schemas/id" },
|
|
40
40
|
"name": { "type": "string", "example": "Support" },
|
|
41
|
-
"description": { "type": "string", "example": "Support Department" }
|
|
41
|
+
"description": { "type": "string", "example": "Support Department" },
|
|
42
|
+
"default_assignee": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
43
|
+
"default_group_assignee": { "$ref": "../../components.json#/components/common/schemas/association_by_id" }
|
|
42
44
|
}
|
|
43
45
|
}
|
|
44
46
|
}
|
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
"description": "user only, not group"
|
|
36
36
|
},
|
|
37
37
|
"default_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
38
|
+
"default_group_assignee_id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
38
39
|
"business_record": {
|
|
39
40
|
"type": "object",
|
|
40
41
|
"properties": { "id": { "$ref": "../../components.json#/components/common/schemas/association_by_id" } }
|
|
@@ -54,7 +55,9 @@
|
|
|
54
55
|
"description": { "type": "string", "example": "Description Austin TX, USA" },
|
|
55
56
|
"time_zone": { "type": "string", "example": "Texas" },
|
|
56
57
|
"language": { "type": "string", "minLength": 2, "maxLength": 2, "example": "en" },
|
|
57
|
-
"business_record": { "type": "string", "example": "1" }
|
|
58
|
+
"business_record": { "type": "string", "example": "1" },
|
|
59
|
+
"default_assignee": { "$ref": "../../components.json#/components/common/schemas/association_by_id" },
|
|
60
|
+
"default_group_assignee": { "$ref": "../../components.json#/components/common/schemas/association_by_id" }
|
|
58
61
|
}
|
|
59
62
|
}
|
|
60
63
|
}
|