POST api/notifications/plan/{planId}/list
Get Plan Notifications for a specific plan.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
planId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of PlanNotificationName | Description | Type | Additional information |
---|---|---|---|
NotificationScope | NotificationScope |
None. |
|
PlanType | globally unique identifier |
None. |
|
TriggerType | PlanNotificationTrigger |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | PlanNotificationReceiver |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
None. |
|
EmailReceiverSharedWithLevels | Collection of AccessLevel |
None. |
|
EmailReceiverUsersSelection | Collection of globally unique identifier |
None. |
|
EmailReceiverTeamsSelection | Collection of globally unique identifier |
None. |
|
EmailSubject | string |
None. |
|
EmailFieldsSent | Dictionary of string [key] and globally unique identifier [value] |
None. |
|
EmailBody | string |
None. |
|
UserId | globally unique identifier |
None. |
|
PlanId | globally unique identifier |
None. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "NotificationScope": 0, "PlanType": "b751c157-74db-4d65-ac19-fa89eee58c0c", "TriggerType": 0, "OnField": "8d99b7df-7dff-492d-9549-a9061540aca0", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "c50ab452-7690-42f2-bb6a-d89113d5f88e", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "e75c16a6-fb94-4c16-987d-149f0a2f16bd", "f2e05b29-30a6-4289-8f0d-85f1bc6dd24a" ], "EmailReceiverTeamsSelection": [ "927dbbb0-2881-461a-9cdd-e61617326395", "946908f3-ad59-4c1f-96af-cfde304043f4" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "f59a7e0c-8dc8-44be-96e8-5c7c70cf4998", "sample string 3": "07f76166-0407-4df9-b942-681dde4b70f5" }, "EmailBody": "sample string 9", "UserId": "ec57bd93-ef01-4d3c-bc03-bb9b38e5f3f7", "PlanId": "7af26942-bd2e-4201-b80b-8f2eb4482bac", "id": "11f0ddaf-634d-4e73-993c-5492d63c5f54", "ConfigId": "747e9b89-3476-41d0-919d-1ef95ff9796a" }, { "NotificationScope": 0, "PlanType": "b751c157-74db-4d65-ac19-fa89eee58c0c", "TriggerType": 0, "OnField": "8d99b7df-7dff-492d-9549-a9061540aca0", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "c50ab452-7690-42f2-bb6a-d89113d5f88e", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "e75c16a6-fb94-4c16-987d-149f0a2f16bd", "f2e05b29-30a6-4289-8f0d-85f1bc6dd24a" ], "EmailReceiverTeamsSelection": [ "927dbbb0-2881-461a-9cdd-e61617326395", "946908f3-ad59-4c1f-96af-cfde304043f4" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "f59a7e0c-8dc8-44be-96e8-5c7c70cf4998", "sample string 3": "07f76166-0407-4df9-b942-681dde4b70f5" }, "EmailBody": "sample string 9", "UserId": "ec57bd93-ef01-4d3c-bc03-bb9b38e5f3f7", "PlanId": "7af26942-bd2e-4201-b80b-8f2eb4482bac", "id": "11f0ddaf-634d-4e73-993c-5492d63c5f54", "ConfigId": "747e9b89-3476-41d0-919d-1ef95ff9796a" } ]