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": "f7d97c58-46ce-4a04-ad27-3070b3635d12", "Global": true, "TriggerType": 0, "OnField": "a930864f-08f8-4eb7-b699-6b5e523d7847", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "a5f478ad-d2e9-4d21-bee2-4919b43cd753", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "82ec829b-a86e-4c56-85ad-c90ba7dbd761", "8a86fc29-7883-429a-86d1-e874de662df9" ], "EmailReceiverTeamsSelection": [ "d1279109-01c0-4e0e-a2b6-7ee6d082a298", "7208092f-4ec4-4215-a571-2adc4b018cdb" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "9c374a80-764c-478f-95ea-7e275e1f1ba2", "sample string 3": "12438092-c73c-4bef-9214-a5737d9ea93b" }, "EmailBody": "sample string 10", "id": "aa865d15-09c9-4b86-a95d-40c60eb17690", "ConfigId": "daf68987-1f34-41ef-a7de-50af6472b916" }, { "PlanId": "f7d97c58-46ce-4a04-ad27-3070b3635d12", "Global": true, "TriggerType": 0, "OnField": "a930864f-08f8-4eb7-b699-6b5e523d7847", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "a5f478ad-d2e9-4d21-bee2-4919b43cd753", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "82ec829b-a86e-4c56-85ad-c90ba7dbd761", "8a86fc29-7883-429a-86d1-e874de662df9" ], "EmailReceiverTeamsSelection": [ "d1279109-01c0-4e0e-a2b6-7ee6d082a298", "7208092f-4ec4-4215-a571-2adc4b018cdb" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "9c374a80-764c-478f-95ea-7e275e1f1ba2", "sample string 3": "12438092-c73c-4bef-9214-a5737d9ea93b" }, "EmailBody": "sample string 10", "id": "aa865d15-09c9-4b86-a95d-40c60eb17690", "ConfigId": "daf68987-1f34-41ef-a7de-50af6472b916" } ]