ContactGroups
ContactGroups
Create
Creates contact group
Request
POST /api/v1/ContactGroups/group
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| body |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Contact group was created |
|
| 400 | Bad VM provided |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions for the operation |
|
| 404 | Subscription was not found |
|
| 500 | Try again, if error still here - text our support |
Get
Returns contact group by id
Request
GET /api/v1/ContactGroups/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Contact group was found |
|
| 400 | Bad id provided |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions for the operation |
|
| 404 | Subscription or group was not found |
|
| 500 | Try again, if error still here - text our support |
Update
Updates contact group by id
Request
PUT /api/v1/ContactGroups/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | ||
| body |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Contact group was updated |
|
| 400 | Bad VM or id provided |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions for the operation |
|
| 404 | Subscription or group was not found |
|
| 500 | Try again, if error still here - text our support |
Delete
Removes contact by id
Request
DELETE /api/v1/ContactGroups/{id}
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 204 | Contact group was deleted |
|
| 400 | Bad id provided |
|
| 402 | Subscription is outdated |
|
| 403 | Not enough permissions for the operation |
|
| 404 | Subscription or group was not found |
|
| 500 | Try again, if error still here - text our support |
GetList
Returns contact groups by subscriptionId
Request
GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups[?skip&take]
Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | ||
| skip | integer | 0 | |
| take | integer | 10 |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Contact groups were found |
|
| 403 | Not enough permissions for the operation |
|
| 404 | Subscription was not found |
|
| 402 | Subscription is outdated |
|
| 400 | Bad id provided |
|
| 500 | Try again, if error still here - text our support |
Definitions
CreateContactGroupVM
| Name | Type | Notes |
|---|---|---|
| name | string | |
| subscriptionId | string |
ContactGroupVM
| Name | Type | Notes |
|---|---|---|
| id | string | |
| name | string | |
| subscriptionId | string | |
| createdTime | string (date-time) | |
| creatorUserId | string | |
| editedTime | string (date-time) | |
| editorUserId | string |
ProblemDetails
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |
UpdateContactGroupVM
| Name | Type | Notes |
|---|---|---|
| name | string | |
| subscriptionId | string |
ContactGroupsVM
| Name | Type | Notes |
|---|---|---|
| groups |
|
|
| skip | integer (int32) | |
| take | integer (int32) | |
| count | integer (int64) |