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": "3cdf9afd-452f-437b-a403-fee533e1075c", "Global": true, "TriggerType": 0, "OnField": "aec58fae-f299-4f2d-9904-70dfa0154718", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "9c88c831-621c-475d-9882-be74dd355e7f", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "6765641b-0216-4b10-9c1d-4d5596f93d90", "f6f9db01-3e24-47ff-9594-ce21e618b5d6" ], "EmailReceiverTeamsSelection": [ "bcad5030-7df7-4234-a093-33430fb2a9bb", "3863e21d-5a82-4051-b62b-d807e29375bb" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "d6e88552-3d2d-4ffb-929f-934f51199ca5", "sample string 3": "0f67c051-e90a-45f8-91e4-bd4c17f9a6e7" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "c601fe37-f297-4877-ba31-c9c63b209d97", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "27796e33-2559-4798-888e-eff32180d41e", "_ts": 638936881322999613 }
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": "870bc68a-051d-4bdb-81f5-d435466dfb57", "Global": true, "TriggerType": 0, "OnField": "693a8eb8-13b2-409e-8462-47f25f5e7f2c", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "a34a2681-6541-4168-a443-bed5174e74f0", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "548134d0-1e3b-4f9b-aeb0-d36908cf53be", "678c9cd9-bbc1-4aec-97be-de9af44b62d5" ], "EmailReceiverTeamsSelection": [ "10e83662-10b9-4e50-917f-9d568263b262", "6e867458-6909-46c5-93b2-163891d9fdf7" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "1f858a6e-8d9b-4250-9159-c777fbcf58a6", "sample string 3": "3d9325ca-efd3-46a7-be1e-fde014a60319" }, "EmailBody": "sample string 10", "id": "94c7d9bb-4ff0-499b-9968-5fd497e5eb8a", "ConfigId": "7acb2afc-f9ff-4f70-99a6-be1d9a8140b5" }