GET /qrm/simulation_groups

Retrieves a of list the simulation groups.

Retrieves a list of the simulation groups.

Table 1. GET /qrm/simulation_groups resource details
MIME Type
application/json

Table 2. GET /qrm/simulation_groups request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3. GET /qrm/simulation_groups response codes
HTTP Response Code	Unique Code	Description
200		The simulation groups were retrieved.
500	1020	An error occurred during the attempt to retrieve the simulation groups.

Response Description

List of the Group objects. A Group object contains the following fields:

id - Long - The ID of the group.
parent_id - Long - The ID of the parent group (default resources can have localized names).
type - String - The type of the group.
level - Long - The depth of the group in the group hierarchy.
name - String - The name of the group (default groups can have localized names).
description - String - The description of the group (default groups can have localized names).
owner - String - The owner of the group.
modified_time - Long - The time in milliseconds since epoch since the group was last modified.
child_group_ids - Array of Longs - List of the child group IDs.

Response Sample


[
    {
        "child_groups": [
            42
        ],
        "child_items": [
            "String"
        ],
        "description": "String",
        "id": 42,
        "level": 42,
        "modified_time": 42,
        "name": "String",
        "owner": "String",
        "parent_id": 42,
        "type": "String <one of: LOG_SOURCE_GROUP, REPORT_GROUP, RULE_GROUP, EVENT_SAVED_SEARCH_GROUP, FLOW_SAVED_SEARCH_GROUP, OFFENSE_SAVED_SEARCH_GROUP, QRM_SAVED_SEARCH_GROUP, MODEL_SAVED_SEARCH_GROUP, QUESTION_SAVED_SEARCH_GROUP, SIMULATION_SAVED_SEARCH_GROUP, TOPOLOGY_SAVED_SEARCH_GROUP, ASSET_SAVED_SEARCH_GROUP, VULNERABILITY_SAVED_SEARCH_GROUP>"
    }
]