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": "1e1ba159-f112-4a1c-9a98-9d5fb56cc362", "Global": true, "TriggerType": 0, "OnField": "4f90be69-5d52-4817-86b2-cc36f14d76c0", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d8ba4008-9878-438b-8cf6-72e3d424246b", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "80a1e402-6b12-40bf-b841-1d0acf7707bb", "625bae10-4d5a-48a6-ad88-9cf10046b760" ], "EmailReceiverTeamsSelection": [ "32432463-c3b1-40e9-a13a-c721249154d3", "8de245c1-3bca-478c-bc45-a40da1bf6f17" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "402b5ff1-1598-4c90-bdde-8867fbf2f854", "sample string 3": "7060791f-0dd7-4056-8395-9ef18de24a3d" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "6f17ef90-0784-4ea6-97b6-d582254436a7", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "d9d6d931-7e32-4997-a747-790a2d46b9f8", "_ts": 638878869263228169 }
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": "13a79b88-67ab-4edd-beb7-4ba4d72d1904", "Global": true, "TriggerType": 0, "OnField": "f89a2ba1-ed84-4137-8d93-9814aa268520", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "f91cfc63-63c5-4b93-adac-b25b45cea480", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "b8c2dfdc-d83e-443f-b48b-63326f0db0ac", "950fe312-7576-41de-a35d-542ed4cdd430" ], "EmailReceiverTeamsSelection": [ "ae9f1b9d-ed75-4b28-aac8-efd7fa2744a2", "9ad28282-008e-4cd2-9c83-9a942b78e6cf" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "ed18225b-5e02-4bec-b65a-0ee6d2a945ce", "sample string 3": "5b9e5693-5f43-41e3-982d-0cd8f66a676a" }, "EmailBody": "sample string 10", "id": "c0f74280-b339-458d-a16b-e8cb75330f69", "ConfigId": "203ba915-dc43-4692-ac80-ddae6b84d6bf" }