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": "138738da-25c3-4ad9-9f16-d06abcc5e3a3", "Global": true, "TriggerType": 0, "OnField": "d8086cac-77f0-4a5f-b8b8-8f418f9045dd", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "408397d3-9dd1-4522-b0b7-a09e02a12892", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "d205438b-c371-41cd-b354-09446440e8cf", "89c77d74-7401-43a6-a2d1-d5986c17348a" ], "EmailReceiverTeamsSelection": [ "52b19b44-72c5-41e3-8f69-053a5fe731c0", "efbe3cc4-2c81-4fd2-bf92-767c3d78453f" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "b90849c1-2fe8-4ee5-be59-5f1ebe7083a4", "sample string 3": "68b99146-367c-4ef8-af2e-898b1dd5e06e" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "ff6a83d6-e23b-4432-8fd3-fc12935dad99", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "0cbfc251-b6cb-4da9-a010-b6b1a5641768", "_ts": 638925189102426283 }
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": "6ec6bb17-e21f-4bb7-aa67-565ca5137ba6", "Global": true, "TriggerType": 0, "OnField": "5ef2d60c-047d-4689-9317-d798d8e0ae24", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "2a0954e9-85ca-4d84-a74e-0291a12b8ec3", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "c1ea1201-bf05-4c62-bb0f-584a366daff4", "5929068b-d13a-46e6-9324-84cb50214499" ], "EmailReceiverTeamsSelection": [ "0f1bca3e-9d85-44e3-a4fe-97d63764e566", "b4d06597-2cf3-4663-87f6-ad8eaf5cf7f9" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "b63bc8aa-2c4d-43ce-905d-2cfb03674322", "sample string 3": "10da8e52-bb16-4f7f-8134-7aa2b2529f02" }, "EmailBody": "sample string 10", "id": "fc79422d-6dfb-4b94-9f9f-6d64cec8936f", "ConfigId": "4ba611e8-6577-4b2b-8483-82cd5a7d4eae" }