Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/scheduledEmailReport/list


Descriptor

Value

HTTP Method

GET

Description

Retrieves all scheduled email reports.

Required Permission

Manage Email Reports (Global level)

Version Introduced2.7.4


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Sample Call:


Code Block
themeEclipse
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/scheduledEmailReport/list


Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 15,
            "hour": 0,
            "minute": 0,
            "period": "",
            "day": "",
            "frequency": "",
            "scheduleType": "CRON",
            "cronExpression": "0 6 * * ?",
            "severityLevel": {
                "id": 1,
                "name": "High",
                "intValue": 4,
                "displayName": "High"
            },
            "emailLists": [
                {
                    "id": 1,
                    "name": "List",
                    "emailAddresses": [
                        "asdf@domain.com"
                    ]
                }
            ],
            "emailAddresses": [
                "test@domain.com",
                "test2@domain.com"
            ],
            "organizations": [
                {
                    "id": 1,
                    "name": "Team"
                },
                {
                    "id": 2,
                    "name": "Extra"
                }
            ],
            "scheduledDate": "at 06:00",
            "cronTranslation": "at 06:00"
        }
    ]
}


Page Tree
rootEmail Reporting API