POST api/notifications/plan/create

Create a Plan Notification by configuring a PlanNotification object

Request Information

URI Parameters

None.

Body Parameters

Name	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": "0e1fd664-839d-4e10-a0af-d1aa14cd5788",
  "TriggerType": 0,
  "OnField": "92a145c2-ffe0-4db9-81eb-f29fa4e67f98",
  "FieldName": "sample string 3",
  "MatchingValue": "sample string 4",
  "WhenObject": {
    "WhenType": 0,
    "DayOfWeek": "sample string 1"
  },
  "Filter": "sample string 5",
  "EmailReceiverType": 0,
  "EmailReceiverFieldSelection": "b705838f-0904-47dc-9f45-130d4b4bbdc0",
  "EmailReceiverFieldSelectionName": "sample string 7",
  "EmailReceiverSharedWithLevels": [
    0,
    0
  ],
  "EmailReceiverUsersSelection": [
    "34cb36b2-d835-46ab-841c-afb8611d2d4b",
    "f30322d6-cd43-4f92-9276-34d519863671"
  ],
  "EmailReceiverTeamsSelection": [
    "6b7add93-94ac-4a1e-80f8-d12cd446bb9c",
    "be87ac31-ba76-4ee3-9699-2adfe7af83e1"
  ],
  "EmailSubject": "sample string 8",
  "EmailFieldsSent": {
    "sample string 1": "b3bbc2e3-3e8b-43e7-a7af-5a55e86083b5",
    "sample string 3": "731cbc10-eb73-4c09-aa24-b3c3d9962736"
  },
  "EmailBody": "sample string 9",
  "UserId": "9f623f2d-a6df-4624-b424-51906d7935c5",
  "PlanId": "dbc61bad-4845-47f2-b8ff-b66c63620b02",
  "__app__": "WORKPLANNER",
  "__entity_kind__": "WorkPlanner.Models.PlanNotification",
  "id": "3a989e55-0aa0-4a19-b493-6aecebb72ece",
  "RestoreFromId": "00000000-0000-0000-0000-000000000000",
  "ConfigId": "2de38ab3-deb2-4a64-9dc9-831d38a5b908",
  "_ts": 638701497100162775
}

Response Information

Resource Description

PlanNotification

Name	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": "5b842c40-bce3-4bdb-b1da-dd5326e9dca4",
  "TriggerType": 0,
  "OnField": "baa1df45-c80f-45ca-81d2-6ac032b8bf4f",
  "FieldName": "sample string 3",
  "MatchingValue": "sample string 4",
  "WhenObject": {
    "WhenType": 0,
    "DayOfWeek": "sample string 1"
  },
  "Filter": "sample string 5",
  "EmailReceiverType": 0,
  "EmailReceiverFieldSelection": "032c38c2-a782-4965-90d6-42a859389327",
  "EmailReceiverFieldSelectionName": "sample string 7",
  "EmailReceiverSharedWithLevels": [
    0,
    0
  ],
  "EmailReceiverUsersSelection": [
    "e20231ee-fd96-4509-9d53-69e9207d8ba3",
    "e37e7f6a-8f4f-4676-b36c-f95455dd0c84"
  ],
  "EmailReceiverTeamsSelection": [
    "ad9d0541-6855-4405-a934-f8784e5b0b0d",
    "dfed57e2-608b-4bc8-97f2-086c93cab7b2"
  ],
  "EmailSubject": "sample string 8",
  "EmailFieldsSent": {
    "sample string 1": "00b9ba4b-1e2e-42f8-bbd6-7d3082957ad6",
    "sample string 3": "85b2f1d1-b0e1-4a03-96d0-b1339499bdff"
  },
  "EmailBody": "sample string 9",
  "UserId": "45f80e92-d2e5-445f-a14a-08a19954f547",
  "PlanId": "0993f660-6566-4e9f-b31a-f19c8685b21d",
  "id": "48d3a666-c501-4924-b175-2e667ef2ed7e",
  "ConfigId": "729d7960-58fa-40b5-b865-a4babcf88afc"
}