POST api/notifications/task/{planId}/list

Get Task Notifications for a specific plan. Will also return Global task notifications if the user has sufficient permissions.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
planId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of TaskNotification
NameDescriptionTypeAdditional 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": "998bffff-86ef-4e39-9ee1-b85266728a16",
    "Global": true,
    "TriggerType": 0,
    "OnField": "a157a113-6f26-4909-96bd-24323367ec92",
    "FieldName": "sample string 4",
    "MatchingValue": "sample string 5",
    "WhenObject": {
      "WhenType": 0,
      "DayOfWeek": "sample string 1"
    },
    "Filter": "sample string 6",
    "EmailReceiverType": 0,
    "EmailReceiverFieldSelection": "d25e7326-ab8a-4617-bbd4-f0cc6ea010d4",
    "EmailReceiverFieldSelectionName": "sample string 8",
    "EmailReceiverUsersSelection": [
      "bd0eee2f-c0a9-42c6-9422-dc39c67b134b",
      "cdcffe47-6c96-4a38-8400-07804ae85a31"
    ],
    "EmailReceiverTeamsSelection": [
      "b02b230c-9778-4f9d-b1de-5d66bfd52446",
      "f25a0ee9-fc59-4710-bfb4-971a228a9bff"
    ],
    "EmailSubject": "sample string 9",
    "EmailFieldsSent": {
      "sample string 1": "f29a8f7e-dc19-4415-b248-773356acffcd",
      "sample string 3": "b70c7d8e-cb58-46f2-a084-7c4758f92117"
    },
    "EmailBody": "sample string 10",
    "id": "220ef818-0b26-4a8e-b6e3-c2d9cb06676c",
    "ConfigId": "6bfa2fc4-1086-436c-8be2-da80bcfd12d7"
  },
  {
    "PlanId": "998bffff-86ef-4e39-9ee1-b85266728a16",
    "Global": true,
    "TriggerType": 0,
    "OnField": "a157a113-6f26-4909-96bd-24323367ec92",
    "FieldName": "sample string 4",
    "MatchingValue": "sample string 5",
    "WhenObject": {
      "WhenType": 0,
      "DayOfWeek": "sample string 1"
    },
    "Filter": "sample string 6",
    "EmailReceiverType": 0,
    "EmailReceiverFieldSelection": "d25e7326-ab8a-4617-bbd4-f0cc6ea010d4",
    "EmailReceiverFieldSelectionName": "sample string 8",
    "EmailReceiverUsersSelection": [
      "bd0eee2f-c0a9-42c6-9422-dc39c67b134b",
      "cdcffe47-6c96-4a38-8400-07804ae85a31"
    ],
    "EmailReceiverTeamsSelection": [
      "b02b230c-9778-4f9d-b1de-5d66bfd52446",
      "f25a0ee9-fc59-4710-bfb4-971a228a9bff"
    ],
    "EmailSubject": "sample string 9",
    "EmailFieldsSent": {
      "sample string 1": "f29a8f7e-dc19-4415-b248-773356acffcd",
      "sample string 3": "b70c7d8e-cb58-46f2-a084-7c4758f92117"
    },
    "EmailBody": "sample string 10",
    "id": "220ef818-0b26-4a8e-b6e3-c2d9cb06676c",
    "ConfigId": "6bfa2fc4-1086-436c-8be2-da80bcfd12d7"
  }
]