POST api/notifications/plan/{notificationId}/update
Update a Plan Notification by configuring a PlanNotification object
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
notificationId | string |
None. |
Body Parameters
PlanNotificationName | Description | Type | Additional information |
---|---|---|---|
NotificationScope | NotificationScope |
None. |
|
PlanType | globally unique identifier |
None. |
|
TriggerType | PlanNotificationTrigger |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | PlanNotificationReceiver |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
None. |
|
EmailReceiverSharedWithLevels | Collection of AccessLevel |
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. |
|
UserId | globally unique identifier |
None. |
|
PlanId | globally unique identifier |
None. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "NotificationScope": 0, "PlanType": "baddc217-f255-40f7-bd8e-ee5628f95902", "TriggerType": 0, "OnField": "c07e89ef-e374-4394-85f1-e09520f45e2e", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "195df574-6796-4873-9b0b-62225abcba1d", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "97813293-3b74-420c-93b1-4d7c676b711d", "399c5e80-e46f-44a4-bf88-5bf580b02631" ], "EmailReceiverTeamsSelection": [ "11802e45-b5aa-428f-aca6-67cafdd5daff", "927e9c24-0c28-4470-964d-44421955edce" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "b39a45e3-717d-4657-b85e-413687af3b7d", "sample string 3": "0791d9b3-5929-4e1f-9ceb-fbce5efbb41b" }, "EmailBody": "sample string 9", "UserId": "8c631ce7-c5e4-4b6f-b2ac-3ef2bd8078a6", "PlanId": "52e8deb4-830c-4576-a86a-b0db35e743ab", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "e6e4e8c8-2319-47ad-bdd8-01a90841e102", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "9d036667-c720-47c6-92b1-726c94e54932", "_ts": 638936067953156878 }
Response Information
Resource Description
PlanNotificationName | Description | Type | Additional information |
---|---|---|---|
NotificationScope | NotificationScope |
None. |
|
PlanType | globally unique identifier |
None. |
|
TriggerType | PlanNotificationTrigger |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | PlanNotificationReceiver |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
None. |
|
EmailReceiverSharedWithLevels | Collection of AccessLevel |
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. |
|
UserId | globally unique identifier |
None. |
|
PlanId | globally unique identifier |
None. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{ "NotificationScope": 0, "PlanType": "e816d1bc-a783-43c0-b8a3-5023da6be0fe", "TriggerType": 0, "OnField": "41e07132-8cad-4500-b59f-9ae4416e2a6c", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "229f080e-b032-4c7c-bc49-6a436ca1c13a", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "01b68008-c437-4897-8bd7-e432fc7df77f", "7c53218b-a5ef-4cdf-86ba-c2b9ff14978f" ], "EmailReceiverTeamsSelection": [ "6d2adc70-f2ce-4de1-b291-8b016767ef70", "b79786ab-ac81-4ed9-8475-53a27e97130f" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "7221ffba-a130-4983-a74c-5f92c608da87", "sample string 3": "820a8ea4-fbb3-4f13-bb7c-ab9246b31eaa" }, "EmailBody": "sample string 9", "UserId": "6f197f61-7f2f-48dd-bb50-7233e3f3080b", "PlanId": "5ba7a740-1d6d-4c7f-a3d0-2315d49f22b8", "id": "645e893f-f382-4bab-8f1a-2325574948f6", "ConfigId": "804c10b0-e116-4d3b-8c35-00a4f18d695c" }