Creating a War Room
Function
This API is used to create a WarRoom.
URI
POST /v1/external/WarRooms
Request Parameters
Parameter |
Mandatory or Not |
Type |
Description |
---|---|---|---|
war_room_name |
Yes |
String |
War room title. Minimum length: 1 character Maximum length: 255 characters |
description |
No |
String |
War room description. Minimum length: 0 character Maximum length: 255 characters |
region_code_list |
No |
Array of strings |
Region ID Minimum length: 1 character Maximum length: 255 characters Array length: 0 to 1,000 elements |
application_id_list |
Yes |
Array of strings |
ID of the affected application Minimum length: 1 character Maximum length: 255 characters Array length: 1 to 1,000 elements |
incident_number |
Yes |
String |
Incident ticket ID Minimum length: 1 character Maximum length: 255 characters |
schedule_group |
Yes |
Array of ScheduleGroupInfo objects |
Schedule groups Array length: 0 to 1,000 elements |
participant |
No |
Array of strings |
Participants Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1,000 elements |
war_room_admin |
Yes |
String |
War room administrator. Minimum length: 1 character Maximum length: 255 characters |
application_names |
No |
Array of strings |
Application name list. Minimum length: 0 character Maximum length: 1,000 characters Array length: 0 to 1,000 elements |
region_names |
No |
Array of strings |
Region names Minimum length: 0 character Maximum length: 1,000 characters Array length: 0 to 1,000 elements |
enterprise_project_id |
Yes |
String |
Enterprise project ID Minimum length: 1 character Maximum length: 64 characters |
notification_type |
No |
String |
Group creation mode Minimum length: 0 character Maximum length: 64 characters The value can be:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
provider_code |
String |
Service ID Default value: 4 Minimum length: 3 characters Maximum length: 3 characters |
error_code |
String |
Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Minimum length: 1 character Maximum length: 20 characters |
error_msg |
String |
Request response description Minimum length: 0 character Maximum length: 10,240 characters |
data |
String |
WarRoom Id Minimum length: 0 character Maximum length: 255 characters |
Request Example
None
Response Example
None
Status Code
Status Code |
Description |
---|---|
200 |
Success response |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.