Activities

Expand to see the list of possible activities that can be returned

    AcceptedEulaActivity
    ActivatedPhaseActivity
    ActivatedReusableComponentActivity
    ActivatedStandardActivity
    ActivatedUserActivity
    AddedGroupToGroupActivity
    AddedGroupToProjectActivity
    AddedNoteActivity
    AddedProjectProblemActivity
    AddedReusableComponentToProjectActivity
    AddedTaskActivity
    AddedUserToGroupActivity
    AddedUserToProjectActivity
    ArchivedApplicationActivity
    ArchivedProjectActivity
    AssignedUserToTaskActivity
    ChangedBusinessUnitRiskPolicyActivity
    ChangedBusinessUnitRiskPolicyToDefaultActivity
    ChangedDefaultRiskPolicyActivity
    ChangedGroupRoleInProjectActivity
    ChangedProjectAnswerSurveyActivity
    ChangedProjectRiskPolicyActivity
    ChangedProjectSurveyActivity
    ChangedUserRoleInProjectActivity
    CompletedModuleActivity
    ComponentAddedTaskActivity
    ComponentMarkedImplementedTaskActivity
    ComponentMarkedIntroducedTaskActivity
    ComponentRevertedTaskActivity
    ComponentsAddedGlobalActivity
    ComponentsMarkedImplementedGlobalActivity
    ComponentsMarkedIntroducedGlobalActivity
    ComponentsRevertedGlobalActivity
    CreatedApplicationActivity
    CreatedBusinessUnitActivity
    CreatedClassifiedProjectActivity
    CreatedGroupActivity
    CreatedPhaseActivity
    CreatedProjectActivity
    CreatedProjectProblemActivity
    CreatedReportActivity
    CreatedReusableComponentActivity
    CreatedRiskPolicyActivity
    CreatedStandardActivity
    CreatedTaskActivity
    CreatedUserActivity
    DeactivatedPhaseActivity
    DeactivatedReusableComponentActivity
    DeactivatedStandardActivity
    DeactivatedUserActivity
    DeletedApplicationActivity
    DeletedBusinessUnitActivity
    DeletedGroupActivity
    DeletedNoteActivity
    DeletedPhaseActivity
    DeletedProjectActivity
    DeletedProjectProblemActivity
    DeletedReportActivity
    DeletedRiskPolicyActivity
    DeletedStandardActivity
    DeletedTaskActivity
    DisableClassificationActivity
    EnableClassificationActivity
    GeneratedAPIv1TokenActivity
    GeneratedAPIv2TokenActivity
    ImportExportActivity
    LockedProjectActivity
    LockedProjectSurveyActivity
    LoggedInActivity
    LoggedOutActivity
    MarkedTaskActivity
    ModifiedApplicationActivity
    ModifiedBusinessUnitActivity
    ModifiedClassificationActivity
    ModifiedGroupActivity
    ModifiedNoteActivity
    ModifiedPhaseActivity
    ModifiedProjectActivity
    ModifiedProjectClassificationActivity
    ModifiedProjectProblemActivity
    ModifiedReportActivity
    ModifiedReusableComponentActivity
    ModifiedReusableComponentImplementedTaskActivity
    ModifiedReusableComponentIntroducedTaskActivity
    ModifiedReusableComponentSurveyMappingActivity
    ModifiedReusableComponentTaskStatusMappingActivity
    ModifiedRiskPolicyActivity
    ModifiedStandardActivity
    ModifiedTaskActivity
    MovedApplicationActivity
    MovedProjectActivity
    ProjectAcceptedTaskUpdatesActivity
    ProjectAcceptedUpdatesAddedTaskActivity
    ProjectAcceptedUpdatesRemovedTaskActivity
    ProjectAnalysisImportActivity
    ProjectVerificationActivity
    PurgedDeletedAppsAndProjects
    PurgedDeletedBusinessUnits
    RegeneratedAPIv1TokenActivity
    RegeneratedAPIv2TokenActivity
    RemovedGroupFromGroupActivity
    RemovedGroupFromProjectActivity
    RemovedProjectProblemActivity
    RemovedReusableComponentFromProjectActivity
    RemovedReusableComponentImplementedTaskActivity
    RemovedReusableComponentIntroducedTaskActivity
    RemovedReusableComponentSurveyMappingActivity
    RemovedTaskActivity
    RemovedUserFromGroupActivity
    RemovedUserFromProjectActivity
    RevokedAPIv2TokenActivity
    SurveyAddedTaskActivity
    SurveyRemovedTaskActivity
    ToggleClassificationActivity
    ToggleClassificationModeActivity
    UnarchivedApplicationActivity
    UnarchivedProjectActivity
    UnassignedUserFromTaskActivity
    UndeletedApplicationActivity
    UndeletedBusinessUnitActivity
    UndeletedProjectActivity
    UnlockedProjectActivity
    UnlockedProjectSurveyActivity

