POST api/notifications/task/{planId}/{notificationId}/update
Update a Task Notification by configuring a TaskNotification object and passing in the Plan Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
planId | globally unique identifier |
Required |
|
notificationId | string |
None. |
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{ "PlanId": "49951db3-c259-46ea-903e-3b4a7d5a8695", "Global": true, "TriggerType": 0, "OnField": "f11fdfdf-74f3-493b-b281-1dd22d54462a", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "e8c81b9e-8283-413e-9e96-19684f8e7d98", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "f4733437-add9-435b-9600-c51f68178f9d", "a06c508f-e88b-4aa4-9a73-07b6fc270b51" ], "EmailReceiverTeamsSelection": [ "a834825d-d78f-4249-a992-6547df6c3e07", "d6aeb234-d692-404a-803d-5c3ce5d03504" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "d5fd66a4-af7f-4756-983b-27cdf9b651b2", "sample string 3": "5a33c233-b81e-450e-a684-b2caf53248a2" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "cedeb9d0-b456-44f4-8a9e-f76c4cbdf404", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "85a336bd-a2d1-4914-b205-d1b94cf4842d", "_ts": 638875957629038552 }
Response Information
Resource Description
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": "ee393005-c0c3-48be-b9bb-6d2358dfa5ec", "Global": true, "TriggerType": 0, "OnField": "939023e6-52ea-4b82-a5e1-fcb249933db1", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "9bfc250c-0f42-41c5-a668-ffaafb82f6a1", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "0dac3143-a024-4e98-94ad-1f1d2dc153ee", "089b4a83-a249-425d-a1a9-df90ffbab885" ], "EmailReceiverTeamsSelection": [ "eca17fc2-9f7a-4d1c-b895-b7d44f9d4abf", "ea489971-e00d-4ba8-9008-e2100c7a0eae" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "7f0dabeb-127f-449a-9279-9a583b5ecb79", "sample string 3": "7dbfcb3b-7be9-4f0a-8ad4-a44a366422c4" }, "EmailBody": "sample string 10", "id": "2e6cb01c-0777-4bdb-9ffd-9207c104c1a1", "ConfigId": "e1d17d9c-6c15-461f-b20d-dcd6c7e6de20" }