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": "c24ee4de-c332-48ed-999f-8312a9deca0a", "TriggerType": 0, "OnField": "cab00633-22a1-4c8c-931d-02dcdde57620", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "f15db2f2-778e-43c6-a64f-e6af8892f54a", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "bfa13d7d-2227-4fdf-9a95-9cde98e2343a", "53fff42e-0305-4b4a-9df2-b46caffac6fe" ], "EmailReceiverTeamsSelection": [ "6834f4f2-d7cf-4fa3-9fc8-f198298ec0f5", "a793d0a1-9ac0-4670-bfb7-36502b86253d" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "1e3a24d6-1e27-47a8-81d9-2bb636fd6971", "sample string 3": "c2a882fd-aaba-4e7c-8e7c-6a89456c0aac" }, "EmailBody": "sample string 9", "UserId": "57a424c9-c491-44e3-bdf5-ebf4bf125122", "PlanId": "79524766-d41b-4610-9626-d1d04dfc76b9", "id": "0518a87c-50f4-4a61-80ca-05d2c2306909", "ConfigId": "1ea49ff6-3756-46cd-b467-1f998ca86512" }, { "NotificationScope": 0, "PlanType": "c24ee4de-c332-48ed-999f-8312a9deca0a", "TriggerType": 0, "OnField": "cab00633-22a1-4c8c-931d-02dcdde57620", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "f15db2f2-778e-43c6-a64f-e6af8892f54a", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "bfa13d7d-2227-4fdf-9a95-9cde98e2343a", "53fff42e-0305-4b4a-9df2-b46caffac6fe" ], "EmailReceiverTeamsSelection": [ "6834f4f2-d7cf-4fa3-9fc8-f198298ec0f5", "a793d0a1-9ac0-4670-bfb7-36502b86253d" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "1e3a24d6-1e27-47a8-81d9-2bb636fd6971", "sample string 3": "c2a882fd-aaba-4e7c-8e7c-6a89456c0aac" }, "EmailBody": "sample string 9", "UserId": "57a424c9-c491-44e3-bdf5-ebf4bf125122", "PlanId": "79524766-d41b-4610-9626-d1d04dfc76b9", "id": "0518a87c-50f4-4a61-80ca-05d2c2306909", "ConfigId": "1ea49ff6-3756-46cd-b467-1f998ca86512" } ]