Get all activities

This endpoint returns a list of Activities. Activities are events that have occurred in the application. We return the date they occurred along with additional data.

GET /api/v2/activities/

Note: this endpoint uses the term 'standard' to reference what we call 'library tasks' elsewhere in the API.

The 'application', 'business_unit', 'project', and 'standard' fields have associated description fields, suffixed with '_desc'. These fields contain a description of the related item, and can be used to filter if the related item has been deleted.

Query Parameters

The following parameters may be used to filter the activity resources in the response:

Parameter Description
actor Returns a list of activities performed by the user with the specified id.
application Returns a list of activities that reference the application with the specified id.
application_desc Returns a list of activities that reference the application with the specified application name.
business_unit Returns a list of activities that reference the business unit with the specified id.
business_unit_desc Returns a list of activities that reference the business unit with the specified business unit name.
date_to Returns all activities performed at or before the specified date. Note that if you would like to filter the date by UTC time, add a 'Z' to the end of the time. Otherwise, it is assumed you are filtering using local time. This is consistent with the ISO format, which we use for our dates. An example of the format can be found here: https://www.w3.org/TR/NOTE-datetime.
date_from Returns all activities performed at or after the specified date. Note that if you would like to filter the date by UTC time, add a 'Z' to the end of the time. Otherwise, it is assumed you are filtering using local time. This is consistent with the ISO format, which we use for our dates. An example of the format can be found here: https://www.w3.org/TR/NOTE-datetime.
id Returns the activities with the specified id.
name Returns a list of activities with the specified name.
project Returns a list of activities that reference the project with the specified id.
project_desc Returns a list of activities that reference the project with the specified project name.
user Returns a list of activities that reference the user with the specified user id (not to be confused with activities that are performed by this user). The id used here is a number. For example: ?user=1.
standard Returns a list of activities that reference the standard with the specified id. The format of this parameter value is the standard id prefixed by a 'T' for built-in standards or 'CT' for custom standards.
standard_desc Returns a list of activities that reference the standard with the specified standard's full name. For example: "T21: Ensure confidential data is sent over an encrypted channel".

Custom Lookups

The following parameters support additional custom lookups:

Parameter Lookups
name iexact=, contains=, icontains=, in=

For a description and example of lookup usage, see Custom Filtering Lookups.

To attach multiple query parameters, use the & operator.

Example: GET /api/v2/activities/?name__in=AddedTaskActivity,RemovedTaskActivity&standard=T5

GET /api/v2/activities/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": 5,
        "name": "CreatedGroupActivity",
        "actor": 1,
        "text": "Admin Testerton created group group A",
        "date": "2016-05-06T14:53:28.557156Z",
        "data": {
            "target_group_desc": "group A",
            "group": "G1",
            "group_desc": "group A"
        },
        "icon": "user",
        "log_level": "success"
    },
    {
        "id": 3,
        "date": "2016-03-30T17:10:20.532634+00:00",
        "actor": 7,
        "name": "ModifiedBusinessUnitActivity",
        "text": "Admin Testerton modified business unit Example BU 500",
        "data": {
            "business_unit": 5,
            "business_unit_desc": "Example BU 500"
        },
        "icon": "edit",
        "log_level": ""
    },
    {
        "id": 2,
        "date": "2016-03-30T15:16:05.659610+00:00",
        "actor": 1,
        "name": "UserCreatedActivity",
        "text": "Admin Testerton created user Cindy Lu",
        "data": {"user": "U7"},
        "icon": "user",
        "log_level": ""

    },
    {
        "id": 1,
        "date": "2016-03-30T15:14:46.634929+00:00",
        "actor": 1,
        "name": "LoggedInActivity",
        "text": "Admin Testerton logged in",
        "data": {},
        "icon": "user",
        "log_level": ""
    }]
}

Get a Specific Activity

This endpoint retrieves a specific Activity Resource as specified by the activity_id.

GET /api/v2/activities/{activity_id}/

URL Parameters

Parameter Description
activity_id The id of the Activity Resource to retrieve.
GET /api/v2/activities/2/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json

{
        "id": 2,
        "date": "2016-03-30T15:16:05.659610+00:00",
        "actor": 1,
        "name": "UserCreatedActivity",
        "text": "Admin Testerton created user Cindy Lu",
        "data": {"user": "U7"},
        "icon": "user",
        "log_level": ""

}

results matching ""

    No results matching ""