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": "38752b3c-4e54-4601-98d6-73af9f8055c3", "Global": true, "TriggerType": 0, "OnField": "5f5b8310-53cc-4f2f-9699-2f1b414ca1d8", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "61396207-25cd-43cd-90e9-9614a341daf0", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "17edefaa-d456-4125-9c6e-708448a296b5", "d29e5f1b-46c6-434a-a89e-26d6b7e11994" ], "EmailReceiverTeamsSelection": [ "3f4ff658-97be-4191-bd5a-6fd9e92ad771", "98001b9d-35c1-418c-9082-366fd645cb75" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "07d2881e-ec80-4829-b2d1-ba510e51147a", "sample string 3": "8dcae2da-5ddb-4903-ad78-b2a42320c4b5" }, "EmailBody": "sample string 10", "id": "ec0db7d1-16b2-41f7-a09e-861097cb5d4e", "ConfigId": "41553729-73ae-43bb-8b67-0ef118bb9d4e" }, { "PlanId": "38752b3c-4e54-4601-98d6-73af9f8055c3", "Global": true, "TriggerType": 0, "OnField": "5f5b8310-53cc-4f2f-9699-2f1b414ca1d8", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "61396207-25cd-43cd-90e9-9614a341daf0", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "17edefaa-d456-4125-9c6e-708448a296b5", "d29e5f1b-46c6-434a-a89e-26d6b7e11994" ], "EmailReceiverTeamsSelection": [ "3f4ff658-97be-4191-bd5a-6fd9e92ad771", "98001b9d-35c1-418c-9082-366fd645cb75" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "07d2881e-ec80-4829-b2d1-ba510e51147a", "sample string 3": "8dcae2da-5ddb-4903-ad78-b2a42320c4b5" }, "EmailBody": "sample string 10", "id": "ec0db7d1-16b2-41f7-a09e-861097cb5d4e", "ConfigId": "41553729-73ae-43bb-8b67-0ef118bb9d4e" } ]