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": "593a8f20-ff78-42ac-883c-5f1c1a9c027d", "Global": true, "TriggerType": 0, "OnField": "eda0c10e-3dd8-4286-9eb1-23ad968ee346", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "0c852caf-52ae-4671-8f00-db4adbdb989a", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "8ca35b61-2d2b-435a-bf6c-d3eafeb624f1", "5428d67d-7693-4e5c-acd7-58772c3f48ee" ], "EmailReceiverTeamsSelection": [ "da41020a-5818-47c1-8ede-ae095c2dc382", "1c8ed1d1-22fc-4502-a32d-eabc4177ad1a" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "20807590-787c-43d7-bed8-0f67497dc5dd", "sample string 3": "20007bad-d418-48a0-9147-b914000908ed" }, "EmailBody": "sample string 10", "id": "a89a58fc-37a9-4170-a30e-48a53915c081", "ConfigId": "86e676a6-b06e-4dc4-b948-80e3bc582390" }, { "PlanId": "593a8f20-ff78-42ac-883c-5f1c1a9c027d", "Global": true, "TriggerType": 0, "OnField": "eda0c10e-3dd8-4286-9eb1-23ad968ee346", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "0c852caf-52ae-4671-8f00-db4adbdb989a", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "8ca35b61-2d2b-435a-bf6c-d3eafeb624f1", "5428d67d-7693-4e5c-acd7-58772c3f48ee" ], "EmailReceiverTeamsSelection": [ "da41020a-5818-47c1-8ede-ae095c2dc382", "1c8ed1d1-22fc-4502-a32d-eabc4177ad1a" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "20807590-787c-43d7-bed8-0f67497dc5dd", "sample string 3": "20007bad-d418-48a0-9147-b914000908ed" }, "EmailBody": "sample string 10", "id": "a89a58fc-37a9-4170-a30e-48a53915c081", "ConfigId": "86e676a6-b06e-4dc4-b948-80e3bc582390" } ]