Skip to content

Commit 7ccc1c5

Browse files
committed
Update patch case
1 parent 2f38731 commit 7ccc1c5

File tree

1 file changed

+62
-5
lines changed

1 file changed

+62
-5
lines changed

docs/cases/api/cases-api/cases-api-update.asciidoc

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ A JSON array containing one or more case objects with updated field values:
2525

2626
|`id` |String |The ID of the case being updated. |Yes
2727
|`title` |String |The updated case title. |No
28-
| `connector_id` |String |ID of the <<actions-api-overview, connector>>
29-
used for pushing case updates to external systems (returned when calling
30-
<<cases-api-find-connectors>>). |No
28+
|`connector` |<<connector-schema, connector>> |Object containing the action's
29+
configuration. |No
3130
|`description` |String |The updated case description. |No
3231
|`status` |String a|The updated case status, which can be:
3332

@@ -40,6 +39,48 @@ used for pushing case updates to external systems (returned when calling
4039
<<cases-api-get-case>> or <<cases-api-find-cases>>). |Yes
4140
|==============================================
4241

42+
[[connector-schema]]
43+
*`connector` schema*
44+
45+
[width="100%",options="header"]
46+
|==============================================
47+
|Name |Type |Description |Required
48+
49+
|`id` |String |ID of the <<actions-api-overview, connector>>
50+
used for pushing case updates to external systems (returned when calling
51+
<<cases-api-find-connectors>>. |Yes
52+
|`name` |String a|The connector name. |Yes
53+
|`type` |String a|The type of the connector.
54+
55+
Must be one of these:
56+
57+
* `.servicenow`
58+
* `.jira`
59+
* `.resilient`
60+
* `.none`
61+
|Yes
62+
|`fields` |Object a| Object containing the fields of the connector.
63+
64+
For {sn} connectors:
65+
66+
* `urgency` (string \| null): The urgency of the incident.
67+
* `severity` (string \| null): The severity of the incident.
68+
* `impact` (string \| null): The impact of the incident.
69+
70+
For Jira connectors:
71+
72+
* `issueType` (string): The issue type of the issue.
73+
* `priority` (string \| null): The priority of the issue.
74+
* `parent` (string \| null): The key of the parent issue (Valid when the issue type is `Sub-task`).
75+
76+
For {ibm-r} connectors:
77+
78+
* `issueTypes` (number[]): The issue types of the issue.
79+
* `severityCode` (number): The severity code of the issue.
80+
81+
|Yes
82+
|==============================================
83+
4384
===== Example request
4485

4586
Updates the description, tags, and connector of case ID
@@ -51,7 +92,15 @@ PATCH api/cases
5192
{
5293
"cases": [
5394
{
54-
"connector_id": "5b347c7b-6925-4452-a4dd-215550294ba2",
95+
"connector": {
96+
"id": "131d4448-abe0-4789-939d-8ef60680b498",
97+
"name": "My connector",
98+
"type": ".jira",
99+
"fields": {
100+
"issueType": "10006",
101+
"priority": null,
102+
}
103+
},
55104
"id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2",
56105
"description": "James Bond clicked on a highly suspicious email
57106
banner advertising cheap holidays for underpaid civil servants.
@@ -88,7 +137,15 @@ The updated case with a new `version` value.
88137
"version": "WzU0OCwxXQ==",
89138
"comments": [],
90139
"totalComment": 0,
91-
"connector_id": "5b347c7b-6925-4452-a4dd-215550294ba2",
140+
"connector": {
141+
"id": "131d4448-abe0-4789-939d-8ef60680b498",
142+
"name": "My connector",
143+
"type": ".jira",
144+
"fields": {
145+
"issueType": "10006",
146+
"priority": null,
147+
}
148+
},
92149
"title": "This case will self-destruct in 5 seconds",
93150
"description": "James Bond clicked on a highly suspicious email banner advertising cheap holidays for underpaid civil servants. Operation bubblegum is active. Repeat - operation bubblegum is now active!",
94151
"tags": [

0 commit comments

Comments
 (0)