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": "a52a1397-75d0-4ff0-b10e-f6d97e49363f", "Global": true, "TriggerType": 0, "OnField": "a0e4922e-67b0-462f-88b6-833de7201975", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "308be997-3f2e-41ca-a861-0d58fdfc500e", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "001ac27d-ad3a-4332-a128-97e37d260bde", "6591f588-f3cc-4e5d-bb1a-3a5462475f06" ], "EmailReceiverTeamsSelection": [ "2867647b-526c-4c5f-a528-f908f0ac582e", "9129f96f-21f7-4367-8273-14da9a4e8cbd" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "07400579-a5dc-4e02-9f74-69d44a733d79", "sample string 3": "bf3dbb35-4c04-41a4-b370-cc979d76ab12" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "3a026bd2-7de8-4b8d-878e-5faeeea62d86", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "a0c78c7c-3a63-44ae-9881-2a70969dc9de", "_ts": 638937034256353902 }
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": "23ce91ba-bb07-4d68-a514-787986458252", "Global": true, "TriggerType": 0, "OnField": "aa8aa56e-bb8e-4499-bbfd-2c8e339cfd31", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "2a4f5b35-823e-41e3-9391-e2d3c50750bc", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "6f4fbcba-8020-4d56-84fd-23371fe0e06e", "da492ae7-7cb1-44ac-98c2-af63772d5af1" ], "EmailReceiverTeamsSelection": [ "f4995bd4-f55c-4133-99da-8ccdfbf263a8", "af4b823e-f456-45ae-987a-9a2e93cb775a" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "1ef02024-b7f7-458e-aa82-d0f525e6e651", "sample string 3": "1dc8f8d4-08dc-41f7-83e3-b40a2364587c" }, "EmailBody": "sample string 10", "id": "204d6853-0f2f-4a51-9dd3-1f55d3635759", "ConfigId": "6a9fdc2e-fa6c-4755-92ff-2ba0ace6f4bb" }