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": "23a9f95b-34c8-40e4-b56a-26fc8f1fdeb4", "TriggerType": 0, "OnField": "8145cc84-5fa9-4a45-8463-a03531f2f581", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "871b869a-1886-4bb5-88a5-ca706fbfd9b8", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "fabfff4a-9df5-4f15-88b3-f470b657a386", "b7c57b73-0910-468a-bdb6-f5e4d1bbc61a" ], "EmailReceiverTeamsSelection": [ "712c5556-ec52-4539-add8-db9a6efcdc31", "adca7eb1-4f3b-4f88-9591-7c04a7ddf84b" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "82d7e8ed-3215-4ab8-862e-dd60fbb69f33", "sample string 3": "ab994751-68b1-4d75-92aa-2dd088bcf84d" }, "EmailBody": "sample string 9", "UserId": "4bc5d1b8-d87d-484a-8a1b-493539943c87", "PlanId": "e2771102-ae6d-4ad0-bb27-5288a1827cab", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "31862a7f-acf0-47e2-bf82-f85f96692efe", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "f1fabab6-0eaf-4869-a3f3-3fe36ea4dd08", "_ts": 638875977242789018 }
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": "60616abe-608e-41b4-9a8e-3b4169daa5ab", "TriggerType": 0, "OnField": "a99555c0-955c-4295-91e9-5b05f5322552", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "38e6c657-5195-4694-b271-a7f0dba7fc49", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "1fd7f067-1ac5-467b-9bb2-28dd564e47fd", "bc752235-8feb-4ffd-b2a0-8f814748f09a" ], "EmailReceiverTeamsSelection": [ "19736a0b-1090-4d01-85fd-fcbecb58a500", "ba58f02b-012c-42fa-9487-91134ee248a8" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "d2419b20-38a3-414d-b68a-174c66cf83c1", "sample string 3": "f4c78763-3363-47dd-8478-cfd1a4b89ede" }, "EmailBody": "sample string 9", "UserId": "ffd74205-6da7-4e0f-8cab-35479ea513b8", "PlanId": "f0de21e6-65ae-4cf3-8d49-0e5348a556f5", "id": "80d5ba09-ed1a-4f55-b233-12cc66c0bb1b", "ConfigId": "b7161300-45ad-425f-ae49-c9ec16423ffe" }