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": "f60a9a5f-3354-4d92-b685-cf0398626b6a", "TriggerType": 0, "OnField": "797fa864-bc8e-4e83-842a-c6948757bd4c", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "a52a9663-4b65-423f-8639-cf58ec5c958a", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "11b7cb83-9d57-4254-89c1-f24c8686a822", "d8738f34-afd0-4c64-a77a-17e0094e08fa" ], "EmailReceiverTeamsSelection": [ "97839b95-1b45-4997-bf9a-c299677cbc15", "12a96e66-6908-4f3c-a297-981312755d56" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "da75b81f-cc37-493f-b2ab-fc76caa7573e", "sample string 3": "4c9f55cf-e379-4b1a-abf5-4a102ba8c0f7" }, "EmailBody": "sample string 9", "UserId": "8bc1d7f1-01d0-49af-af8a-c622ec84abf5", "PlanId": "91ca96dd-11b7-4aba-a7a2-b16b8458f287", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "87f00a1d-0615-4170-b348-0ad7fae54196", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "b71f0964-29aa-4a80-8df1-b562caa9a8b5", "_ts": 638936773954376723 }
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": "dfba390e-24c5-43a0-9a3b-5955561076e3", "TriggerType": 0, "OnField": "854e261f-83b8-4912-8905-eb051f7f0cdc", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "e91a7341-9fa9-486e-8c6c-510eecf08861", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "e3fc3d1a-46de-459a-a77e-d994f2dc3c33", "011bb7cd-75bd-40b2-81a8-d3435396b43b" ], "EmailReceiverTeamsSelection": [ "61e664b7-8ec4-4e56-99eb-06fd4342cbd1", "70445462-3254-47f1-9c7b-f7c1287e00f9" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "13f20f75-9aee-4dda-b7e3-4932070ee317", "sample string 3": "34ce2cb1-62e2-415b-ba86-4df69b269472" }, "EmailBody": "sample string 9", "UserId": "800a711f-4d6e-4684-b9d9-4a9a0da607b2", "PlanId": "6bf3d0ad-3e7e-45f8-895b-61efd95cd0cd", "id": "b2c5a5b3-c7d6-4c1f-b085-a436c5decf56", "ConfigId": "8acfa7b2-eaed-4650-ad0e-3a09f21dc28c" }