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": "2bce40d7-d3ff-4959-af7d-6ad7bb7c2b04", "Global": true, "TriggerType": 0, "OnField": "b5270f31-9028-4892-ab42-6ff3212403d1", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d8967dcc-cc86-46e6-8576-8ddd2a2e5ab0", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "37ba551a-a6a5-4e74-8ef6-cfe24c5e69c7", "f7edaa97-6c2c-4b64-89fb-ac6059497fb7" ], "EmailReceiverTeamsSelection": [ "cf3d9734-d84d-4a37-b5cd-be8087de5e44", "52c57f3e-6a7c-4e9d-8d56-5edf10140ccc" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "5dc8659b-51ab-460a-a4c3-323160cc2571", "sample string 3": "6619beca-29cc-4b20-8c3d-bebf86e0ca27" }, "EmailBody": "sample string 10", "id": "6f3ee1cc-2156-4882-96ab-eb36e2e0e477", "ConfigId": "cff4078f-586f-4a49-91e0-332ec0552c25" }, { "PlanId": "2bce40d7-d3ff-4959-af7d-6ad7bb7c2b04", "Global": true, "TriggerType": 0, "OnField": "b5270f31-9028-4892-ab42-6ff3212403d1", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d8967dcc-cc86-46e6-8576-8ddd2a2e5ab0", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "37ba551a-a6a5-4e74-8ef6-cfe24c5e69c7", "f7edaa97-6c2c-4b64-89fb-ac6059497fb7" ], "EmailReceiverTeamsSelection": [ "cf3d9734-d84d-4a37-b5cd-be8087de5e44", "52c57f3e-6a7c-4e9d-8d56-5edf10140ccc" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "5dc8659b-51ab-460a-a4c3-323160cc2571", "sample string 3": "6619beca-29cc-4b20-8c3d-bebf86e0ca27" }, "EmailBody": "sample string 10", "id": "6f3ee1cc-2156-4882-96ab-eb36e2e0e477", "ConfigId": "cff4078f-586f-4a49-91e0-332ec0552c25" } ]