Versions Compared

Key

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

/rest/{version}/history/teams/{orgIdteamId}/history/objects?


Descriptor

Value

HTTP Method

POST

Description

Returns list of history events for a particular team

Required Permission

Read Access

Version Introduced2.8.3


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

Request POST Data Parameters

ParameterValueRequiredDescription
pageNumericNoSpecific page of history list to be viewed
numberToShowNumericNo*

Number of team history events to be displayed

* If not specified, the default limit is 20

Sample Call:

Code Block
themeEclipse
curl -H 'Accept: application/json' -H 'Authorization: APIKEY {apiKey}' http://localhost:8083/threadfix/rest/latest/history/teams/{orgId}1/history/objects?numberToShow=25&page=1

Sample Output:


Code Block
themeEclipse
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "retrievedHistory": true,
        "totalEventHistoryCount": 12,
        "eventHistory": [
            {
                "date": 1598001823000,
                "eventAction": "APPLICATION_SCAN_UPLOADED",
                "applicationId": 2,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": 19,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "Steve Perry (LDAP - Journey LDAP) performed an action: Upload Application Scan",
                "userName": "Steve Perry (LDAP - Journey LDAP)",
                "eventActionDisplayName": "Upload Application Scan",
                "teamDescriptionWithUrls": {
                    "string": "Steve Perry (LDAP - Journey LDAP) uploaded a Scan to Application <a href='{URL_0}'>Latte</a>. <span class='detail'>IBM Security AppScan Standard Scan dated June 13, 2011 9:44:47 AM with 44 Vulnerabilities. The scan was uploaded from appscan-php-demo.xml.Pending Scan: 19</span>",
                    "{URL_0}": "/organizations/3/applications/2",
                    "urlCount": 1
                }
            },
            {
                "date": 1598001801000,
                "eventAction": "APPLICATION_SCAN_NEEDS_PROCESSING",
                "applicationId": 2,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "Steve Perry (LDAP - Journey LDAP) performed an action: Uploaded Application Scan Needs Processing",
                "userName": "Steve Perry (LDAP - Journey LDAP)",
                "eventActionDisplayName": "Uploaded Application Scan Needs Processing",
                "teamDescriptionWithUrls": {
                    "string": "Steve Perry (LDAP - Journey LDAP) uploaded a scan to be processed  for Application <a href='{URL_0}'>Latte</a>. <span class='detail'>Pending Scan: 19</span>",
                    "{URL_0}": "/organizations/3/applications/2",
                    "urlCount": 1
                }
            },
            {
                "date": 1597998468000,
                "eventAction": "APPLICATION_SCAN_UPLOADED",
                "applicationId": 4,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": 13,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Upload Application Scan",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Upload Application Scan",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a Scan to Application <a href='{URL_0}'>Caffeine Free</a>. <span class='detail'>Fortify SCA Scan dated August 21, 2014 7:25:39 PM with 102 Vulnerabilities. The scan was uploaded from contoso.fpr.Pending Scan: 13</span>",
                    "{URL_0}": "/organizations/3/applications/4",
                    "urlCount": 1
                }
            },
            {
                "date": 1597998466000,
                "eventAction": "APPLICATION_SCAN_UPLOADED",
                "applicationId": 3,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": 12,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Upload Application Scan",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Upload Application Scan",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a Scan to Application <a href='{URL_0}'>AuLait</a>. <span class='detail'>Checkmarx Scan dated May 14, 2015 4:33:00 AM with 267 Vulnerabilities. The scan was uploaded from Threadfix-web-community-7.1.3.4.xml.Pending Scan: 12</span>",
                    "{URL_0}": "/organizations/3/applications/3",
                    "urlCount": 1
                }
            },
            {
                "date": 1597998461000,
                "eventAction": "APPLICATION_SCAN_NEEDS_PROCESSING",
                "applicationId": 4,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Uploaded Application Scan Needs Processing",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Uploaded Application Scan Needs Processing",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a scan to be processed  for Application <a href='{URL_0}'>Caffeine Free</a>. <span class='detail'>Pending Scan: 13</span>",
                    "{URL_0}": "/organizations/3/applications/4",
                    "urlCount": 1
                }
            },
            {
                "date": 1597998442000,
                "eventAction": "APPLICATION_SCAN_NEEDS_PROCESSING",
                "applicationId": 3,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Uploaded Application Scan Needs Processing",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Uploaded Application Scan Needs Processing",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a scan to be processed  for Application <a href='{URL_0}'>AuLait</a>. <span class='detail'>Pending Scan: 12</span>",
                    "{URL_0}": "/organizations/3/applications/3",
                    "urlCount": 1
                }
            },
            {
                "date": 1597998032000,
                "eventAction": "APPLICATION_SCAN_UPLOADED",
                "applicationId": 1,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": 11,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Upload Application Scan",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Upload Application Scan",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a Scan to Application <a href='{URL_0}'>Mocha</a>. <span class='detail'>IBM Security AppScan Source Scan dated May 17, 2015 11:01:51 PM with 43563 Vulnerabilities. The scan was uploaded from WebGoat_Benchmark_LargeScan.ozasmt.Pending Scan: 11</span>",
                    "{URL_0}": "/organizations/3/applications/1",
                    "urlCount": 1
                }
            },
            {
                "date": 1597997677000,
                "eventAction": "APPLICATION_SCAN_NEEDS_PROCESSING",
                "applicationId": 1,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Uploaded Application Scan Needs Processing",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Uploaded Application Scan Needs Processing",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) uploaded a scan to be processed  for Application <a href='{URL_0}'>Mocha</a>. <span class='detail'>Pending Scan: 11</span>",
                    "{URL_0}": "/organizations/3/applications/1",
                    "urlCount": 1
                }
            },
            {
                "date": 1597997120000,
                "eventAction": "APPLICATION_CREATE",
                "applicationId": 4,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Create Application",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Create Application",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) created Application <a href='{URL_0}'>Caffeine Free</a>.",
                    "{URL_0}": "/organizations/3/applications/4",
                    "urlCount": 1
                }
            },
            {
                "date": 1597997113000,
                "eventAction": "APPLICATION_CREATE",
                "applicationId": 3,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Create Application",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Create Application",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) created Application <a href='{URL_0}'>AuLait</a>.",
                    "{URL_0}": "/organizations/3/applications/3",
                    "urlCount": 1
                }
            },
            {
                "date": 1597997107000,
                "eventAction": "APPLICATION_CREATE",
                "applicationId": 2,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Create Application",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Create Application",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) created Application <a href='{URL_0}'>Latte</a>.",
                    "{URL_0}": "/organizations/3/applications/2",
                    "urlCount": 1
                }
            },
            {
                "date": 1597997100000,
                "eventAction": "APPLICATION_CREATE",
                "applicationId": 1,
                "applicationOrgId": 3,
                "organizationId": null,
                "scanId": null,
                "vulnerabilityId": null,
                "defectId": null,
                "groupCount": null,
                "description": "user (LOCAL) performed an action: Create Application",
                "userName": "user (LOCAL)",
                "eventActionDisplayName": "Create Application",
                "teamDescriptionWithUrls": {
                    "string": "user (LOCAL) created Application <a href='{URL_0}'>Mocha</a>.",
                    "{URL_0}": "/organizations/3/applications/1",
                    "urlCount": 1
                }
            }
        ]
    }
}

...