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": "a4f1b1bd-d26e-4b87-90c3-d04119e5751b", "Global": true, "TriggerType": 0, "OnField": "98fead7a-6477-40e2-bf6f-5c4cadcccce7", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "c899614e-b94a-4d0a-92a1-e96b15ebb6fd", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "481d72c0-29cb-4b29-b309-f90549552d26", "ec41aa66-0343-4f4c-a33b-9ad8fb5a0d53" ], "EmailReceiverTeamsSelection": [ "1c6653a0-52dc-455c-a51b-5f5b4a8088b0", "ccd62f28-0aef-47d6-983f-1e9324d91071" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "d9a9a71d-f44b-44f9-850e-35873ea6c0a0", "sample string 3": "4c6a4007-dc54-4bfd-bb1f-2d404813aef8" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "ab48b60f-337e-4c64-8716-b4fc39ff8f32", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "70181c4d-6312-432a-be09-d79260cc11af", "_ts": 638874477872594159 }
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": "29b2e911-e758-488e-9032-ba2bc4333c53", "Global": true, "TriggerType": 0, "OnField": "babe3ce9-46cb-4f66-8333-97b0a88ffbf7", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "d2adb201-751e-4585-a114-dfdd926f96f3", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "bfe73c81-78cf-43df-a656-8ceb98c1e805", "0098edd8-81b1-4327-8b0e-6917e0034c9f" ], "EmailReceiverTeamsSelection": [ "afeec172-96ff-4204-8393-9acdda61f186", "52b61858-340f-45c0-b8e3-95f457ba9765" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "8e323350-7003-4922-9b8e-552ce86793c1", "sample string 3": "eef8bbd5-a95e-449c-9f52-c363aef5796d" }, "EmailBody": "sample string 10", "id": "7bb36210-5601-4e85-af41-0700cf1ac92f", "ConfigId": "b4625d36-74f4-4375-a45b-6a53165cc1fa" }