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": "8d84e918-24b6-4509-ae2c-e06f28760d1a", "TriggerType": 0, "OnField": "3d0da1c6-9ff7-4c53-a1a3-80f4294fe467", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "879734d5-80e9-48ae-a2fb-2465edeb89ff", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "f303fe38-8335-41d0-9bb1-e9cfe009c95b", "8c0ead13-956c-4101-a170-2de8df92b377" ], "EmailReceiverTeamsSelection": [ "3d927997-c87f-4225-a5d9-1764cc17d3f3", "bf4a3404-2e4d-4508-aabf-7d09065e1ab7" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "d2891e2a-7724-4845-9568-c3fa5cd50279", "sample string 3": "7dae0e39-ac34-4406-aaa7-3d3d0a59c3a7" }, "EmailBody": "sample string 9", "UserId": "01af6773-2d55-40e9-a924-c552136540fe", "PlanId": "8181ed4f-4feb-4820-be39-776a7ccdb94a", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "172816da-29ad-46da-9bdc-dc25bfea150c", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "4de50a32-738a-4a72-a91c-65e0c05788e1", "_ts": 638925192773573928 }
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": "41a0e72a-1708-4213-b823-e655dac0b92c", "TriggerType": 0, "OnField": "8f587da8-df10-4f49-a8c5-f17ad489c049", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "1e81335e-c3d2-4b91-a2d7-09ff9021624c", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "be712066-f16b-4993-9d27-f41e62c5ea53", "0c363061-9874-4923-97e1-dd051814818f" ], "EmailReceiverTeamsSelection": [ "ed3e7fcf-acc1-47f2-87df-d1248c5b80a5", "7ede0e56-8e5b-4109-a9b4-2236fcde5430" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "64a46f12-7801-4751-b91b-5ba4cbbfebac", "sample string 3": "f14fca73-29b7-47dd-be5d-f3e9ff721933" }, "EmailBody": "sample string 9", "UserId": "7dd13ee5-14b7-4d21-9265-9cf6e5226ed3", "PlanId": "9b95c5ea-ed37-4c34-8973-187ec2166929", "id": "1edf009d-2c18-457d-b8ce-fb3977d852cc", "ConfigId": "df8dc2a6-6c9d-4e22-a611-d4f3a1a811ea" }