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": "4d00cccf-6a63-4de2-a641-7f9b69bc3bdb", "TriggerType": 0, "OnField": "51a008ff-adc8-4891-afe2-d7524b31ee66", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "2c2fd6cc-4465-410c-b01a-fb2fe1b68efc", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "7f60a544-8f01-459d-b138-398c7fba1ee5", "c54869ed-b235-4763-a3de-8da253b5ead0" ], "EmailReceiverTeamsSelection": [ "76963d72-9313-4f31-ab19-6aefae437ced", "63ab9be6-2b98-4bc4-a743-5648ece3d61a" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "0bf8c04b-7a13-4b7c-8fb8-bd70c132c8ca", "sample string 3": "897a0109-cdfa-4c8a-bd2f-7c21c81ece0d" }, "EmailBody": "sample string 9", "UserId": "425f50ec-b27d-4ca5-8cec-06e180b1c1b6", "PlanId": "c1f51376-ab22-46ee-ad81-c6bc628e13b7", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.PlanNotification", "id": "24aa01d3-8600-4185-bf67-e61720d021f4", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "2f0144d9-f6ad-4e0d-a20a-19d9fb8e0819", "_ts": 638925192327195107 }
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": "d176fa88-de86-41c3-b2a8-52e7c41faa73", "TriggerType": 0, "OnField": "c3b392a3-7dde-4ebe-ba3a-263a99649393", "FieldName": "sample string 3", "MatchingValue": "sample string 4", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 5", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "363fcab1-12e8-4cf1-962f-b0f8e53d95e7", "EmailReceiverFieldSelectionName": "sample string 7", "EmailReceiverSharedWithLevels": [ 0, 0 ], "EmailReceiverUsersSelection": [ "977d81bb-9486-4335-8e72-11988cd35a8a", "0fbcf871-c423-4d7a-a440-158ac7c846db" ], "EmailReceiverTeamsSelection": [ "572fffe0-dfdc-4b2d-9bcf-675367913fdd", "0d838b5a-763a-421e-976b-db4a9897b0f5" ], "EmailSubject": "sample string 8", "EmailFieldsSent": { "sample string 1": "30038186-d4d7-4d45-b1ae-e7b49908772a", "sample string 3": "599bf74c-cdbb-4de9-a482-1dd09ed7574e" }, "EmailBody": "sample string 9", "UserId": "13c72433-c844-4938-993e-beb01e9ea592", "PlanId": "5a79b649-8dfa-4f49-a7bf-d3f71acbbbe3", "id": "e1846089-e82f-4b80-9b81-9ea975bc74ff", "ConfigId": "8a6850c0-1070-4649-8e36-8a8cc9126ce7" }