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": "ffafdcb0-1cb4-4fa5-9399-620208feaa8b", "TriggerType": 0, "OnField": "13bf0b6f-8c36-4bcb-8d75-8b23c58a3bc9", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d949657e-a71d-4f12-a0aa-af55636f7482", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "0a43898c-9ab2-495f-99e3-500e4e6f6d46", "5ad59c21-e453-4f3f-85a9-7fe11d7d68ed" ], "EmailReceiverTeamsSelection": [ "3e5657e7-52e4-41c4-b787-f7b0f5407a86", "835386c5-3c28-42f2-94e2-22b58fda8e3b" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "9bb158a8-2d74-4b91-8947-4158706f8a71", "sample string 3": "259bbe3a-7cf4-4363-849e-9547ce16c1ac" }, "EmailBody": "sample string 9", "UserId": "cede0b69-1f37-4fd1-ae2a-e53a5d47f845", "PlanId": "957259ab-4aaa-4676-98d1-7b2fb3f23c8e", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "e4b9165c-9d6a-4564-a5b0-3b3d26a6954d", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "efe2dc26-4519-4855-80f2-e71445aa7468", "_ts": 638878964555869088 }
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": "4c00962b-d730-4e18-b888-a2faa64c7a78", "TriggerType": 0, "OnField": "1cbe7cd2-53d5-495c-9d7a-9701dcd0fe78", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "992808cc-5c42-4380-abea-8866bfa73eed", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "180c32a4-dbcd-442a-96a3-64082bf7bdba", "7e5f452b-5765-4cdb-900a-aa10c1930a99" ], "EmailReceiverTeamsSelection": [ "0cfcf099-1c98-4d07-b52c-11155dae8457", "9999ae23-cf57-49d8-8598-e9a968c4d9be" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "fd672a71-956d-489d-8dba-e9eaeedd0872", "sample string 3": "2333b9ec-e267-4af9-bd1b-74ab9d683389" }, "EmailBody": "sample string 9", "UserId": "984d8d6b-3d22-4d8b-96bf-e98e64e28dca", "PlanId": "42f8ec3d-1acb-4462-9b88-439793ab4b75", "id": "26384d49-5938-470c-975c-132bb1616bd3", "ConfigId": "9978849c-3e6e-40e1-a1a6-64b261f6aabf" }