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": "7e09ac69-9c30-4768-8aa4-a8698bbc87d1", "Global": true, "TriggerType": 0, "OnField": "a4615185-df5f-4e97-9f44-dff419ddf130", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "6967d80c-dde9-4111-ace2-eddca47cf444", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "503b19e3-d6e6-4300-8c9e-cf23b436bf31", "2e032fdb-06b4-42be-8b27-31eb37dd8868" ], "EmailReceiverTeamsSelection": [ "cafe5ac9-a638-4a72-ab96-2802eedd8954", "3133291d-7da5-4a69-9c99-a02f2fe65b58" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "921a3c30-5e25-486b-878c-62d017869728", "sample string 3": "d9fc88a4-0d2a-4e82-bfe4-006a9e073bde" }, "EmailBody": "sample string 10", "__app__": "WORKPLANNER", "__entity_kind__": "WorkPlanner.Models.TaskNotification", "id": "b789ff0d-f98e-4cb7-9d45-8d4b799d5fbe", "RestoreFromId": "00000000-0000-0000-0000-000000000000", "ConfigId": "27278908-9394-4d1a-befd-296463f44493", "_ts": 638875631487437083 }
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": "7a5f0612-f29c-4d8e-8f55-836355409830", "Global": true, "TriggerType": 0, "OnField": "dae9100e-c02b-4d4d-b525-416a2f60d95f", "FieldName": "sample string 4", "MatchingValue": "sample string 5", "WhenObject": { "WhenType": 0, "DayOfWeek": "sample string 1" }, "Filter": "sample string 6", "EmailReceiverType": 0, "EmailReceiverFieldSelection": "4c8db15c-87e6-4fb3-a663-f97af5165669", "EmailReceiverFieldSelectionName": "sample string 8", "EmailReceiverUsersSelection": [ "b3384c9c-f954-4687-825b-c85ff886f0ad", "7cf77f2c-2582-4b49-873a-4f1687ea4e29" ], "EmailReceiverTeamsSelection": [ "4f8c2994-3348-4090-a26f-04d04fbfc5d6", "9ec5b16d-f585-4808-860b-2e186b14165c" ], "EmailSubject": "sample string 9", "EmailFieldsSent": { "sample string 1": "7628a6e8-f5ac-42b3-a6c7-9fbbfd7e4687", "sample string 3": "c5e4887a-3171-461b-80a4-c88b0f6ba73a" }, "EmailBody": "sample string 10", "id": "410ef636-0d45-4adc-85c6-59e7f14f091d", "ConfigId": "9c2faf04-f9cc-4dc8-a57c-1b442184a37a" }