Notifications

Get Notifications

GET https://[customer].testresults.io/api/notifications

Gets all notifications.

Headers

Name	Type	Description
Authentication	string	Authentication token

200 Cake successfully retrieved.

[
  {
    "Source": "Customer",
    "SourceId": "00000000-0000-0000-0000-000000000010",
    "Target": "Project",
    "TargetId": null,
    "Action": "Created",
    "State": "None",
    "DataVersion": "AAAAAAAzeLc=",
    "Archived": false,
    "Id": "8354d266-1487-4dac-af4f-639ce2cab26e"
  }
]

Add Notification

POST https://[customer].testresults.io/api/notifications

Adds a new notification.

Headers

Name	Type	Description
Authentication	string	Authentication token

Request Body

Name	Type	Description
Source	string	source entity (e.g "TestCase")
SourceId	string	ID of source entity
Target	string	target entity (e.g "TestReport")
TargetId	string	ID of target entity
Action	string	related action (e.g "Created")
State	string	related state (e.g "Submitted")

200

{
  "Source": "Customer",
  "SourceId": "00000000-0000-0000-0000-000000000010",
  "Target": "Project",
  "TargetId": null,
  "Action": "Created",
  "State": "None",
  "DataVersion": "AAAAAAAzgGE=",
  "Archived": false,
  "Id": "5639ab63-0fef-4104-8510-556587a32708"
}

Remove Notification

DELETE https://[customer].testresults.io/api/notifications/:nId

Removes notification.

Path Parameters

Name	Type	Description
nId	string	ID of target notification

Headers

Name	Type	Description
Authentication	string	Authentication token

200