GET api/GenerateNotification

Generates a notification digest based on user-specific task and workflow rules.

Request Information

URI Parameters

None.

Body Parameters

The notification configuration object containing user ID, group IDs, client name, and a list of rules to evaluate for generating the notification digest.

NotificationInfo
NameDescriptionTypeAdditional information
rules

Collection of notificationRule

None.

usrID

integer

None.

useridx

string

None.

userGroups

string

None.

client

string

None.

limitToActions

boolean

None.

Request Formats

application/json, text/json, application/scim+json

Sample:
{
  "rules": [
    {
      "type": "sample string 1",
      "frequency": 2,
      "occurance": "sample string 3",
      "field": "sample string 4"
    },
    {
      "type": "sample string 1",
      "frequency": 2,
      "occurance": "sample string 3",
      "field": "sample string 4"
    }
  ],
  "usrID": 1,
  "useridx": "sample string 2",
  "userGroups": "sample string 3",
  "client": "sample string 4",
  "limitToActions": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NotificationInfo'.

Response Information

Resource Description

On success: HTTP 200 OK with a dataset containing matching tasks and workflows. On failure: HTTP 400 Bad Request with a generic error message.

DataRowResponse
NameDescriptionTypeAdditional information
dataInfo

DataSet

None.

Response Formats

application/json, text/json

Sample:
{}

application/scim+json

Sample:
{
  "dataInfo": null
}