POST api/notifications/task/{planId}/create
Create a Task Notification by configuring a TaskNotification object and passing in the Plan Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
planId | globally unique identifier |
Required |
Body Parameters
TaskNotificationName | Description | Type | Additional information |
---|---|---|---|
PlanId | globally unique identifier |
None. |
|
Global | boolean |
None. |
|
TriggerType | TriggerType |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | EmailReceiverType |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
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. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "PlanId": "7895ffc9-26c7-4009-b409-bde54dd7a525", "Global": true, "TriggerType": 0, "OnField": "2000422d-8cf6-497d-a962-c2f497520c80", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "6a421d25-a6e1-4bed-b578-bb6e975540c4", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "338bd3a6-2994-47ef-b655-ee32358986d8", "b151053e-42eb-4787-bf77-c0298b5f386e" ], "EmailReceiverTeamsSelection": [ "23680f1a-bf30-4f1e-8fd9-9b613cb306d3", "bda210b0-6dc8-43b2-bd73-0bb2c053a703" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "9258e71f-8c64-40a2-ae19-ab661ca89447", "sample string 3": "7acc5359-f61c-4af7-9ba2-5811ac2b8dbc" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "c04d59f2-85ab-413b-aec7-abcaeb5ee013", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "0e25cbb7-a2b3-46c3-8232-0e2657ec7dfc", "_ts": 638884802475912527 }
Response Information
Resource Description
TaskNotificationName | Description | Type | Additional information |
---|---|---|---|
PlanId | globally unique identifier |
None. |
|
Global | boolean |
None. |
|
TriggerType | TriggerType |
None. |
|
OnField | globally unique identifier |
None. |
|
FieldName | string |
None. |
|
MatchingValue | string |
None. |
|
WhenObject | WhenObject |
None. |
|
Filter | string |
None. |
|
EmailReceiverType | EmailReceiverType |
None. |
|
EmailReceiverFieldSelection | globally unique identifier |
None. |
|
EmailReceiverFieldSelectionName | string |
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. |
|
id | globally unique identifier |
None. |
|
ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{ "PlanId": "959cdd65-c512-4514-8ed8-2c6eee93a708", "Global": true, "TriggerType": 0, "OnField": "7c13beea-d669-48c2-a90c-64c189ebcd3b", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d3410137-c6bb-42c9-b463-bc62e084acca", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "62bc165d-109f-4abe-986c-58d3368ae9f1", "19c2bd77-f371-47ef-ba47-cf9ee55258f5" ], "EmailReceiverTeamsSelection": [ "e0412d12-b89e-40b6-83f3-f4cbefe60acf", "6d249d63-3822-4dc5-a924-ec6cdbeb7485" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "bab6ccf4-40b1-42f8-9f00-29b3f390d240", "sample string 3": "432668ac-f5b6-4cb1-b568-04a8cdb983d8" }, "EmailBody": "sample string 10", "id": "c192f725-cecb-4811-9a23-f5d0fdd20065", "ConfigId": "f2b64099-04f2-4061-905a-737e730774ea" }