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": "a5a13948-5c9c-4436-b4d0-9b1c49445318", "Global": true, "TriggerType": 0, "OnField": "c1960276-cc9d-4204-b9a1-0ffe47c30ec6", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "28586c1e-ad3c-4459-a0de-888bdf0af4f1", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "98cbe155-9680-4a00-9421-a43273f8c9d6", "f5299895-569d-4105-8165-bd5bac161d96" ], "EmailReceiverTeamsSelection": [ "0a3b6218-ee9b-423f-91d0-853dced61317", "df8d573e-c40a-4881-bb9e-1aac5a02a196" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "85e989bc-c47c-44af-94b5-1e5fb1b4e3aa", "sample string 3": "f6eade5d-757f-499d-842f-52a51c1aa160" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "972c2179-ea73-401a-87a7-a39b702ea2ce", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "5318794e-c786-4a72-900e-fa1b3716279d", "_ts": 638925191839823668 }
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": "8d46189d-088c-4c8b-87da-376bbf8f3880", "Global": true, "TriggerType": 0, "OnField": "127bf90e-2f3c-482d-9314-8216b2102b20", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "bed4e2d9-0f7b-41e0-925a-dda2abf69d67", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "2e4b26c3-bca3-4e23-bf2c-56697aa9f937", "ca807b5e-f3a8-4ff9-9167-1929a1b5b09c" ], "EmailReceiverTeamsSelection": [ "a820a3bb-bc2c-4e8c-917c-ae3209f0b2ad", "50e34865-37f8-4a5b-ac39-68b9eb0f9c59" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "8f242b80-a9e0-4e39-b3c6-e5d0d3e4ce54", "sample string 3": "51c58708-e038-468e-9565-d5a9f78b1c73" }, "EmailBody": "sample string 10", "id": "c93eb6e1-da31-428d-b337-d4ce6bd4719f", "ConfigId": "fc3f3bcd-0298-46ed-ade0-ac56d27dc479" }