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

TaskNotification

Name	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": "7a17925e-1e70-45a9-8eea-21dc736ddc03",
  "Global": true,
  "TriggerType": 0,
  "OnField": "cdb51667-e6c2-4d89-8675-67f7035564f2",
  "FieldName": "sample string 4",
  "MatchingValue": "sample string 5",
  "WhenObject": {
    "WhenType": 0,
    "DayOfWeek": "sample string 1"
  },
  "Filter": "sample string 6",
  "EmailReceiverType": 0,
  "EmailReceiverFieldSelection": "cde22465-d467-4cfc-949a-d744e1ffe564",
  "EmailReceiverFieldSelectionName": "sample string 8",
  "EmailReceiverUsersSelection": [
    "4d9e790c-a894-48c8-aab0-30d2e2cfb1aa",
    "70ba24d6-f892-4c86-b715-41dfa2bb1fbf"
  ],
  "EmailReceiverTeamsSelection": [
    "96d81441-bbbc-4539-95a3-eb9b77105fff",
    "cf9a3ab8-1f9a-4268-8652-53d35373adfb"
  ],
  "EmailSubject": "sample string 9",
  "EmailFieldsSent": {
    "sample string 1": "3077fcdb-fdb9-4f55-99ce-c08814b7fcd0",
    "sample string 3": "af5109c5-9cb5-4ca5-8845-9eb583ed883a"
  },
  "EmailBody": "sample string 10",
  "__app__": "WORKPLANNER",
  "__entity_kind__": "WorkPlanner.Models.TaskNotification",
  "id": "ac93e6cc-99c1-4cf1-b062-385a9ab94c34",
  "RestoreFromId": "00000000-0000-0000-0000-000000000000",
  "ConfigId": "13e6e56a-51d8-44cf-a0bc-cf91d20725bb",
  "_ts": 638836259824163657
}

Response Information

Resource Description

TaskNotification

Name	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": "a59bebaf-f989-4140-99ed-c625693e76f9",
  "Global": true,
  "TriggerType": 0,
  "OnField": "141d3a4b-3806-4f33-af3c-a66444ff948b",
  "FieldName": "sample string 4",
  "MatchingValue": "sample string 5",
  "WhenObject": {
    "WhenType": 0,
    "DayOfWeek": "sample string 1"
  },
  "Filter": "sample string 6",
  "EmailReceiverType": 0,
  "EmailReceiverFieldSelection": "a66f687e-837c-4440-8a47-0dc9edcf5b0f",
  "EmailReceiverFieldSelectionName": "sample string 8",
  "EmailReceiverUsersSelection": [
    "ef88b10a-f824-4485-b27a-cedeee52df7b",
    "5f58fd12-3db9-4b63-8061-0fadc927e954"
  ],
  "EmailReceiverTeamsSelection": [
    "ab6a12be-711d-4ddd-a446-bec86e3bb518",
    "a75f3aa4-9993-44eb-8481-4c8c20017c80"
  ],
  "EmailSubject": "sample string 9",
  "EmailFieldsSent": {
    "sample string 1": "335751d0-ecbd-4bfd-bedd-9c5fe3faecf9",
    "sample string 3": "243e8e80-1261-4ed0-ad0f-00f090273edc"
  },
  "EmailBody": "sample string 10",
  "id": "36401e00-d23a-4f1e-a85d-6227460d93f7",
  "ConfigId": "5b3a24e3-c7e7-4584-ae17-b337ee303335"
}