@@ -23,8 +23,8 @@ A JSON object with these fields:
2323|==============================================
2424|Name |Type |Description |Required
2525
26- |`connector_id ` |String |The connector ID. |Yes
27- |`connector_name` |String |The connector name . |Yes
26+ |`connector ` |<<connector-schema, connector>> |Object containing the action's
27+ configuration . |Yes
2828|`closure_type` |String a|Determines whether a case is automatically closed in
2929{es-sec} when it is pushed to external systems. Valid values are:
3030
@@ -35,6 +35,46 @@ are pushed.
3535|Yes
3636|==============================================
3737
38+ [[connector-schema]]
39+ *`connector` schema*
40+
41+ [width="100%",options="header"]
42+ |==============================================
43+ |Name |Type |Description |Required
44+
45+ |`id` |String |The ID of the connector you want to use for sending cases to external systems. |Yes
46+ |`name` |String a|The connector name. |Yes
47+ |`type` |String a|The type of the connector.
48+
49+ Must be one of these:
50+
51+ * `.servicenow`
52+ * `.jira`
53+ * `.resilient`
54+ * `.none`
55+ |Yes
56+ |`fields` |Object a| Object containing the fields of the connector.
57+
58+ For {sn} connectors:
59+
60+ * `urgency` (string \| null): The urgency of the incident.
61+ * `severity` (string \| null): The severity of the incident.
62+ * `impact` (string \| null): The impact of the incident.
63+
64+ For Jira connectors:
65+
66+ * `issueType` (string): The issue type of the issue.
67+ * `priority` (string \| null): The priority of the issue.
68+ * `parent` (string \| null): The key of the parent issue (Valid when the issue type is `Sub-task`).
69+
70+ For {ibm-r} connectors:
71+
72+ * `issueTypes` (number[]): The issue types of the issue.
73+ * `severityCode` (number): The severity code of the issue.
74+
75+ |Yes
76+ |==============================================
77+
3878NOTE: Call <<cases-api-find-connectors>> to retrieve connector IDs and names.
3979
4080==== Example request
@@ -43,9 +83,13 @@ NOTE: Call <<cases-api-find-connectors>> to retrieve connector IDs and names.
4383--------------------------------------------------
4484POST api/cases/configure
4585{
46- "connector_id": "61787f53-4eee-4741-8df6-8fe84fa616f7",
86+ "connector": {
87+ "id": "131d4448-abe0-4789-939d-8ef60680b498",
88+ "name": "Jira",
89+ "type": ".jira",
90+ "fields": null,
91+ },
4792 "closure_type": "close-by-user",
48- "connector_name": "ServiceNow"
4993}
5094--------------------------------------------------
5195
@@ -59,9 +103,13 @@ POST api/cases/configure
59103[source,json]
60104--------------------------------------------------
61105{
62- "connector_id": "61787f53-4eee-4741-8df6-8fe84fa616f7",
106+ "connector": {
107+ "id": "131d4448-abe0-4789-939d-8ef60680b498",
108+ "name": "Jira",
109+ "type": ".jira",
110+ "fields": null,
111+ },
63112 "closure_type": "close-by-user",
64- "connector_name": "ServiceNow",
65113 "created_at": "2020-03-30T13:31:38.083Z",
66114 "created_by": {
67115 "email": "moneypenny@hms.gov.uk",
0 commit comments