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": "7f1c0672-0fca-474d-8728-58453da2a6be", "TriggerType": 0, "OnField": "f8278f77-4a41-4fe3-b43f-50f97f732bb9", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "94222dcf-6dc1-4644-b81b-cffe02512f4b", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "3fc22765-8f1b-4ac7-9755-d070fbb58958", "c944b7a4-8692-4e6e-936f-f3871aa54785" ], "EmailReceiverTeamsSelection": [ "1dd18b17-008a-4d32-94e8-07194e0ab0d8", "40c5fc25-c834-44c9-b926-525b06f36218" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "f465e045-aca4-41d2-ba2d-b7377aefff1e", "sample string 3": "2d617449-4770-479d-8d39-277233b76082" }, "EmailBody": "sample string 9", "UserId": "35cbb232-19ab-4e94-9f10-dc52e112b36e", "PlanId": "0198d79b-9f6d-466e-947d-677a4213c1ac", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "30748788-2ba8-4aa9-a2df-3f068c872eb1", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "d7d295fa-e1ef-40ce-b310-bd50d5a01411", "_ts": 638875958484668964 }
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": "c63cdc81-9f22-462c-955c-a7f54ef50121", "TriggerType": 0, "OnField": "354e64ee-fbb3-4d83-86c5-081c2c421b4d", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d2658ebe-04c3-4590-aaba-7a4c1b0127f9", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "b4d7ab91-5f66-46b1-861a-c8f2a31c7ece", "c9603b3f-1464-4ac9-ae28-acee4cfdfe6f" ], "EmailReceiverTeamsSelection": [ "3e5f308c-181d-4e3f-94c9-988e707765a4", "da10e2db-19c7-48ff-ba6a-bf43bc66a1c6" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "6ab0e7d3-bf6c-4506-8759-6a043fc6a3f9", "sample string 3": "d40083bc-865f-4860-a3de-7990e816f23d" }, "EmailBody": "sample string 9", "UserId": "ae76be37-2b1a-40a4-8d9f-8ea40214d87a", "PlanId": "19409413-c57e-46ab-8e44-37357f5820a5", "id": "cfefa080-07ee-4149-bac5-7fd4b6f22295", "ConfigId": "623b109c-0f5b-4695-8531-e4e4ed879ef5" }