POST api/notifications/plan/create
Create a Plan Notification by configuring a PlanNotification object
Request Information
URI Parameters
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": "cbc7221f-7b31-426a-b5f5-6af7cdf72869", "TriggerType": 0, "OnField": "4e38f833-029c-4a78-9294-b4db3c4bd662", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "34968981-2541-4bc8-88cf-06a0363fee10", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "279c0514-3568-4601-8d67-9c3ce1911840", "c28a810b-c9c3-4813-a7a5-26477d946d1e" ], "EmailReceiverTeamsSelection": [ "0646746e-1f44-4e97-81ca-08f52bebdba1", "db04f827-67f9-4e64-9977-094e907bd02d" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "735cd6ac-a4da-4abc-9c86-24f058cba412", "sample string 3": "8ce509b8-9f73-4f28-a1fc-659549fa83b9" }, "EmailBody": "sample string 9", "UserId": "26b4303b-b738-48e0-97be-be43fadab643", "PlanId": "e80c3ba4-b34f-45b3-bf66-f21ac8a46e52", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "ffc99201-c594-439a-8dd0-effa39e4f6f1", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "94088c71-8f42-4f90-a713-a458943209d3", "_ts": 638878858768716610 }
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": "e566af28-7c75-4b72-aaa3-d1e9ff760f0e", "TriggerType": 0, "OnField": "10150cc6-230e-4915-a76f-dec53d6168b6", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "20b73a61-591f-483c-8054-2c3820a7df9e", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "7108b2cd-2374-4b80-8de0-5c6349825228", "d1d39c64-4414-4eaf-9e38-658b87428602" ], "EmailReceiverTeamsSelection": [ "4b6ffec6-b0e6-4786-bb80-feb7364486a5", "d725bf03-f4df-4cbb-bdb5-8d7d4fa73693" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "8a955e45-172c-4817-8831-58d34484a755", "sample string 3": "ff9ff8cd-3c6f-4d5e-93a5-8b23d3920eaf" }, "EmailBody": "sample string 9", "UserId": "12d0fd65-d5ab-4afe-90e5-e1fec7ffc070", "PlanId": "cfe8cabe-8aef-4f2d-b6c2-fae6434cf2f7", "id": "870bd7aa-d345-425b-b713-fbf27bd4e4e6", "ConfigId": "1e1f6f23-d131-4d1e-af2a-c41fc6e407f2" }