POST api/notifications/task/{planId}/list
Get Task Notifications for a specific plan. Will also return Global task notifications if the user has sufficient permissions.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
planId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of TaskNotificationName | Description | Type | Additional information |
---|---|---|---|
PlanId | globally unique identifier |
None. |
|
Global | boolean |
None. |
|
TriggerType | TriggerType |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | EmailReceiverType |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
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. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "PlanId": "d8d4d749-cf4b-43a1-b479-c4632976eecb", "Global": true, "TriggerType": 0, "OnField": "ac2aad7a-5eda-439d-804d-f8fbb682dccb", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "41b7ad42-c612-4a66-91b2-ab9c4995548b", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "cfc1ab49-5995-43ae-afa6-e0293eca8200", "d1b69e53-21f4-46b4-8414-2333e762bf8c" ], "EmailReceiverTeamsSelection": [ "82f88784-ae2a-4e61-b1fb-c2ee115fd19e", "cee56a23-1591-4532-9819-03630ecdc386" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "ba3bde73-fcf0-4880-a308-0ad12286ce26", "sample string 3": "046a5a31-5a4e-44b4-9f3e-836a0b20f2a8" }, "EmailBody": "sample string 10", "id": "9cf09afd-121d-4e11-8e98-79b2de5b2ce6", "ConfigId": "236f830c-7484-4746-8bfd-3b8e3c484664" }, { "PlanId": "d8d4d749-cf4b-43a1-b479-c4632976eecb", "Global": true, "TriggerType": 0, "OnField": "ac2aad7a-5eda-439d-804d-f8fbb682dccb", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "41b7ad42-c612-4a66-91b2-ab9c4995548b", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "cfc1ab49-5995-43ae-afa6-e0293eca8200", "d1b69e53-21f4-46b4-8414-2333e762bf8c" ], "EmailReceiverTeamsSelection": [ "82f88784-ae2a-4e61-b1fb-c2ee115fd19e", "cee56a23-1591-4532-9819-03630ecdc386" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "ba3bde73-fcf0-4880-a308-0ad12286ce26", "sample string 3": "046a5a31-5a4e-44b4-9f3e-836a0b20f2a8" }, "EmailBody": "sample string 10", "id": "9cf09afd-121d-4e11-8e98-79b2de5b2ce6", "ConfigId": "236f830c-7484-4746-8bfd-3b8e3c484664" } ]